Skip to content

Developer guide#106

Open
prgavali wants to merge 4 commits into
developfrom
prgavali-guide
Open

Developer guide#106
prgavali wants to merge 4 commits into
developfrom
prgavali-guide

Conversation

@prgavali
Copy link
Copy Markdown
Collaborator

@prgavali prgavali commented Apr 8, 2021

No description provided.

Comment thread README.md
| `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`|
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it will be better to mention that when the default value for parameter is set, then set required to false.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants