public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-27 13:38:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1528 from btat/questions-yml-ref

Browse Source 
(re)document questions.yaml config values
This commit is contained in:
Billy Tat
2024-10-25 14:22:02 -07:00
committed by GitHub
parent cc2957a99f 1c0e3badac
commit e72dd4faf8
3 changed files with 15 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps.md
+5 -8
View File
@@ -109,22 +109,19 @@ This reference contains variables that you can use in `questions.yml` nested und
| label | string | true | Define the UI label. | | label | string | true | Define the UI label. |
| description | string | false | Specify the description of the variable.| | description | string | false | Specify the description of the variable.|
| type | string | false | Default to `string` if not specified (current supported types are string, multiline, boolean, int, enum, password, storageclass, hostname, pvc, secret and cloudcredential).| | type | string | false | Default to `string` if not specified (current supported types are string, multiline, boolean, int, enum, password, storageclass, hostname, pvc, secret and cloudcredential).|
| required | bool | false | Define if the variable is required or not (true \| false)|
| default | string | false | Specify the default value. Only used if there is no corresponding value in the `values.yml` file. | | default | string | false | Specify the default value. Only used if there is no corresponding value in the `values.yml` file. |
| group | string | false | Group questions by input value. | | group | string | false | Group questions by input value. |
| options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br/> - "ClusterIP" <br/> - "NodePort" <br/> - "LoadBalancer"|
| subquestions | []subquestion | false| Add an array of subquestions.|
| show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
<!-- The following values are not yet supported and are pending a merge of https://github.com/rancher/dashboard/issues/5754
| min_length | int | false | Min character length.| | min_length | int | false | Min character length.|
| max_length | int | false | Max character length.| | max_length | int | false | Max character length.|
| min | int | false | Min integer value. | | min | int | false | Min integer value. |
| max | int | false | Max integer value. | | max | int | false | Max integer value. |
| options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br/> - "ClusterIP" <br/> - "NodePort" <br/> - "LoadBalancer"|
| valid_chars | string | false | Regular expression for input chars validation. | | valid_chars | string | false | Regular expression for input chars validation. |
| invalid_chars | string | false | Regular expression for invalid input chars validation.| | invalid_chars | string | false | Regular expression for invalid input chars validation.|
| required | bool | false | Define if the variable is required or not (true \| false)| | subquestions | []subquestion | false| Add an array of subquestions.|
--> | show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
:::note :::note
versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps.md
+5 -8
View File
@@ -109,22 +109,19 @@ This reference contains variables that you can use in `questions.yml` nested und
| label | string | true | Define the UI label. | | label | string | true | Define the UI label. |
| description | string | false | Specify the description of the variable.| | description | string | false | Specify the description of the variable.|
| type | string | false | Default to `string` if not specified (current supported types are string, multiline, boolean, int, enum, password, storageclass, hostname, pvc, secret and cloudcredential).| | type | string | false | Default to `string` if not specified (current supported types are string, multiline, boolean, int, enum, password, storageclass, hostname, pvc, secret and cloudcredential).|
| required | bool | false | Define if the variable is required or not (true \| false)|
| default | string | false | Specify the default value. Only used if there is no corresponding value in the `values.yml` file. | | default | string | false | Specify the default value. Only used if there is no corresponding value in the `values.yml` file. |
| group | string | false | Group questions by input value. | | group | string | false | Group questions by input value. |
| options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br/> - "ClusterIP" <br/> - "NodePort" <br/> - "LoadBalancer"|
| subquestions | []subquestion | false| Add an array of subquestions.|
| show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
<!-- The following values are not yet supported and are pending a merge of https://github.com/rancher/dashboard/issues/5754
| min_length | int | false | Min character length.| | min_length | int | false | Min character length.|
| max_length | int | false | Max character length.| | max_length | int | false | Max character length.|
| min | int | false | Min integer value. | | min | int | false | Min integer value. |
| max | int | false | Max integer value. | | max | int | false | Max integer value. |
| valid_chars | string | false | Regular expression for input chars validation. | | valid_chars | string | false | Regular expression for input chars validation. |
| invalid_chars | string | false | Regular expression for invalid input chars validation.| | invalid_chars | string | false | Regular expression for invalid input chars validation.|
| required | bool | false | Define if the variable is required or not (true \| false)| | options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br/> - "ClusterIP" <br/> - "NodePort" <br/> - "LoadBalancer"|
--> | subquestions | []subquestion | false| Add an array of subquestions.|
| show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
:::note :::note
versioned_docs/version-2.9/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps.md
+5 -8
View File
@@ -109,22 +109,19 @@ This reference contains variables that you can use in `questions.yml` nested und
| label | string | true | Define the UI label. | | label | string | true | Define the UI label. |
| description | string | false | Specify the description of the variable.| | description | string | false | Specify the description of the variable.|
| type | string | false | Default to `string` if not specified (current supported types are string, multiline, boolean, int, enum, password, storageclass, hostname, pvc, secret and cloudcredential).| | type | string | false | Default to `string` if not specified (current supported types are string, multiline, boolean, int, enum, password, storageclass, hostname, pvc, secret and cloudcredential).|
| required | bool | false | Define if the variable is required or not (true \| false)|
| default | string | false | Specify the default value. Only used if there is no corresponding value in the `values.yml` file. | | default | string | false | Specify the default value. Only used if there is no corresponding value in the `values.yml` file. |
| group | string | false | Group questions by input value. | | group | string | false | Group questions by input value. |
| options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br/> - "ClusterIP" <br/> - "NodePort" <br/> - "LoadBalancer"|
| subquestions | []subquestion | false| Add an array of subquestions.|
| show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
<!-- The following values are not yet supported and are pending a merge of https://github.com/rancher/dashboard/issues/5754
| min_length | int | false | Min character length.| | min_length | int | false | Min character length.|
| max_length | int | false | Max character length.| | max_length | int | false | Max character length.|
| min | int | false | Min integer value. | | min | int | false | Min integer value. |
| max | int | false | Max integer value. | | max | int | false | Max integer value. |
| options | []string | false | Specify the options when the variable type is `enum`, for example: options:<br/> - "ClusterIP" <br/> - "NodePort" <br/> - "LoadBalancer"|
| valid_chars | string | false | Regular expression for input chars validation. | | valid_chars | string | false | Regular expression for input chars validation. |
| invalid_chars | string | false | Regular expression for invalid input chars validation.| | invalid_chars | string | false | Regular expression for invalid input chars validation.|
| required | bool | false | Define if the variable is required or not (true \| false)| | subquestions | []subquestion | false| Add an array of subquestions.|
--> | show_if | string | false | Show current variable if conditional variable is true. For example `show_if: "serviceType=Nodeport"` |
| show\_subquestion_if | string | false | Show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "true"`|
:::note :::note