Developer guide #106
Open
Developer guide #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nkkashyap
reviewed
Apr 12, 2021
| | `default` | Optional. The default value for the parameter. If the does not specify the parameter in their configuration, this value entered as `default` is used. | No | Empty String| | ||
| | `type` | Specify the parameter type. Valid parameter types are: `text`, `csv`, `number`, `boolean` | No | `text`| | ||
| | `catagory` | Specify the parameter category `config` or `secret`. On UI , the `config` parameters will display in `User Config Parameter` section and `secret` parameters will dislay in `User secrete paramater` section | No | `config`| | ||
| | `required` | Specify `true` or `false`. | No | `false`| |
There was a problem hiding this comment.
I think it will be better to mention that when the default value for parameter is set, then set required to false.
There was a problem hiding this comment.
I disagree with this. In the UI, if they have a default value they can still delete it. If they delete it and its "supposed" to be required but follows this pattern, they could have an issue without realizing.
nkkashyap
reviewed
Apr 12, 2021
STORAGE_CLASS_README.md
Outdated
| allowVolumeExpansion: {{ VolumeExpansion }} #false | ||
| ``` | ||
|
|
||
| We DO NOT use `MustachTemplate` engine to translate the storage class template to actual storage class configuration. Rather, we just replace ` {{ varaibale-name }}` with its value given by the user. The multiple storage classes can be created from the same storage-class-template. The user is allowed to pass the array of storage class parameters to create multiple storage classes. |
There was a problem hiding this comment.
Also mention for storage-class template triple mustach {{{ ... }}} is invalid notation for parameter replacement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.