mirror of
https://github.com/ceph/ceph-csi.git
synced 2025-06-13 02:33:34 +00:00
cleanup: fix mispell words
fixed mispell words in the repo. Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
This commit is contained in:
Madhu Rajanna
committed by
Madhu Rajanna
Madhu Rajanna
parent
eee49a6e0a
commit
39b1f2b4d3
@ -17,7 +17,7 @@
|
||||
Refer [external-snapshotter](https://github.com/kubernetes-csi/external-snapshotter/)
|
||||
for more information on these sidecar controllers. There should
|
||||
be a `volumesnapshotclass` object present in the cluster
|
||||
for snapshot request to be satisified.
|
||||
for snapshot request to be satisfied.
|
||||
|
||||
- To install snapshot controller and CRD
|
||||
|
||||
|
||||
@ -77,7 +77,7 @@ import (
|
||||
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.
|
||||
command and its output.
|
||||
|
||||
scenario 1: when command doesn't follow output
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ snapshot, Restore RBD snapshot and Create new RBD image from existing RBD image.
|
||||
## Create a snapshot from PVC
|
||||
|
||||
Refer [snapshot](https://kubernetes.io/docs/concepts/storage/volume-snapshots/)
|
||||
for more information realted to Volume cloning in kubernetes.
|
||||
for more information related to Volume cloning in kubernetes.
|
||||
|
||||
### steps to create a snapshot
|
||||
|
||||
@ -44,7 +44,7 @@ for more information realted to Volume cloning in kubernetes.
|
||||
rbd snap ls <RBD image for src k8s volume> --all
|
||||
|
||||
// If the parent has more snapshots than the configured `maxsnapshotsonimage`
|
||||
// add backgound tasks to flatten the temporary cloned images (temporary cloned
|
||||
// add background tasks to flatten the temporary cloned images (temporary cloned
|
||||
// image names will be same as snapshot names)
|
||||
ceph rbd task add flatten <RBD image for temporary snap images>
|
||||
|
||||
@ -125,7 +125,7 @@ image(this will be applicable for both normal image and cloned image)
|
||||
|
||||
Refer
|
||||
[volume-cloning](https://kubernetes.io/docs/concepts/storage/volume-pvc-datasource/)
|
||||
for more information realted to Volume cloning in kubernetes.
|
||||
for more information related to Volume cloning in kubernetes.
|
||||
|
||||
### steps to create a Volume from Volume
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ it is **highly** encouraged to:
|
||||
to set it to `1` as we need to build with go-ceph bindings.
|
||||
* `GO111MODULE` is enabled by default, if `GO111MODULE` is set to `off` we need
|
||||
to set it to `on` as cephcsi uses go modules for dependency.
|
||||
* Ceph-CSI uses the native Ceph libaries through the [go-ceph
|
||||
* Ceph-CSI uses the native Ceph libraries through the [go-ceph
|
||||
package](https://github.com/ceph/go-ceph). It is required to install the
|
||||
Ceph C headers in order to compile Ceph-CSI. The packages are called
|
||||
`libcephfs-devel`, `librados-devel` and `librbd-devel` on many Linux
|
||||
@ -97,7 +97,7 @@ make containerized-test TARGET=static-check
|
||||
```
|
||||
|
||||
In addition to running tests locally, each Pull Request that is created will
|
||||
trigger Continous Integration tests that include the `containerized-test`, but
|
||||
trigger Continuous Integration tests that include the `containerized-test`, but
|
||||
also additional functionality tests that are defined under the `e2e/`
|
||||
directory.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
- [Create CephFS subvolume](#create-cephfs-subvolume)
|
||||
- [Create CephFS static PV](#create-cephfs-static-pv)
|
||||
- [Node stage secret ref in CephFS PV](#node-stage-secret-ref-in-cephfs-pv)
|
||||
- [CephFS Volume Attributes in PV](#cephfs-volume-attributes-in-pv)
|
||||
- [CephFS volume attributes in PV](#cephfs-volume-attributes-in-pv)
|
||||
- [Create CephFS static PVC](#create-cephfs-static-pvc)
|
||||
|
||||
This document outlines how to create static PV and static PVC from
|
||||
@ -78,12 +78,12 @@ spec:
|
||||
Below table explains the list of volume attributes can be set when creating a
|
||||
static RBD PV
|
||||
|
||||
| Attributes | Description | Required |
|
||||
| :----------: | :----------------------------------------------------------------------------------------------------------------------------------------: | :------: |
|
||||
| Attributes | Description | Required |
|
||||
| :----------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
|
||||
| clusterID | The clusterID is used by the CSI plugin to uniquely identify and use a Ceph cluster (this is the key in configmap created duing ceph-csi deployment) | Yes |
|
||||
| pool | The pool name in which rbd image is created | Yes |
|
||||
| staticVolume | Value must be set to `true` to mount and unmount static rbd PVC | yes |
|
||||
| mounter | If set to `rbd-nbd`, use `rbd-nbd` on nodes that have `rbd-nbd` and `nbd` kernel modules to map rbd images | No |
|
||||
| pool | The pool name in which rbd image is created | Yes |
|
||||
| staticVolume | Value must be set to `true` to mount and unmount static rbd PVC | yes |
|
||||
| mounter | If set to `rbd-nbd`, use `rbd-nbd` on nodes that have `rbd-nbd` and `nbd` kernel modules to map rbd images | No |
|
||||
|
||||
**Note** ceph-csi does not supports rbd image deletion for static PV.
|
||||
`persistentVolumeReclaimPolicy` in PV spec must be set to `Retain` to avoid PV
|
||||
@ -122,7 +122,7 @@ $ kubectl create -f fs-static-pvc.yaml
|
||||
persistentvolumeclaim/fs-static-pvc created
|
||||
```
|
||||
|
||||
**Note** deleting PV and PVC doesnot deleted the backend rbd image, user need to
|
||||
**Note** deleting PV and PVC does not removed the backend rbd image, user need to
|
||||
manually delete the rbd image if required
|
||||
|
||||
## CephFS static PVC
|
||||
@ -201,12 +201,12 @@ Format for the secret should be same as detailed [here](https://github.com/ceph/
|
||||
Below table explains the list of volume attributes can be set when creating a
|
||||
static CephFS PV
|
||||
|
||||
| Attributes | Description | Required |
|
||||
| :----------: | :----------------------------------------------------------------------------------------------------------------------------------------: | :------: |
|
||||
| Attributes | Description | Required |
|
||||
| :----------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
|
||||
| clusterID | The clusterID is used by the CSI plugin to uniquely identify and use a Ceph cluster (this is the key in configmap created duing ceph-csi deployment) | Yes |
|
||||
| fsName | CephFS filesystem name into which the subvolume should be created/present | Yes |
|
||||
| staticVolume | Value must be set to `true` to mount and unmount static rbd PVC | Yes |
|
||||
| rootPath | Actual path of the subvolume in ceph cluster, can be retrieved by issuing getpath command as described above | Yes |
|
||||
| fsName | CephFS filesystem name into which the subvolume should be created/present | Yes |
|
||||
| staticVolume | Value must be set to `true` to mount and unmount static rbd PVC | Yes |
|
||||
| rootPath | Actual path of the subvolume in ceph cluster, can be retrieved by issuing getpath command as described above | Yes |
|
||||
|
||||
**Note** ceph-csi does not supports CephFS subvolume deletion for static PV.
|
||||
`persistentVolumeReclaimPolicy` in PV spec must be set to `Retain` to avoid PV
|
||||
|
||||
Reference in New Issue
Block a user