mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-12-18 11:00:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #128 from humblec/readme

Browse Source 
update readme and correct linter errors.
This commit is contained in:
Huamin Chen 2019-01-17 07:20:14 -05:00 committed by GitHub
commit b9a9840ae5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 71 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -13,4 +13,3 @@ For example usage of RBD and CephFS CSI plugins, see examples in `examples/`.
## Troubleshooting ## Troubleshooting
Please submit an issue at: [Issues](https://github.com/ceph/ceph-csi/issues) Please submit an issue at: [Issues](https://github.com/ceph/ceph-csi/issues)

28
docs/deploy-cephfs.md
View File

@ -7,13 +7,15 @@ The CSI CephFS plugin is able to both provision new CephFS volumes and attach an
CSI CephFS 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 `cephfsplugin`. When compiled as an image, it's stored in the local Docker image store. CSI CephFS 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 `cephfsplugin`. When compiled as an image, it's stored in the local Docker image store.
Building binary: Building binary:
```bash ```bash
$ make cephfsplugin make cephfsplugin
``` ```
Building Docker image: Building Docker image:
```bash ```bash
$ make image-cephfsplugin make image-cephfsplugin
``` ```
## Configuration ## Configuration
@ -21,7 +23,7 @@ $ make image-cephfsplugin
**Available command line arguments:** **Available command line arguments:**
Option | Default value | Description Option | Default value | Description
------ | ------------- | ----------- --------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`--endpoint` | `unix://tmp/csi.sock` | CSI endpoint, must be a UNIX socket `--endpoint` | `unix://tmp/csi.sock` | CSI endpoint, must be a UNIX socket
`--drivername` | `csi-cephfsplugin` | name of the driver (Kubernetes: `provisioner` field in StorageClass must correspond to this value) `--drivername` | `csi-cephfsplugin` | name of the driver (Kubernetes: `provisioner` field in StorageClass must correspond to this value)
`--nodeid` | _empty_ | This node's ID `--nodeid` | _empty_ | This node's ID
@ -36,7 +38,7 @@ Option | Default value | Description
**Available volume parameters:** **Available volume parameters:**
Parameter | Required | Description Parameter | Required | Description
--------- | -------- | ----------- ---------------------------------------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`monitors` | yes | Comma separated list of Ceph monitors (e.g. `192.168.100.1:6789,192.168.100.2:6789,192.168.100.3:6789`) `monitors` | yes | Comma separated list of Ceph monitors (e.g. `192.168.100.1:6789,192.168.100.2:6789,192.168.100.3:6789`)
`mounter` | no | Mount method to be used for this volume. Available options are `kernel` for Ceph kernel client and `fuse` for Ceph FUSE driver. Defaults to "default mounter", see command line arguments. `mounter` | no | Mount method to be used for this volume. Available options are `kernel` for Ceph kernel client and `fuse` for Ceph FUSE driver. Defaults to "default mounter", see command line arguments.
`provisionVolume` | yes | Mode of operation. BOOL value. If `true`, a new CephFS volume will be provisioned. If `false`, an existing volume will be used. `provisionVolume` | yes | Mode of operation. BOOL value. If `true`, a new CephFS volume will be provisioned. If `false`, an existing volume will be used.
@ -47,11 +49,13 @@ Parameter | Required | Description
**Required secrets for `provisionVolume=true`:** **Required secrets for `provisionVolume=true`:**
Admin credentials are required for provisioning new volumes Admin credentials are required for provisioning new volumes
* `adminID`: ID of an admin client * `adminID`: ID of an admin client
* `adminKey`: key of the admin client * `adminKey`: key of the admin client
**Required secrets for `provisionVolume=false`:** **Required secrets for `provisionVolume=false`:**
User credentials with access to an existing volume User credentials with access to an existing volume
* `userID`: ID of a user client * `userID`: ID of a user client
* `userKey`: key of a user client * `userKey`: key of a user client
@ -68,9 +72,9 @@ YAML manifests are located in `deploy/cephfs/kubernetes`.
**Deploy RBACs for sidecar containers and node plugins:** **Deploy RBACs for sidecar containers and node plugins:**
```bash ```bash
$ kubectl create -f csi-attacher-rbac.yaml kubectl create -f csi-attacher-rbac.yaml
$ kubectl create -f csi-provisioner-rbac.yaml kubectl create -f csi-provisioner-rbac.yaml
$ kubectl create -f csi-nodeplugin-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. 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.
@ -78,8 +82,8 @@ Those manifests deploy service accounts, cluster roles and cluster role bindings
**Deploy CSI sidecar containers:** **Deploy CSI sidecar containers:**
```bash ```bash
$ kubectl create -f csi-cephfsplugin-attacher.yaml kubectl create -f csi-cephfsplugin-attacher.yaml
$ kubectl create -f csi-cephfsplugin-provisioner.yaml kubectl create -f csi-cephfsplugin-provisioner.yaml
``` ```
Deploys stateful sets for external-attacher and external-provisioner sidecar containers for CSI CephFS. Deploys stateful sets for external-attacher and external-provisioner sidecar containers for CSI CephFS.
@ -87,7 +91,7 @@ Deploys stateful sets for external-attacher and external-provisioner sidecar con
**Deploy CSI CephFS driver:** **Deploy CSI CephFS driver:**
```bash ```bash
$ kubectl create -f csi-cephfsplugin.yaml kubectl create -f csi-cephfsplugin.yaml
``` ```
Deploys a daemon set with two containers: CSI driver-registrar and the CSI CephFS driver. Deploys a daemon set with two containers: CSI driver-registrar and the CSI CephFS driver.
@ -95,8 +99,9 @@ Deploys a daemon set with two containers: CSI driver-registrar and the CSI CephF
## Verifying the deployment in Kubernetes ## Verifying the deployment in Kubernetes
After successfuly completing the steps above, you should see output similar to this: After successfuly completing the steps above, you should see output similar to this:
```bash ```bash
$ kubectl get all kubectl get all
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
pod/csi-cephfsplugin-attacher-0 1/1 Running 0 26s pod/csi-cephfsplugin-attacher-0 1/1 Running 0 26s
pod/csi-cephfsplugin-provisioner-0 1/1 Running 0 25s pod/csi-cephfsplugin-provisioner-0 1/1 Running 0 25s
@ -114,4 +119,3 @@ You can try deploying a demo pod from `examples/cephfs` to test the deployment f
### Notes on volume deletion ### Notes on volume deletion
Volumes that were provisioned dynamically (i.e. `provisionVolume=true`) are allowed to be deleted by the driver as well, if the user chooses to do so. Otherwise, the driver is forbidden to delete such volumes - attempting to delete them is a no-op. Volumes that were provisioned dynamically (i.e. `provisionVolume=true`) are allowed to be deleted by the driver as well, if the user chooses to do so. Otherwise, the driver is forbidden to delete such volumes - attempting to delete them is a no-op.

24
docs/deploy-rbd.md
View File

@ -7,13 +7,15 @@ The RBD CSI plugin is able to provision new RBD images and attach and mount thos
CSI RBD 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 `rbdplugin`. When compiled as an image, it's stored in the local Docker image store. CSI RBD 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 `rbdplugin`. When compiled as an image, it's stored in the local Docker image store.
Building binary: Building binary:
```bash ```bash
$ make rbdplugin make rbdplugin
``` ```
Building Docker image: Building Docker image:
```bash ```bash
$ make image-rbdplugin make image-rbdplugin
``` ```
## Configuration ## Configuration
@ -21,7 +23,7 @@ $ make image-rbdplugin
**Available command line arguments:** **Available command line arguments:**
Option | Default value | Description Option | Default value | Description
------ | ------------- | ----------- --------------------|-----------------------|---------------------------------------------------------------------------------------------------
`--endpoint` | `unix://tmp/csi.sock` | CSI endpoint, must be a UNIX socket `--endpoint` | `unix://tmp/csi.sock` | CSI endpoint, must be a UNIX socket
`--drivername` | `csi-cephfsplugin` | name of the driver (Kubernetes: `provisioner` field in StorageClass must correspond to this value) `--drivername` | `csi-cephfsplugin` | name of the driver (Kubernetes: `provisioner` field in StorageClass must correspond to this value)
`--nodeid` | _empty_ | This node's ID `--nodeid` | _empty_ | This node's ID
@ -38,7 +40,7 @@ Option | Default value | Description
**Available volume parameters:** **Available volume parameters:**
Parameter | Required | Description Parameter | Required | Description
--------- | -------- | ----------- -----------------------------------------------------------------|--------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`monitors` | one of `monitors` and `monValueFromSecret` must be set | Comma separated list of Ceph monitors (e.g. `192.168.100.1:6789,192.168.100.2:6789,192.168.100.3:6789`) `monitors` | one of `monitors` and `monValueFromSecret` must be set | Comma separated list of Ceph monitors (e.g. `192.168.100.1:6789,192.168.100.2:6789,192.168.100.3:6789`)
`monValueFromSecret` | one of `monitors` and `monValueFromSecret` must be set | a string pointing the key in the credential secret, whose value is the mon. This is used for the case when the monitors' IP or hostnames are changed, the secret can be updated to pick up the new monitors. `monValueFromSecret` | one of `monitors` and `monValueFromSecret` must be set | a string pointing the key in the credential secret, whose value is the mon. This is used for the case when the monitors' IP or hostnames are changed, the secret can be updated to pick up the new monitors.
`pool` | yes | Ceph pool into which the RBD image shall be created `pool` | yes | Ceph pool into which the RBD image shall be created
@ -65,9 +67,9 @@ YAML manifests are located in `deploy/rbd/kubernetes`.
**Deploy RBACs for sidecar containers and node plugins:** **Deploy RBACs for sidecar containers and node plugins:**
```bash ```bash
$ kubectl create -f csi-attacher-rbac.yaml kubectl create -f csi-attacher-rbac.yaml
$ kubectl create -f csi-provisioner-rbac.yaml kubectl create -f csi-provisioner-rbac.yaml
$ kubectl create -f csi-nodeplugin-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. 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.
@ -75,8 +77,8 @@ Those manifests deploy service accounts, cluster roles and cluster role bindings
**Deploy CSI sidecar containers:** **Deploy CSI sidecar containers:**
```bash ```bash
$ kubectl create -f csi-rbdplugin-attacher.yaml kubectl create -f csi-rbdplugin-attacher.yaml
$ kubectl create -f csi-rbdplugin-provisioner.yaml kubectl create -f csi-rbdplugin-provisioner.yaml
``` ```
Deploys stateful sets for external-attacher and external-provisioner sidecar containers for CSI RBD. Deploys stateful sets for external-attacher and external-provisioner sidecar containers for CSI RBD.
@ -84,7 +86,7 @@ Deploys stateful sets for external-attacher and external-provisioner sidecar con
**Deploy RBD CSI driver:** **Deploy RBD CSI driver:**
```bash ```bash
$ kubectl create -f csi-rbdplugin.yaml kubectl create -f csi-rbdplugin.yaml
``` ```
Deploys a daemon set with two containers: CSI driver-registrar and the CSI RBD driver. Deploys a daemon set with two containers: CSI driver-registrar and the CSI RBD driver.
@ -119,7 +121,7 @@ The Helm chart is located in `deploy/rbd/helm`.
**Deploy Helm Chart:** **Deploy Helm Chart:**
```bash ```bash
$ helm install ./deploy/rbd/helm helm install ./deploy/rbd/helm
``` ```
The Helm chart deploys all of the required resources to use the CSI RBD driver. The Helm chart deploys all of the required resources to use the CSI RBD driver.

23
examples/README.md
View File

@ -1,22 +1,23 @@
## How to test RBD and CephFS plugins with Kubernetes 1.11 # How to test RBD and CephFS plugins with Kubernetes 1.11
Both `rbd` and `cephfs` directories contain `plugin-deploy.sh` and `plugin-teardown.sh` helper scripts. You can use those to help you deploy/tear down RBACs, sidecar containers and the plugin in one go. By default, they look for the YAML manifests in `../../deploy/{rbd,cephfs}/kubernetes`. You can override this path by running `$ ./plugin-deploy.sh /path/to/my/manifests`. Both `rbd` and `cephfs` directories contain `plugin-deploy.sh` and `plugin-teardown.sh` helper scripts. You can use those to help you deploy/tear down RBACs, sidecar containers and the plugin in one go. By default, they look for the YAML manifests in `../../deploy/{rbd,cephfs}/kubernetes`. You can override this path by running `$ ./plugin-deploy.sh /path/to/my/manifests`.
Once the plugin is successfuly deployed, you'll need to customize `storageclass.yaml` and `secret.yaml` manifests to reflect your Ceph cluster setup. Please consult the documentation for info about available parameters. Once the plugin is successfuly deployed, you'll need to customize `storageclass.yaml` and `secret.yaml` manifests to reflect your Ceph cluster setup. Please consult the documentation for info about available parameters.
After configuring the secrets, monitors, etc. you can deploy a testing Pod mounting a RBD image / CephFS volume: After configuring the secrets, monitors, etc. you can deploy a testing Pod mounting a RBD image / CephFS volume:
```bash ```bash
$ kubectl create -f secret.yaml kubectl create -f secret.yaml
$ kubectl create -f storageclass.yaml kubectl create -f storageclass.yaml
$ kubectl create -f pvc.yaml kubectl create -f pvc.yaml
$ kubectl create -f pod.yaml kubectl create -f pod.yaml
``` ```
Other helper scripts: Other helper scripts:
* `logs.sh` output of the plugin * `logs.sh` output of the plugin
* `exec-bash.sh` logs into the plugin's container and runs bash * `exec-bash.sh` logs into the plugin's container and runs bash
## How to test RBD Snapshot feature ## How to test RBD Snapshot feature
Before continuing, make sure you enabled the required [feature gate](https://kubernetes-csi.github.io/docs/Setup.html#csi-volume-snapshot-support) in your Kubernetes cluster. Before continuing, make sure you enabled the required [feature gate](https://kubernetes-csi.github.io/docs/Setup.html#csi-volume-snapshot-support) in your Kubernetes cluster.
@ -26,14 +27,16 @@ In the `examples/rbd` directory you will find four files related to snapshots: [
Once you created your RBD volume, you'll need to customize at least `snapshotclass.yaml` and make sure the `monitors` and `pool` parameters match your Ceph cluster setup. If you followed the documentation to create the rbdplugin, you shouldn't have to edit any other file. If you didn't, make sure every parameters in `csi-snapshotter.yaml` reflect your configuration. Once you created your RBD volume, you'll need to customize at least `snapshotclass.yaml` and make sure the `monitors` and `pool` parameters match your Ceph cluster setup. If you followed the documentation to create the rbdplugin, you shouldn't have to edit any other file. If you didn't, make sure every parameters in `csi-snapshotter.yaml` reflect your configuration.
After configuring everything you needed, deploy the csi-snapshotter: After configuring everything you needed, deploy the csi-snapshotter:
```bash ```bash
$ kubectl create -f csi-snapshotter-rbac.yaml kubectl create -f csi-snapshotter-rbac.yaml
$ kubectl create -f csi-snapshotter.yaml kubectl create -f csi-snapshotter.yaml
$ kubectl create -f snapshotclass.yaml kubectl create -f snapshotclass.yaml
$ kubectl create -f snapshot.yaml kubectl create -f snapshot.yaml
``` ```
To verify if your volume snapshot has successfully been created, run the following: To verify if your volume snapshot has successfully been created, run the following:
```bash ```bash
$ kubectl get volumesnapshotclass $ kubectl get volumesnapshotclass
NAME AGE NAME AGE