mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2025-06-13 10:33:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleanup: stick to standards when using dollar-sign in md

Browse Source 
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>
This commit is contained in:
Prasanna Kumar Kalever
2020-11-11 12:52:54 +05:30
committed by mergify[bot]
parent fcaa332921
commit 2945f7b669
10 changed files with 159 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/static-pvc.md
View File

@ -34,7 +34,7 @@ Lets create a new rbd image in ceph cluster which we are going to use for
static PVC
```console
[$]rbd create static-image --size=1024 --pool=replicapool
rbd create static-image --size=1024 --pool=replicapool
```
### Create RBD static PV
@ -90,7 +90,7 @@ static RBD PV
delete attempt in csi-provisioner.
```bash
[$] kubectl create -f fs-static-pv.yaml
$ kubectl create -f fs-static-pv.yaml
persistentvolume/fs-static-pv created
```
@ -118,7 +118,7 @@ spec:
```
```bash
[$] kubectl create -f fs-static-pvc.yaml
$ kubectl create -f fs-static-pvc.yaml
persistentvolumeclaim/fs-static-pvc created
```
@ -141,11 +141,11 @@ the subvolumegroup. **myfs** is the filesystem name(volume name) inside
which subvolume should be created.
```console
[$]ceph fs subvolumegroup create myfs testGroup
ceph fs subvolumegroup create myfs testGroup
```
```console
[$]ceph fs subvolume create myfs testSubVolume testGroup --size=1073741824
ceph fs subvolume create myfs testSubVolume testGroup --size=1073741824
```
**Note:** volume here refers to the filesystem.
@ -156,7 +156,7 @@ To create the CephFS PV you need to know the `volume rootpath`, and `clusterID`,
here is the command to get the root path in ceph cluster
```bash
[$]ceph fs subvolume getpath myfs testSubVolume testGroup
$ ceph fs subvolume getpath myfs testSubVolume testGroup
/volumes/testGroup/testSubVolume
```
@ -213,7 +213,7 @@ static CephFS PV
delete attempt in csi-provisioner.
```bash
[$] kubectl create -f cephfs-static-pv.yaml
$ kubectl create -f cephfs-static-pv.yaml
persistentvolume/cephfs-static-pv created
```
@ -239,7 +239,7 @@ spec:
```
```bash
[$] kubectl create -f cephfs-static-pvc.yaml
$ kubectl create -f cephfs-static-pvc.yaml
persistentvolumeclaim/cephfs-static-pvc created
```