From ce6eb371307973122f120ec3fbfbe7a91cc5af60 Mon Sep 17 00:00:00 2001 From: Jiaqi Luo <6218999+jiaqiluo@users.noreply.github.com> Date: Fri, 12 Jan 2024 15:30:18 -0700 Subject: [PATCH] address comments --- .../k3s-cluster-configuration.md | 8 ++++---- .../rke2-cluster-configuration.md | 8 ++++---- .../k3s-cluster-configuration.md | 8 ++++---- .../rke2-cluster-configuration.md | 8 ++++---- .../k3s-cluster-configuration.md | 8 ++++---- .../rke2-cluster-configuration.md | 8 ++++---- 6 files changed, 24 insertions(+), 24 deletions(-) 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 fb8870595b0..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 @@ -310,7 +310,8 @@ spec: ### additionalManifest -Specify the addition manifest(s) to be delivered to the control plane nodes. +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: @@ -326,10 +327,9 @@ additionalManifest: |- :::note -It is discouraged to provide HelmChartConfig for customizing the system charts via `additionalManifest`, -it could cause unexpected behavior due to how multiple HelmChartConfig for the same chart being handled. +If you want to customize system charts, you should use the `chartValues` field as described below. -The recommended approach is to utilize the `chartValues` field which is explained 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. ::: 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 2fcced5eceb..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 @@ -340,7 +340,8 @@ spec: ### additionalManifest -Specify the addition manifest(s) to be delivered to the control plane nodes. +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: @@ -356,10 +357,9 @@ additionalManifest: |- :::note -It is discouraged to provide HelmChartConfig for customizing the system charts via `additionalManifest`, -it could cause unexpected behavior due to how multiple HelmChartConfig for the same chart being handled. +If you want to customize system charts, you should use the `chartValues` field as described below. -The recommended approach is to utilize the `chartValues` field which is explained 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. ::: 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 9a5ebfa5669..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 @@ -310,7 +310,8 @@ spec: ### additionalManifest -Specify the addition manifest(s) to be delivered to the control plane nodes. +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: @@ -326,10 +327,9 @@ additionalManifest: |- :::note -It is discouraged to provide HelmChartConfig for customizing the system charts via `additionalManifest`, -it could cause unexpected behavior due to how multiple HelmChartConfig for the same chart being handled. +If you want to customize system charts, you should use the `chartValues` field as described below. -The recommended approach is to utilize the `chartValues` field which is explained 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. ::: 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 2fcced5eceb..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 @@ -340,7 +340,8 @@ spec: ### additionalManifest -Specify the addition manifest(s) to be delivered to the control plane nodes. +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: @@ -356,10 +357,9 @@ additionalManifest: |- :::note -It is discouraged to provide HelmChartConfig for customizing the system charts via `additionalManifest`, -it could cause unexpected behavior due to how multiple HelmChartConfig for the same chart being handled. +If you want to customize system charts, you should use the `chartValues` field as described below. -The recommended approach is to utilize the `chartValues` field which is explained 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. ::: 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 d5d35125e75..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 @@ -310,7 +310,8 @@ spec: ### additionalManifest -Specify the addition manifest(s) to be delivered to the control plane nodes. +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: @@ -326,10 +327,9 @@ additionalManifest: |- :::note -It is discouraged to provide HelmChartConfig for customizing the system charts via `additionalManifest`, -it could cause unexpected behavior due to how multiple HelmChartConfig for the same chart being handled. +If you want to customize system charts, you should use the `chartValues` field as described below. -The recommended approach is to utilize the `chartValues` field which is explained 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. ::: 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 5a23c76a57a..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 @@ -340,7 +340,8 @@ spec: ### additionalManifest -Specify the addition manifest(s) to be delivered to the control plane nodes. +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: @@ -356,10 +357,9 @@ additionalManifest: |- :::note -It is discouraged to provide HelmChartConfig for customizing the system charts via `additionalManifest`, -it could cause unexpected behavior due to how multiple HelmChartConfig for the same chart being handled. +If you want to customize system charts, you should use the `chartValues` field as described below. -The recommended approach is to utilize the `chartValues` field which is explained 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. :::