From ba534ce28587d3c3572c9c88622204dcd30819c0 Mon Sep 17 00:00:00 2001 From: Travis Nielsen Date: Tue, 17 Nov 2020 15:45:33 -0700 Subject: [PATCH] docs: clarify helm warning that could delete cluster In the helm chart the CRDs are installed if crds.enabled is set to true. If false, the helm chart will not install them. If changed to false during an upgrade, the CRDs will be removed and the cluster is destroyed. There is no way to prevent this while still being flexible about CRD management, so we make the warnings as clear as possible. Signed-off-by: Travis Nielsen --- Documentation/helm-operator.md | 126 +++++++++++++-------------- cluster/charts/rook-ceph/values.yaml | 2 +- 2 files changed, 64 insertions(+), 64 deletions(-) diff --git a/Documentation/helm-operator.md b/Documentation/helm-operator.md index f63fe96b0..439017727 100644 --- a/Documentation/helm-operator.md +++ b/Documentation/helm-operator.md @@ -75,69 +75,69 @@ The command removes all the Kubernetes components associated with the chart and The following tables lists the configurable parameters of the rook-operator chart and their default values. -| Parameter | Description | Default | -| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| `image.repository` | Image | `rook/ceph` | -| `image.tag` | Image tag | `master` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `crds.enabled` | If true, the helm chart will create the Rook CRDs. Should not change during upgrades or the cluster could be destroyed. | `true` | -| `rbacEnable` | If true, create & use RBAC resources | `true` | -| `pspEnable` | If true, create & use PSP resources | `true` | -| `resources` | Pod resource requests & limits | `{}` | -| `annotations` | Pod annotations | `{}` | -| `logLevel` | Global log level | `INFO` | -| `nodeSelector` | Kubernetes `nodeSelector` to add to the Deployment. | | -| `tolerations` | List of Kubernetes `tolerations` to add to the Deployment. | `[]` | -| `unreachableNodeTolerationSeconds` | Delay to use for the node.kubernetes.io/unreachable pod failure toleration to override the Kubernetes default of 5 minutes | `5s` | -| `currentNamespaceOnly` | Whether the operator should watch cluster CRD in its own namespace or not | `false` | -| `hostpathRequiresPrivileged` | Runs Ceph Pods as privileged to be able to write to `hostPath`s in OpenShift with SELinux restrictions. | `false` | -| `discover.priorityClassName` | The priority class name to add to the discover pods | | -| `discover.toleration` | Toleration for the discover pods | | -| `discover.tolerationKey` | The specific key of the taint to tolerate | | -| `discover.tolerations` | Array of tolerations in YAML format which will be added to discover deployment | | -| `discover.nodeAffinity` | The node labels for affinity of `discover-agent` (***) | | -| `discover.podLabels` | Labels to add to the discover pods. | | -| `csi.enableRbdDriver` | Enable Ceph CSI RBD driver. | `true` | -| `csi.enableCephfsDriver` | Enable Ceph CSI CephFS driver. | `true` | -| `csi.pluginPriorityClassName` | PriorityClassName to be set on csi driver plugin pods. | | -| `csi.provisionerPriorityClassName` | PriorityClassName to be set on csi driver provisioner pods. | | -| `csi.logLevel` | Set logging level for csi containers. Supported values from 0 to 5. 0 for general useful logs, 5 for trace level verbosity. | `0` | -| `csi.enableGrpcMetrics` | Enable Ceph CSI GRPC Metrics. | `true` | -| `csi.provisionerTolerations` | Array of tolerations in YAML format which will be added to CSI provisioner deployment. | | -| `csi.provisionerNodeAffinity` | The node labels for affinity of the CSI provisioner deployment (***) | | -| `csi.pluginTolerations` | Array of tolerations in YAML format which will be added to Ceph CSI plugin DaemonSet | | -| `csi.pluginNodeAffinity` | The node labels for affinity of the Ceph CSI plugin DaemonSet (***) | | -| `csi.csiRBDProvisionerResource` | CEPH CSI RBD provisioner resource requirement list. | | -| `csi.csiRBDPluginResource` | CEPH CSI RBD plugin resource requirement list. | | -| `csi.csiCephFSProvisionerResource` | CEPH CSI CephFS provisioner resource requirement list. | | -| `csi.csiCephFSPluginResource` | CEPH CSI CephFS plugin resource requirement list. | | -| `csi.cephfsGrpcMetricsPort` | CSI CephFS driver GRPC metrics port. | `9091` | -| `csi.cephfsLivenessMetricsPort` | CSI CephFS driver metrics port. | `9081` | -| `csi.rbdGrpcMetricsPort` | Ceph CSI RBD driver GRPC metrics port. | `9090` | -| `csi.rbdLivenessMetricsPort` | Ceph CSI RBD driver metrics port. | `8080` | -| `csi.forceCephFSKernelClient` | Enable Ceph Kernel clients on kernel < 4.17 which support quotas for Cephfs. | `true` | -| `csi.kubeletDirPath` | Kubelet root directory path (if the Kubelet uses a different path for the `--root-dir` flag) | `/var/lib/kubelet` | -| `csi.cephcsi.image` | Ceph CSI image. | `quay.io/cephcsi/cephcsi:v3.1.1` | -| `csi.rbdPluginUpdateStrategy` | CSI Rbd plugin daemonset update strategy, supported values are OnDelete and RollingUpdate. | `OnDelete` | -| `csi.cephFSPluginUpdateStrategy` | CSI CephFS plugin daemonset update strategy, supported values are OnDelete and RollingUpdate. | `OnDelete` | -| `csi.registrar.image` | Kubernetes CSI registrar image. | `k8s.gcr.io/sig-storage/csi-node-driver-registrar:v2.0.1` | -| `csi.resizer.image` | Kubernetes CSI resizer image. | `k8s.gcr.io/sig-storage/csi-resizer:v1.0.0` | -| `csi.provisioner.image` | Kubernetes CSI provisioner image. | `k8s.gcr.io/sig-storage/csi-provisioner:v2.0.0` | -| `csi.snapshotter.image` | Kubernetes CSI snapshotter image. | `k8s.gcr.io/sig-storage/csi-snapshotter:v3.0.0` | -| `csi.attacher.image` | Kubernetes CSI Attacher image. | `k8s.gcr.io/sig-storage/csi-attacher:v3.0.0` | -| `csi.cephfsPodLabels` | Labels to add to the CSI CephFS Pods. | | -| `csi.rbdPodLabels` | Labels to add to the CSI RBD Pods. | | -| `agent.flexVolumeDirPath` | Path where the Rook agent discovers the flex volume plugins (*) | `/usr/libexec/kubernetes/kubelet-plugins/volume/exec/` | -| `agent.libModulesDirPath` | Path where the Rook agent should look for kernel modules (*) | `/lib/modules` | -| `agent.mounts` | Additional paths to be mounted in the agent container (**) | | -| `agent.mountSecurityMode` | Mount Security Mode for the agent. | `Any` | -| `agent.priorityClassName` | The priority class name to add to the agent pods | | -| `agent.toleration` | Toleration for the agent pods | | -| `agent.tolerationKey` | The specific key of the taint to tolerate | | -| `agent.tolerations` | Array of tolerations in YAML format which will be added to agent deployment | | -| `agent.nodeAffinity` | The node labels for affinity of `rook-agent` (***) | | -| `admissionController.tolerations` | Array of tolerations in YAML format which will be added to admission controller deployment. | | -| `admissionController.nodeAffinity` | The node labels for affinity of the admission controller deployment (***) | | +| Parameter | Description | Default | +| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------- | +| `image.repository` | Image | `rook/ceph` | +| `image.tag` | Image tag | `master` | +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | +| `crds.enabled` | If true, the helm chart will create the Rook CRDs. **WARNING** Do NOT change during upgrades or the cluster will be destroyed. | `true` | +| `rbacEnable` | If true, create & use RBAC resources | `true` | +| `pspEnable` | If true, create & use PSP resources | `true` | +| `resources` | Pod resource requests & limits | `{}` | +| `annotations` | Pod annotations | `{}` | +| `logLevel` | Global log level | `INFO` | +| `nodeSelector` | Kubernetes `nodeSelector` to add to the Deployment. | | +| `tolerations` | List of Kubernetes `tolerations` to add to the Deployment. | `[]` | +| `unreachableNodeTolerationSeconds` | Delay to use for the node.kubernetes.io/unreachable pod failure toleration to override the Kubernetes default of 5 minutes | `5s` | +| `currentNamespaceOnly` | Whether the operator should watch cluster CRD in its own namespace or not | `false` | +| `hostpathRequiresPrivileged` | Runs Ceph Pods as privileged to be able to write to `hostPath`s in OpenShift with SELinux restrictions. | `false` | +| `discover.priorityClassName` | The priority class name to add to the discover pods | | +| `discover.toleration` | Toleration for the discover pods | | +| `discover.tolerationKey` | The specific key of the taint to tolerate | | +| `discover.tolerations` | Array of tolerations in YAML format which will be added to discover deployment | | +| `discover.nodeAffinity` | The node labels for affinity of `discover-agent` (***) | | +| `discover.podLabels` | Labels to add to the discover pods. | | +| `csi.enableRbdDriver` | Enable Ceph CSI RBD driver. | `true` | +| `csi.enableCephfsDriver` | Enable Ceph CSI CephFS driver. | `true` | +| `csi.pluginPriorityClassName` | PriorityClassName to be set on csi driver plugin pods. | | +| `csi.provisionerPriorityClassName` | PriorityClassName to be set on csi driver provisioner pods. | | +| `csi.logLevel` | Set logging level for csi containers. Supported values from 0 to 5. 0 for general useful logs, 5 for trace level verbosity. | `0` | +| `csi.enableGrpcMetrics` | Enable Ceph CSI GRPC Metrics. | `true` | +| `csi.provisionerTolerations` | Array of tolerations in YAML format which will be added to CSI provisioner deployment. | | +| `csi.provisionerNodeAffinity` | The node labels for affinity of the CSI provisioner deployment (***) | | +| `csi.pluginTolerations` | Array of tolerations in YAML format which will be added to Ceph CSI plugin DaemonSet | | +| `csi.pluginNodeAffinity` | The node labels for affinity of the Ceph CSI plugin DaemonSet (***) | | +| `csi.csiRBDProvisionerResource` | CEPH CSI RBD provisioner resource requirement list. | | +| `csi.csiRBDPluginResource` | CEPH CSI RBD plugin resource requirement list. | | +| `csi.csiCephFSProvisionerResource` | CEPH CSI CephFS provisioner resource requirement list. | | +| `csi.csiCephFSPluginResource` | CEPH CSI CephFS plugin resource requirement list. | | +| `csi.cephfsGrpcMetricsPort` | CSI CephFS driver GRPC metrics port. | `9091` | +| `csi.cephfsLivenessMetricsPort` | CSI CephFS driver metrics port. | `9081` | +| `csi.rbdGrpcMetricsPort` | Ceph CSI RBD driver GRPC metrics port. | `9090` | +| `csi.rbdLivenessMetricsPort` | Ceph CSI RBD driver metrics port. | `8080` | +| `csi.forceCephFSKernelClient` | Enable Ceph Kernel clients on kernel < 4.17 which support quotas for Cephfs. | `true` | +| `csi.kubeletDirPath` | Kubelet root directory path (if the Kubelet uses a different path for the `--root-dir` flag) | `/var/lib/kubelet` | +| `csi.cephcsi.image` | Ceph CSI image. | `quay.io/cephcsi/cephcsi:v3.1.1` | +| `csi.rbdPluginUpdateStrategy` | CSI Rbd plugin daemonset update strategy, supported values are OnDelete and RollingUpdate. | `OnDelete` | +| `csi.cephFSPluginUpdateStrategy` | CSI CephFS plugin daemonset update strategy, supported values are OnDelete and RollingUpdate. | `OnDelete` | +| `csi.registrar.image` | Kubernetes CSI registrar image. | `k8s.gcr.io/sig-storage/csi-node-driver-registrar:v2.0.1` | +| `csi.resizer.image` | Kubernetes CSI resizer image. | `k8s.gcr.io/sig-storage/csi-resizer:v1.0.0` | +| `csi.provisioner.image` | Kubernetes CSI provisioner image. | `k8s.gcr.io/sig-storage/csi-provisioner:v2.0.0` | +| `csi.snapshotter.image` | Kubernetes CSI snapshotter image. | `k8s.gcr.io/sig-storage/csi-snapshotter:v3.0.0` | +| `csi.attacher.image` | Kubernetes CSI Attacher image. | `k8s.gcr.io/sig-storage/csi-attacher:v3.0.0` | +| `csi.cephfsPodLabels` | Labels to add to the CSI CephFS Pods. | | +| `csi.rbdPodLabels` | Labels to add to the CSI RBD Pods. | | +| `agent.flexVolumeDirPath` | Path where the Rook agent discovers the flex volume plugins (*) | `/usr/libexec/kubernetes/kubelet-plugins/volume/exec/` | +| `agent.libModulesDirPath` | Path where the Rook agent should look for kernel modules (*) | `/lib/modules` | +| `agent.mounts` | Additional paths to be mounted in the agent container (**) | | +| `agent.mountSecurityMode` | Mount Security Mode for the agent. | `Any` | +| `agent.priorityClassName` | The priority class name to add to the agent pods | | +| `agent.toleration` | Toleration for the agent pods | | +| `agent.tolerationKey` | The specific key of the taint to tolerate | | +| `agent.tolerations` | Array of tolerations in YAML format which will be added to agent deployment | | +| `agent.nodeAffinity` | The node labels for affinity of `rook-agent` (***) | | +| `admissionController.tolerations` | Array of tolerations in YAML format which will be added to admission controller deployment. | | +| `admissionController.nodeAffinity` | The node labels for affinity of the admission controller deployment (***) | | * For information on what to set `agent.flexVolumeDirPath` to, please refer to the [Rook flexvolume documentation](flexvolume.md) diff --git a/cluster/charts/rook-ceph/values.yaml b/cluster/charts/rook-ceph/values.yaml index c68c285c9..5fea16e86 100644 --- a/cluster/charts/rook-ceph/values.yaml +++ b/cluster/charts/rook-ceph/values.yaml @@ -11,7 +11,7 @@ image: crds: # Whether the helm chart should create and update the CRDs. If false, the CRDs must be # managed independently with cluster/examples/kubernetes/ceph/crds.yaml. - # IMPORTANT: Only set during first deployment. If later disabled the cluster could be destroyed. + # **WARNING** Only set during first deployment. If later disabled the cluster will be destroyed. enabled: true resources: