add docs for additionalManifest field for RKE2/K3s cluster

This commit is contained in:
Jiaqi Luo
2024-01-12 14:03:48 -07:00
parent 3a4b7e73c0
commit e1aa035e69
6 changed files with 168 additions and 0 deletions
@@ -231,6 +231,7 @@ spec:
kubernetesVersion: v1.26.7+k3s1 kubernetesVersion: v1.26.7+k3s1
localClusterAuthEndpoint: {} localClusterAuthEndpoint: {}
rkeConfig: rkeConfig:
additionalManifest: ""
chartValues: {} chartValues: {}
etcd: etcd:
snapshotRetention: 5 snapshotRetention: 5
@@ -307,10 +308,37 @@ spec:
``` ```
</details> </details>
### additionalManifest
Specify the addition manifest(s) to be delivered 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
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.
The recommended approach is to utilize the `chartValues` field which is explained below.
:::
### chartValues ### chartValues
Specify the values for the system charts installed by K3s. 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: Example:
```yaml ```yaml
@@ -280,6 +280,7 @@ spec:
kubernetesVersion: v1.25.12+rke2r1 kubernetesVersion: v1.25.12+rke2r1
localClusterAuthEndpoint: {} localClusterAuthEndpoint: {}
rkeConfig: rkeConfig:
additionalManifest: ""
chartValues: chartValues:
rke2-calico: {} rke2-calico: {}
etcd: etcd:
@@ -337,10 +338,37 @@ spec:
``` ```
</details> </details>
### additionalManifest
Specify the addition manifest(s) to be delivered 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
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.
The recommended approach is to utilize the `chartValues` field which is explained below.
:::
### chartValues ### chartValues
Specify the values for the system charts installed by RKE2. 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: Example:
```yaml ```yaml
@@ -231,6 +231,7 @@ spec:
kubernetesVersion: v1.26.7+k3s1 kubernetesVersion: v1.26.7+k3s1
localClusterAuthEndpoint: {} localClusterAuthEndpoint: {}
rkeConfig: rkeConfig:
additionalManifest: ""
chartValues: {} chartValues: {}
etcd: etcd:
snapshotRetention: 5 snapshotRetention: 5
@@ -307,10 +308,37 @@ spec:
``` ```
</details> </details>
### additionalManifest
Specify the addition manifest(s) to be delivered 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
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.
The recommended approach is to utilize the `chartValues` field which is explained below.
:::
### chartValues ### chartValues
Specify the values for the system charts installed by K3s. 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: Example:
```yaml ```yaml
@@ -280,6 +280,7 @@ spec:
kubernetesVersion: v1.25.12+rke2r1 kubernetesVersion: v1.25.12+rke2r1
localClusterAuthEndpoint: {} localClusterAuthEndpoint: {}
rkeConfig: rkeConfig:
additionalManifest: ""
chartValues: chartValues:
rke2-calico: {} rke2-calico: {}
etcd: etcd:
@@ -337,10 +338,37 @@ spec:
``` ```
</details> </details>
### additionalManifest
Specify the addition manifest(s) to be delivered 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
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.
The recommended approach is to utilize the `chartValues` field which is explained below.
:::
### chartValues ### chartValues
Specify the values for the system charts installed by RKE2. 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: Example:
```yaml ```yaml
@@ -231,6 +231,7 @@ spec:
kubernetesVersion: v1.26.7+k3s1 kubernetesVersion: v1.26.7+k3s1
localClusterAuthEndpoint: {} localClusterAuthEndpoint: {}
rkeConfig: rkeConfig:
additionalManifest: ""
chartValues: {} chartValues: {}
etcd: etcd:
snapshotRetention: 5 snapshotRetention: 5
@@ -307,10 +308,37 @@ spec:
``` ```
</details> </details>
### additionalManifest
Specify the addition manifest(s) to be delivered 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
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.
The recommended approach is to utilize the `chartValues` field which is explained below.
:::
### chartValues ### chartValues
Specify the values for the system charts installed by K3s. 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: Example:
```yaml ```yaml
@@ -280,6 +280,7 @@ spec:
kubernetesVersion: v1.25.12+rke2r1 kubernetesVersion: v1.25.12+rke2r1
localClusterAuthEndpoint: {} localClusterAuthEndpoint: {}
rkeConfig: rkeConfig:
additionalManifest: ""
chartValues: chartValues:
rke2-calico: {} rke2-calico: {}
etcd: etcd:
@@ -337,10 +338,37 @@ spec:
``` ```
</details> </details>
### additionalManifest
Specify the addition manifest(s) to be delivered 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
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.
The recommended approach is to utilize the `chartValues` field which is explained below.
:::
### chartValues ### chartValues
Specify the values for the system charts installed by RKE2. 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: Example:
```yaml ```yaml