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/reference/embedded-config.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ spec:
63
63
digest: ""
64
64
unsupportedOverrides:
65
65
k0s: |
66
-
Config:
66
+
config:
67
67
spec:
68
68
api:
69
69
extraArgs:
@@ -141,7 +141,7 @@ If you need to install Helm charts before your application and as part of the Em
141
141
142
142
Helm extensions are updated when new versions of your application are deployed from the Admin Console. So, for example, you can change the values for a Helm extension from one release to another, and those changes will be applied to the cluster when the new release is deployed.
143
143
144
-
The format for specifying Helm extensions uses the same k0s Helm extensions format from the k0s Configuration. For more information about these fields, see the [k0s documentation](https://docs.k0sproject.io/stable/helm-charts/#example).
144
+
The format for specifying Helm extensions uses the same k0s Helm extensions format from the k0s configuration. For more information about these fields, see the [k0s documentation](https://docs.k0sproject.io/stable/helm-charts/#example).
145
145
146
146
### Limitation
147
147
@@ -191,18 +191,18 @@ spec:
191
191
## unsupportedOverrides
192
192
193
193
:::important
194
-
This feature should be used with caution by advanced users who understand the risks and ramifications of changing the default Configuration.
194
+
This feature should be used with caution by advanced users who understand the risks and ramifications of changing the default configuration.
195
195
:::
196
196
197
-
Unsupported overrides allow you to override Embedded Cluster's default Configuration, including the k0s Config and the Helm values for extensions like KOTS and OpenEBS. This should be used with caution because changes here are untested and can disrupt or break Embedded Clusters. Any issues that are caused by unsupported overrides are not supported.
197
+
Unsupported overrides allow you to override Embedded Cluster's default configuration, including the k0s config and the Helm values for extensions like KOTS and OpenEBS. This should be used with caution because changes here are untested and can disrupt or break Embedded Clusters. Any issues that are caused by unsupported overrides are not supported.
198
198
199
199
While they should be used with caution, unsupported overrides are useful if you need to make changes that are not otherwise exposed by Embedded Cluster.
200
200
201
201
### Override the k0s Config
202
202
203
-
By default, Embedded Cluster uses a k0s Config that is tested and known to work for Embedded Clusters. In some circumstances, you might want to change the k0s Config.
203
+
By default, Embedded Cluster uses a k0s config that is tested and known to work for Embedded Clusters. In some circumstances, you might want to change the k0s config.
204
204
205
-
For more information on the k0s Config, see [Configuration options](https://docs.k0sproject.io/stable/Configuration/#Configuration-file-reference) in the k0s documentation.
205
+
For more information on the k0s config, see [Configuration options](https://docs.k0sproject.io/stable/configuration/#configuration-file-reference) in the k0s documentation.
206
206
207
207
A common use case today is to adjust the default service port range to allow node ports on lower port numbers, as shown in the example below:
208
208
@@ -212,7 +212,7 @@ kind: Config
212
212
spec:
213
213
unsupportedOverrides:
214
214
k0s: |
215
-
Config:
215
+
config:
216
216
spec:
217
217
api:
218
218
extraArgs:
@@ -223,7 +223,7 @@ spec:
223
223
224
224
* The `spec.api` and `spec.storage` keys in the k0s config cannot be changed after installation. Whereas most keys in the k0s config apply to the whole cluster, these two keys are set for each node. Embedded Cluster cannot update these keys on each individual node during updates, so they cannot be changed after installation.
225
225
226
-
* Overrides overwrite the corresponding fields in the k0s Configuration. They are not merged into Embedded Cluster’s default Configuration. When using overrides to override a list, for example, ensure that you include other elements in the list that Embedded Cluster includes by default.
226
+
* Overrides overwrite the corresponding fields in the k0s configuration. They are not merged into Embedded Cluster’s default configuration. When using overrides to override a list, for example, ensure that you include other elements in the list that Embedded Cluster includes by default.
227
227
228
228
### Override the Helm Values for Built-In Extensions
Copy file name to clipboardExpand all lines: docs/reference/template-functions-about.mdx
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,6 @@ You can use KOTS template functions in Kubernetes manifest files for application
28
28
29
29
* KOTS template functions are not directly supported in Helm charts. For more information, see [Helm Charts](#helm-charts) below.
30
30
31
-
* KOTS template functions do not support arbitrary string templating because the manifests consumed by KOTS must be valid YAML. For more information, see [Syntax](#syntax) below.
32
-
33
31
### Helm Charts
34
32
35
33
KOTS template functions are _not_ directly supported in Helm charts. However, the HelmChart custom resource provides a way to map values rendered by KOTS template functions to Helm chart values. This allows you to use KOTS template functions with Helm charts without making changes to those Helm charts.
0 commit comments