mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-26 16:20:28 +00:00
fa68c35f3b
This commit adds support to mount and delete volumes provisioned by older plugin versions (1.0.0) in order to support backward compatibility to 1.0.0 created volumes. It adds back the ability to specify where older meta data was specified, using the metadatastorage option to the plugin. Further, using the provided meta data to mount and delete the older volumes. It also supports a variety of ways in which monitor information may have been specified (in the storage class, or in the secret), to keep the monitor information current. Testing done: - Mount/Delete 1.0.0 plugin created volume with monitors in the StorageClass - Mount/Delete 1.0.0 plugin created volume with monitors in the secret with a key "monitors" - Mount/Delete 1.0.0 plugin created volume with monitors in the secret with a user specified key - PVC creation and deletion with the current version (to ensure at the minimum no broken functionality) - Tested some negative cases, where monitor information is missing in secrets or present with a different key name, to understand if failure scenarios work as expected Updates #378 Follow-up work: - Documentation on how to upgrade to 1.1 plugin and retain above functionality for older volumes Signed-off-by: ShyamsundarR <srangana@redhat.com>
157 lines
8.9 KiB
Markdown
157 lines
8.9 KiB
Markdown
# CSI RBD Plugin
|
|
|
|
The RBD CSI plugin is able to provision new RBD images and
|
|
attach and mount those to workloads.
|
|
|
|
## Building
|
|
|
|
CSI plugin can be compiled in a form of a binary file or in a form of a
|
|
Docker image. When compiled as a binary file, the result is stored in
|
|
`_output/` directory with the name `cephcsi`. When compiled as an image, it's
|
|
stored in the local Docker image store with name `cephcsi`.
|
|
|
|
Building binary:
|
|
|
|
```bash
|
|
make cephcsi
|
|
```
|
|
|
|
Building Docker image:
|
|
|
|
```bash
|
|
make image-cephcsi
|
|
```
|
|
|
|
## Configuration
|
|
|
|
**Available command line arguments:**
|
|
|
|
| Option | Default value | Description |
|
|
| ------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `--endpoint` | `unix://tmp/csi.sock` | CSI endpoint, must be a UNIX socket |
|
|
| `--drivername` | `rbd.csi.ceph.com` | Name of the driver (Kubernetes: `provisioner` field in StorageClass must correspond to this value) |
|
|
| `--nodeid` | _empty_ | This node's ID |
|
|
| `--type` | _empty_ | Driver type `[rbd | cephfs]` If the driver type is set to `rbd` it will act as a `rbd plugin` or if it's set to `cephfs` will act as a `cephfs plugin` |
|
|
| `--containerized` | true | Whether running in containerized mode |
|
|
| `--instanceid` | "default" | Unique ID distinguishing this instance of Ceph CSI among other instances, when sharing Ceph clusters across CSI instances for provisioning |
|
|
| `--metadatastorage` | _empty_ | Points to where legacy (1.0.0 or older plugin versions) metadata about provisioned volumes are kept, as file or in as k8s configmap (`node` or `k8s_configmap` respectively) |
|
|
|
|
**Available environmental variables:**
|
|
|
|
`HOST_ROOTFS`: rbdplugin searches `/proc` directory under the directory set by `HOST_ROOTFS`.
|
|
|
|
**Available volume parameters:**
|
|
|
|
| Parameter | Required | Description |
|
|
| ----------------------------------------------------------------------------------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `clusterID` | yes | String representing a Ceph cluster, must be unique across all Ceph clusters in use for provisioning, cannot be greater than 36 bytes in length, and should remain immutable for the lifetime of the Ceph cluster in use |
|
|
| `pool` | yes | Ceph pool into which the RBD image shall be created |
|
|
| `imageFormat` | no | RBD image format. Defaults to `2`. See [man pages](http://docs.ceph.com/docs/mimic/man/8/rbd/#cmdoption-rbd-image-format) |
|
|
| `imageFeatures` | no | RBD image features. Available for `imageFormat=2`. CSI RBD currently supports only `layering` feature. See [man pages](http://docs.ceph.com/docs/mimic/man/8/rbd/#cmdoption-rbd-image-feature) |
|
|
| `csi.storage.k8s.io/provisioner-secret-name`, `csi.storage.k8s.io/node-publish-secret-name` | yes (for Kubernetes) | name of the Kubernetes Secret object containing Ceph client credentials. Both parameters should have the same value |
|
|
| `csi.storage.k8s.io/provisioner-secret-namespace`, `csi.storage.k8s.io/node-publish-secret-namespace` | yes (for Kubernetes) | namespaces of the above Secret objects |
|
|
| `mounter` | no | if set to `rbd-nbd`, use `rbd-nbd` on nodes that have `rbd-nbd` and `nbd` kernel modules to map rbd images |
|
|
|
|
**NOTE:** An accompanying CSI configuration file, needs to be provided to the
|
|
running pods. Refer to [Creating CSI configuration](../examples/README.md#creating-csi-configuration)
|
|
for more information.
|
|
|
|
**NOTE:** A suggested way to populate and retain uniqueness of the clusterID is
|
|
to use the output of `ceph fsid` of the Ceph cluster to be used for
|
|
provisioning.
|
|
|
|
**Required secrets:**
|
|
|
|
User credentials, with required access to the pool being used in the storage class,
|
|
is required for provisioning new RBD images.
|
|
|
|
## Deployment with Kubernetes
|
|
|
|
Requires Kubernetes 1.11
|
|
|
|
Your Kubernetes cluster must allow privileged pods (i.e. `--allow-privileged`
|
|
flag must be set to true for both the API server and the kubelet). Moreover, as
|
|
stated in the [mount propagation
|
|
docs](https://kubernetes.io/docs/concepts/storage/volumes/#mount-propagation),
|
|
the Docker daemon of the cluster nodes must allow shared mounts.
|
|
|
|
YAML manifests are located in `deploy/rbd/kubernetes`.
|
|
|
|
**Deploy RBACs for sidecar containers and node plugins:**
|
|
|
|
```bash
|
|
kubectl create -f csi-provisioner-rbac.yaml
|
|
kubectl create -f csi-nodeplugin-rbac.yaml
|
|
```
|
|
|
|
Those manifests deploy service accounts, cluster roles and cluster role
|
|
bindings. These are shared for both RBD and CephFS CSI plugins, as they require
|
|
the same permissions.
|
|
|
|
**Deploy ConfigMap for CSI plugins:**
|
|
|
|
```bash
|
|
kubectl create -f csi-config-map.yaml
|
|
```
|
|
|
|
The config map deploys an empty CSI configuration that is mounted as a volume
|
|
within the Ceph CSI plugin pods. To add a specific Ceph clusters configuration
|
|
details, refer to [Creating CSI configuration for RBD based
|
|
provisioning](../examples/README.md#creating-csi-configuration-for-rbd-based-provisioning)
|
|
for more information.
|
|
|
|
**Deploy CSI sidecar containers:**
|
|
|
|
```bash
|
|
kubectl create -f csi-rbdplugin-provisioner.yaml
|
|
```
|
|
|
|
Deploys stateful set of provision which includes external-provisioner
|
|
,external-attacher,csi-snapshotter sidecar containers and CSI RBD plugin.
|
|
|
|
**Deploy RBD CSI driver:**
|
|
|
|
```bash
|
|
kubectl create -f csi-rbdplugin.yaml
|
|
```
|
|
|
|
Deploys a daemon set with two containers: CSI node-driver-registrar and the CSI
|
|
RBD driver.
|
|
|
|
## Verifying the deployment in Kubernetes
|
|
|
|
After successfully completing the steps above, you should see output similar to this:
|
|
|
|
```bash
|
|
$ kubectl get all
|
|
NAME READY STATUS RESTARTS AGE
|
|
pod/csi-rbdplugin-fptqr 2/2 Running 0 21s
|
|
pod/csi-rbdplugin-provisioner-0 4/4 Running 0 22s
|
|
|
|
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
|
service/csi-rbdplugin-provisioner ClusterIP 10.104.2.130 <none> 12345/TCP 23s
|
|
...
|
|
```
|
|
|
|
Once the CSI plugin configuration is updated with details from a Ceph cluster of
|
|
choice, you can try deploying a demo pod from examples/rbd using the
|
|
instructions [provided](../examples/README.md#deploying-the-storage-class) to
|
|
test the deployment further.
|
|
|
|
## Deployment with Helm
|
|
|
|
The same requirements from the Kubernetes section apply here, i.e. Kubernetes
|
|
version, privileged flag and shared mounts.
|
|
|
|
The Helm chart is located in `deploy/rbd/helm`.
|
|
|
|
**Deploy Helm Chart:**
|
|
|
|
```bash
|
|
helm install ./deploy/rbd/helm
|
|
```
|
|
|
|
The Helm chart deploys all of the required resources to use the CSI RBD driver.
|
|
After deploying the chart you can verify the deployment using the instructions
|
|
above for verifying the deployment with Kubernetes
|