mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-10 00:10:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
9a3170bf77
ceph-csi/charts/ceph-csi-rbd/README.md

189 lines
26 KiB
Markdown
Raw Normal View History

Add readme and notes to the chart This adds a basic readme file and notes to the helm chart Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
2019-02-07 18:50:37 +00:00
# ceph-csi-rbd
The ceph-csi-rbd chart adds rbd volume support to your cluster.
doc: update helm documentation Updated Helm documentation on how to install charts from release repo Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-05-18 08:18:46 +00:00
## Install from release repo
Add chart repository to install helm charts from it
```console
helm repo add ceph-csi https://ceph.github.io/csi-charts
```
## Install from local Chart
we need to enter into the directory where all charts are present
```console
cleanup: stick to standards when using dollar-sign in md MD014 - Dollar signs used before commands without showing output The dollar signs are unnecessary, it is easier to copy and paste and less noisy if the dollar signs are omitted. Especially when the command doesn't list the output, but if the command follows output we can use `$ ` (dollar+space) mainly to differentiate between command and its ouput. scenario 1: when command doesn't follow output ```console cd ~/work ``` scenario 2: when command follow output (use dollar+space) ```console $ ls ~/work file1 file2 dir1 dir2 ... ``` Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2020-11-11 07:22:54 +00:00
cd charts
doc: update helm documentation Updated Helm documentation on how to install charts from release repo Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-05-18 08:18:46 +00:00
```
**Note:** charts directory is present in root of the ceph-csi project
### Install chart
Add readme and notes to the chart This adds a basic readme file and notes to the helm chart Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
2019-02-07 18:50:37 +00:00
Fix formatting in helm rbd readme Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2019-02-21 04:32:39 +00:00
To install the Chart into your Kubernetes cluster
Add readme and notes to the chart This adds a basic readme file and notes to the helm chart Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
2019-02-07 18:50:37 +00:00
update the helm documentation for cephfs and rbd Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-04-13 09:58:03 +00:00
- For helm 2.x
```bash
helm install --namespace "ceph-csi-rbd" --name "ceph-csi-rbd" ceph-csi/ceph-csi-rbd
```
- For helm 3.x
Create the namespace where Helm should install the components with
```bash
kubectl create namespace "ceph-csi-rbd"
```
Run the installation
```bash
helm install --namespace "ceph-csi-rbd" "ceph-csi-rbd" ceph-csi/ceph-csi-rbd
```
Add readme and notes to the chart This adds a basic readme file and notes to the helm chart Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
2019-02-07 18:50:37 +00:00
After installation succeeds, you can get a status of Chart
```bash
helm status "ceph-csi-rbd"
```
doc: update helm documentation Updated Helm documentation on how to install charts from release repo Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-05-18 08:18:46 +00:00
### Delete Chart
update the helm documentation for cephfs and rbd Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-04-13 09:58:03 +00:00
Fix formatting in helm rbd readme Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2019-02-21 04:32:39 +00:00
If you want to delete your Chart, use this command
Add readme and notes to the chart This adds a basic readme file and notes to the helm chart Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
2019-02-07 18:50:37 +00:00
update the helm documentation for cephfs and rbd Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-04-13 09:58:03 +00:00
- For helm 2.x
```bash
helm delete --purge "ceph-csi-rbd"
```
- For helm 3.x
```bash
helm uninstall "ceph-csi-rbd" --namespace "ceph-csi-rbd"
```
update readme to delete namespace Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2019-03-13 06:23:54 +00:00
If you want to delete the namespace, use this command
```bash
kubectl delete namespace ceph-csi-rbd
```
doc: update helm chart documentations This commit updates the helm chart documentations with the configurations available while deploying these helm charts. Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-01 12:48:19 +00:00
### Configuration
The following table lists the configurable parameters of the ceph-csi-cephfs
charts and their default values.
doc: Updates the helm doc with secret and sc configuration This commit updates the helm doc with storageclass and secret configurations. Fixes: #2255 Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-08 15:23:33 +00:00
| Parameter | Description | Default |
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `rbac.create` | Specifies whether RBAC resources should be created | `true` |
| `serviceAccounts.nodeplugin.create` | Specifies whether a nodeplugin ServiceAccount should be created | `true` |
| `serviceAccounts.nodeplugin.name` | The name of the nodeplugin ServiceAccount to use. If not set and create is true, a name is generated using the fullname | "" |
| `serviceAccounts.provisioner.create` | Specifies whether a provisioner ServiceAccount should be created | `true` |
| `serviceAccounts.provisioner.name` | The name of the provisioner ServiceAccount to use. If not set and create is true, a name is generated using the fullname | "" |
| `csiConfig` | Configuration for the CSI to connect to the cluster | [] |
deploy: add template changes for mapping added template changes for the clusterID and poolID,fsID mapping details for the pod templates. Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2021-07-26 12:28:26 +00:00
| `csiMapping` | Configuration details of clusterID,PoolID,FscID mapping | [] |
doc: Updates the helm doc with secret and sc configuration This commit updates the helm doc with storageclass and secret configurations. Fixes: #2255 Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-08 15:23:33 +00:00
| `encryptionKMSConfig` | Configuration for the encryption KMS | `{}` |
| `logLevel` | Set logging level for csi containers. Supported values from 0 to 5. 0 for general useful logs, 5 for trace level verbosity. | `5` |
| `nodeplugin.name` | Specifies the nodeplugins name | `nodeplugin` |
| `nodeplugin.updateStrategy` | Specifies the update Strategy. If you are using ceph-fuse client set this value to OnDelete | `RollingUpdate` |
| `nodeplugin.priorityClassName` | Set user created priorityclassName for csi plugin pods. default is system-node-critical which is highest priority | `system-node-critical` |
| `nodeplugin.profiling.enabled` | Specifies whether profiling should be enabled | `false` |
| `nodeplugin.registrar.image.repository` | Node Registrar image repository URL | `k8s.gcr.io/sig-storage/csi-node-driver-registrar` |
| `nodeplugin.registrar.image.tag` | Image tag | `v2.2.0` |
| `nodeplugin.registrar.image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `nodeplugin.plugin.image.repository` | Nodeplugin image repository URL | `quay.io/cephcsi/cephcsi` |
| `nodeplugin.plugin.image.tag` | Image tag | `canary` |
| `nodeplugin.plugin.image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `nodeplugin.nodeSelector` | Kubernetes `nodeSelector` to add to the Daemonset | `{}` |
| `nodeplugin.tolerations` | List of Kubernetes `tolerations` to add to the Daemonset | `{}` |
| `nodeplugin.podSecurityPolicy.enabled` | If true, create & use [Pod Security Policy resources](https://kubernetes.io/docs/concepts/policy/pod-security-policy/). | `false` |
| `provisioner.name` | Specifies the name of provisioner | `provisioner` |
| `provisioner.replicaCount` | Specifies the replicaCount | `3` |
| `provisioner.defaultFSType` | Specifies the default Fstype | `ext4` |
| `provisioner.deployController` | It enables or disables the deployment of controller which generates the OMAP data if it is not present | `true` |
| `provisioner.hardMaxCloneDepth` | Hard limit for maximum number of nested volume clones that are taken before a flatten occurs | `8` |
| `provisioner.softMaxCloneDepth` | Soft limit for maximum number of nested volume clones that are taken before a flatten occurs | `4` |
| `provisioner.maxSnapshotsOnImage` | Maximum number of snapshots allowed on rbd image without flattening | `450` |
| `provisioner.minSnapshotsOnImage` | Minimum number of snapshots allowed on rbd image to trigger flattening | `250` |
| `provisioner.skipForceFlatten` | Skip image flattening if kernel support mapping of rbd images which has the deep-flatten feature | `false` |
| `provisioner.timeout` | GRPC timeout for waiting for creation or deletion of a volume | `60s` |
| `provisioner.priorityClassName` | Set user created priorityclassName for csi provisioner pods. Default is `system-cluster-critical` which is less priority than `system-node-critical` | `system-cluster-critical` |
| `provisioner.profiling.enabled` | Specifies whether profiling should be enabled | `false` |
| `provisioner.provisioner.image.repository` | Specifies the csi-provisioner image repository URL | `k8s.gcr.io/sig-storage/csi-provisioner` |
| `provisioner.provisioner.image.tag` | Specifies image tag | `v2.2.2` |
| `provisioner.provisioner.image.pullPolicy` | Specifies pull policy | `IfNotPresent` |
| `provisioner.attacher.image.repository` | Specifies the csi-attacher image repository URL | `k8s.gcr.io/sig-storage/csi-attacher` |
| `provisioner.attacher.image.tag` | Specifies image tag | `v3.2.1` |
| `provisioner.attacher.image.pullPolicy` | Specifies pull policy | `IfNotPresent` |
| `provisioner.attacher.name` | Specifies the name of csi-attacher sidecar | `attacher` |
| `provisioner.attacher.enabled` | Specifies whether attacher sidecar is enabled | `true` |
| `provisioner.resizer.image.repository` | Specifies the csi-resizer image repository URL | `k8s.gcr.io/sig-storage/csi-resizer` |
| `provisioner.resizer.image.tag` | Specifies image tag | `v1.2.0` |
| `provisioner.resizer.image.pullPolicy` | Specifies pull policy | `IfNotPresent` |
| `provisioner.resizer.name` | Specifies the name of csi-resizer sidecar | `resizer` |
| `provisioner.resizer.enabled` | Specifies whether resizer sidecar is enabled | `true` |
| `provisioner.snapshotter.image.repository` | Specifies the csi-snapshotter image repository URL | `k8s.gcr.io/sig-storage/csi-snapshotter` |
| `provisioner.snapshotter.image.tag` | Specifies image tag | `v4.1.1` |
| `provisioner.snapshotter.image.pullPolicy` | Specifies pull policy | `IfNotPresent` |
| `provisioner.nodeSelector` | Specifies the node selector for provisioner deployment | `{}` |
| `provisioner.tolerations` | Specifies the tolerations for provisioner deployment | `{}` |
| `provisioner.affinity` | Specifies the affinity for provisioner deployment | `{}` |
| `provisioner.podSecurityPolicy.enabled` | Specifies whether podSecurityPolicy is enabled | `false` |
| `topology.enabled` | Specifies whether topology based provisioning support should be exposed by CSI | `false` |
| `topology.domainLabels` | DomainLabels define which node labels to use as domains for CSI nodeplugins to advertise their domains | `{}` |
| `provisionerSocketFile` | The filename of the provisioner socket | `csi-provisioner.sock` |
| `pluginSocketFile` | The filename of the plugin socket | `csi.sock` |
| `kubeletDir` | kubelet working directory | `/var/lib/kubelet` |
deploy: fix cephLogDir passing to storageclass via helm cephLogDir: is a storage class option that is passed to rbd-nbd daemon. cephLogDirHostPath: is a nodeplugin daemonset level option that helps in using the right host-path while bind-mounting Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2021-09-01 12:24:42 +00:00
| `cephLogDirHostPath` | Host path location for ceph client processes logging, ex: rbd-nbd | `/var/log/ceph` |
doc: Updates the helm doc with secret and sc configuration This commit updates the helm doc with storageclass and secret configurations. Fixes: #2255 Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-08 15:23:33 +00:00
| `driverName` | Name of the csi-driver | `rbd.csi.ceph.com` |
| `configMapName` | Name of the configmap which contains cluster configuration | `ceph-csi-config` |
| `externallyManagedConfigmap` | Specifies the use of an externally provided configmap | `false` |
| `kmsConfigMapName` | Name of the configmap used for encryption kms configuration | `ceph-csi-encryption-kms-config` |
| `storageClass.create` | Specifies whether the StorageClass should be created | `false` |
| `storageClass.name` | Specifies the rbd StorageClass name | `csi-rbd-sc` |
helm: support adding annotations to StorageClasses Signed-off-by: Shaohui Liu <liushaohui@xiaomi.com>
2021-10-26 03:32:17 +00:00
| `storageClass.annotations` | Specifies the annotations for the rbd StorageClass | `[]` |
doc: Updates the helm doc with secret and sc configuration This commit updates the helm doc with storageclass and secret configurations. Fixes: #2255 Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-08 15:23:33 +00:00
| `storageClass.clusterID` | String representing a Ceph cluster to provision storage from | `<cluster-ID>` |
| `storageClass.dataPool` | Specifies the erasure coded pool | `""` |
| `storageClass.pool` | Ceph pool into which the RBD image shall be created | `replicapool` |
| `storageClass.thickProvision` | Specifies whether thick provision should be enabled | `false` |
| `storageclass.imageFeatures` | Specifies RBD image features | `layering` |
rbd: provide a way to disable the auto fallback to nbd mounter This change allows the user to choose not to fallback to NBD mounter when some ImageFeatures are absent with krbd driver, rather just fail the NodeStage call. Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2021-10-05 10:47:11 +00:00
| `storageclass.tryOtherMounters` | Specifies whether to try other mounters in case if the current mounter fails to mount the rbd image for any reason | `false` |
doc: Updates the helm doc with secret and sc configuration This commit updates the helm doc with storageclass and secret configurations. Fixes: #2255 Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-08 15:23:33 +00:00
| `storageClass.mounter` | Specifies RBD mounter | `""` |
deploy: fix cephLogDir passing to storageclass via helm cephLogDir: is a storage class option that is passed to rbd-nbd daemon. cephLogDirHostPath: is a nodeplugin daemonset level option that helps in using the right host-path while bind-mounting Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2021-09-01 12:24:42 +00:00
| `storageClass.cephLogDir` | ceph client log location, it is the target bindmount path used inside container | `"/var/log/ceph"` |
rbd: provide alternatives to preserve the ceph log files Currently, we delete the ceph client log file on unmap/detach. This patch provides additional alternatives for users who would like to persist the log files. Strategies: ----------- `remove`: delete log file on unmap/detach `compress`: compress the log file to gzip on unmap/detach `preserve`: preserve the log file in text format Note that the default strategy will be remove on unmap, and these options can be tweaked from the storage class Compression size details example: On Map: (with debug-rbd=20) --------- $ ls -lh -rw-r--r-- 1 root root 526K Sep 1 18:15 rbd-nbd-0001-0024-fed5480a-f00f-417a-a51d-31d8a8144c03-0000000000000003-d2e89c87-0b4d-11ec-8ea6-160f128e682d.log On unmap: --------- $ ls -lh -rw-r--r-- 1 root root 33K Sep 1 18:15 rbd-nbd-0001-0024-fed5480a-f00f-417a-a51d-31d8a8144c03-0000000000000003-d2e89c87-0b4d-11ec-8ea6-160f128e682d.gz Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
2021-09-01 11:53:43 +00:00
| `storageClass.cephLogStrategy` | ceph client log strategy, available options `remove` or `compress` or `preserve` | `"remove"` |
doc: Updates the helm doc with secret and sc configuration This commit updates the helm doc with storageclass and secret configurations. Fixes: #2255 Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-08 15:23:33 +00:00
| `storageClass.volumeNamePrefix` | Prefix to use for naming RBD images | `""` |
| `storageClass.encrypted` | Specifies whether volume should be encrypted. Set it to true if you want to enable encryption | `""` |
| `storageClass.encryptionKMSID` | Specifies the encryption kms id | `""` |
| `storageClass.topologyConstrainedPools` | Add topology constrained pools configuration, if topology based pools are setup, and topology constrained provisioning is required | `[]` |
| `storageClass.mapOptions` | Specifies comma-separated list of map options | `""` |
| `storageClass.unmapOtpions` | Specifies comma-separated list of unmap options | `""` |
| `storageClass.provisionerSecret` | The secrets have to contain user and/or Ceph admin credentials. | `csi-rbd-secret` |
| `storageClass.provisionerSecretNamespace` | Specifies the provisioner secret namespace | `""` |
| `storageClass.controllerExpandSecret` | Specifies the controller expand secret name | `csi-rbd-secret` |
| `storageClass.controllerExpandSecretNamespace` | Specifies the controller expand secret namespace | `""` |
| `storageClass.nodeStageSecret` | Specifies the node stage secret name | `csi-rbd-secret` |
| `storageClass.nodeStageSecretNamespace` | Specifies the node stage secret namespace | `""` |
| `storageClass.fstype` | Specify the filesystem type of the volume | `ext4` |
| `storageClass.reclaimPolicy` | Specifies the reclaim policy of the StorageClass | `Delete` |
| `storageClass.allowVolumeExpansion` | Specifies whether volume expansion should be allowed | `true` |
| `storageClass.mountOptions` | Specifies the mount options for storageClass | `[]` |
| `secret.create` | Specifies whether the secret should be created | `false` |
| `secret.name` | Specifies the rbd secret name | `csi-rbd-secret` |
| `secret.userID` | Specifies the user ID of the rbd secret | `<plaintext ID>` |
| `secret.userKey` | Specifies the key that corresponds to the userID | `<Ceph auth key corresponding to ID above>` |
| `secret.encryptionPassphrase` | Specifies the encryption passphrase of the secret | `test_passphrase` |
doc: update helm chart documentations This commit updates the helm chart documentations with the configurations available while deploying these helm charts. Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-07-01 12:48:19 +00:00
### Command Line
You can pass the settings with helm command line parameters.
Specify each parameter using the --set key=value argument to helm install.
For Example:
```bash
helm install --set configMapName=ceph-csi-config --set provisioner.podSecurityPolicy.enabled=true
```
Reference in New Issue Copy Permalink