Merge pull request #1063 from jiaqiluo/improve-rke2-k3s-doc

add docs for additionalManifest field for RKE2/K3s cluster
This commit is contained in:
Billy Tat
2024-01-12 16:36:06 -08:00
committed by GitHub
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 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 ### 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 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 ### 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 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 ### 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 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 ### 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 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 ### 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 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 ### 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