diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index 9faf7e98213..6ec07fe1906 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -231,6 +231,7 @@ spec: kubernetesVersion: v1.26.7+k3s1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: {} etcd: snapshotRetention: 5 @@ -307,10 +308,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by K3s. +For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components). + Example: ```yaml diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index 34c63378cbe..5dddf5eba8b 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -280,6 +280,7 @@ spec: kubernetesVersion: v1.25.12+rke2r1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: rke2-calico: {} etcd: @@ -337,10 +338,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by RKE2. +For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm). + Example: ```yaml diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index 9faf7e98213..6ec07fe1906 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -231,6 +231,7 @@ spec: kubernetesVersion: v1.26.7+k3s1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: {} etcd: snapshotRetention: 5 @@ -307,10 +308,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by K3s. +For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components). + Example: ```yaml diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index 34c63378cbe..5dddf5eba8b 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -280,6 +280,7 @@ spec: kubernetesVersion: v1.25.12+rke2r1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: rke2-calico: {} etcd: @@ -337,10 +338,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by RKE2. +For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm). + Example: ```yaml diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index a776a3c23bd..9d321b9d3cc 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -231,6 +231,7 @@ spec: kubernetesVersion: v1.26.7+k3s1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: {} etcd: snapshotRetention: 5 @@ -307,10 +308,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by K3s. +For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components). + Example: ```yaml diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index 9e4604f28de..07035bb6227 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -280,6 +280,7 @@ spec: kubernetesVersion: v1.25.12+rke2r1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: rke2-calico: {} etcd: @@ -337,10 +338,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by RKE2. +For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm). + Example: ```yaml