You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/create-cluster-profile-variables.md
+38-17Lines changed: 38 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,16 @@ guide to learn how to create a cluster profile.
52
52
53
53
6. Optionally, enter a variable **Description**.
54
54
55
-
7. Select the data format for the variable. The following table describes available data formats.
55
+
7. Select the **Input type** of the variable. You can choose between **Text** and **Dropdown**. The default input type
56
+
is **Text**.
57
+
58
+
:::info
59
+
60
+
The dropdown input type is currently not supported in [Local UI](../../../../clusters/edge/local-ui/local-ui.md).
61
+
62
+
:::
63
+
64
+
8. Select the data format for the variable. The following table describes available data formats.
| Custom input validation | Validate the cluster profile variable definition against a regular expression based on the [regexp](https://pkg.go.dev/regexp) engine. |
72
-
| Required | Require a value for the cluster profile variable. |
73
-
| Default value | Set a default value for the cluster profile variable. |
74
-
| Mask value | Mask the cluster profile variable with asterisks in the layer YAML configuration. When you export a profile with masked variables, they will be masked in the exported profile. Upon import, you will be required to provide the masked values. |
75
-
| Hidden | Hide the cluster profile variable during cluster deployment. If the variable is both hidden and required, it must have a default value set. |
76
-
| Read-only | Prevent the cluster profile variable from being edited during cluster deployment. Read-only variables must have a default value set. |
|**Custom input validation**| Validate the cluster profile variable definition against a regular expression based on the [regexp](https://pkg.go.dev/regexp) engine. |
92
+
|**Required**| Require a value for the cluster profile variable. |
93
+
|**Default value**| Set a default value for the cluster profile variable. If the **Input type** is **Dropdown**, a default value must be specified using one of the configured dropdown options.|
94
+
|**Mask value**| Mask the cluster profile variable with asterisks in the layer YAML configuration. When you export a profile with masked variables, they will be masked in the exported profile. Upon import, you will be required to provide the masked values. |
95
+
|**Hidden**| Hide the cluster profile variable during cluster deployment. If the variable is both hidden and required, it must have a default value set. |
96
+
|**Read-only**| Prevent the cluster profile variable from being edited during cluster deployment. Read-only variables must have a default value set. |
77
97
78
-
9. As you make changes in the **Create variable** pane, the **Preview** field is updated, mirroring how the field will
98
+
11. As you make changes in the **Create variable** pane, the **Preview** field is updated, mirroring how the field will
79
99
look and behave when deploying and updating clusters. When you are satisfied, **Create** the variable.
80
100
81
101
82
102
83
-
10. Navigate to the YAML configuration of the profile layer to which you want to add the variable. In the upper-right
103
+
12. Navigate to the YAML configuration of the profile layer to which you want to add the variable. In the upper-right
84
104
corner of its YAML configuration editor, select **Variables**.
85
105
86
-
11. Next to the variable you want to add, select the **Copy to clipboard** icon to copy its name.
106
+
13. Next to the variable you want to add, select the **Copy to clipboard** icon to copy its name.
87
107
88
-
12. Paste the variable in the `parameter: '{{.spectro.var.variable_name}}'` format. You _must_ wrap each profile
108
+
14. Paste the variable in the `parameter: '{{.spectro.var.variable_name}}'` format. You _must_ wrap each profile
89
109
variable in single quotes (`'`) to properly validate the schema. Select **Confirm Updates** when finished.
90
110
91
111
Alternatively, you can start typing `{{.spectro.var.}}` in the YAML configuration editor, and Palette will list the
@@ -111,7 +131,7 @@ guide to learn how to create a cluster profile.
111
131
112
132
:::
113
133
114
-
13. Repeat the steps described in this guide to define more variables and add them to the necessary cluster profile
134
+
15. Repeat the steps described in this guide to define more variables and add them to the necessary cluster profile
115
135
layers. Remember to choose **Confirm Updates** when you are finished with each layer, and select **Save Changes**
116
136
when you are finished modifying your profile.
117
137
@@ -145,8 +165,9 @@ the infrastructure provider; however, when cluster profile variables are configu
145
165
always be an additional **Profile Config** window displayed prior to deploying the cluster. To learn more about
Note that in the below example, we entered `amazing-hello-universe-namespace` for the namespace of the Hello Universe
149
-
application.
168
+
Note that in the below example, `amazing-hello-universe-namespace` is the namespace of the Hello Universe application.
169
+
The `Calico: Network CIDR` and `Kubecost: Frontend ImagePullPolicy` variables have the dropdown input type. You can
170
+
select any configured dropdown option for the cluster.
150
171
151
172
Copy file name to clipboardExpand all lines: docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/define-profile-variables.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,8 @@ The following table describes the differences between profile variables and macr
47
47
Palette SaaS, but their values can be edited in [Local UI](../../../../clusters/edge/local-ui/local-ui.md) prior to
48
48
deploying a cluster.
49
49
50
+
- The dropdown input type is not supported in Local UI.
51
+
50
52
## Next Steps
51
53
52
54
Refer to the [Create Cluster Profile Variables](./create-cluster-profile-variables.md) guide to learn how to begin using
Copy file name to clipboardExpand all lines: docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables/modify-cluster-profile-variables.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,19 +141,20 @@ the appropriate workflow based on the changes you make to your cluster.
141
141
action.
142
142
143
143
7.**Review & Save** your changes. The **Changes Summary** dialog appears. Select **Review changes in Editor**.
144
+
144
145
8. Use the **Profile variable changes** tab to view the profiles that were changed. Expand each profile to compare the
145
146
**Running configuration** and **New configuration**, making any necessary changes to your cluster profile variables.
146
147
If you are overwriting the default value, you can revert to the original value by selecting **Use Default**. Updated
147
148
profile variable values must match the schema defined in the cluster profile variable.
148
149
149
150
Each profile must have a **Reviewed** status, indicated by a green check mark, before you can apply your changes.
150
151
Hovering over each icon between **Running configuration** and **New configuration** explains what is being done for
151
-
each variable. In the below example, we made the following changes:
152
+
each variable. The below example includes the following changes:
152
153
153
154
- Changed the Kubecost frontend `imagePullPolicy` from `Always` to `IfNotPresent`.
154
155
155
156
- Changed the default value of the Hello Universe `namespace` variable. The value assigned for profile version 1.1.0
156
-
is the same as the value for version 1.0.0 and is not overwritten unless we select **Use new default**.
157
+
is the same as the value for version 1.0.0 and is not overwritten unless you select **Use new default**.
157
158
158
159
- Added a new profile variable for Grafana.
159
160
@@ -198,7 +199,7 @@ the appropriate workflow based on the changes you make to your cluster.
198
199
199
200
6. Modify the values of your profile variables. The updated value must match the schema defined in the cluster profile
200
201
variable. If you are overwriting the default value, you can revert to the original value by selecting **Use
201
-
Default**. In the example below, we changed the Kubecost frontend `imagePullPolicy` from `Always` to `IfNotPresent`.
202
+
Default**. In the example below, the Kubecost frontend `imagePullPolicy` changed from `Always` to `IfNotPresent`.
202
203
203
204
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments