Add snapshot examples in CSI-v1.0 #170
Conversation
examples/README.md
Outdated
|
|
||
| ## 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. |
There was a problem hiding this comment.
I think the doc still points to kube1.12, as only one feature gate needs to be enabled, instead of the link we can add
--feature-gates=VolumeSnapshotDataSource=true here
examples/README.md
Outdated
|
|
||
| ```bash | ||
| kubectl create -f snapshotclass.yaml | ||
| kubectl create -f snapshot.yaml |
There was a problem hiding this comment.
we need some explanation for kubectl create -f snapshot.yaml, this creates the snapshot from existing PVC.
we can do like below
kubectl create -f snapshotclass.yaml
verify snashot class
kubectl get volumesnapshotclass
NAME AGE
csi-rbdplugin-snapclass 4s
- create a snapshot from the existing PVC
kubectl create -f snapshot.yaml
- verify snapshot state
kubectl get volumesnapshot
NAME AGE
rbd-pvc-snapshot 6s
even we can discribe and show that the snapshot is in ready state
To be sure everything is OK you can run rbd snap ls [your-pvc-name] inside one of your Ceph pod.
examples/README.md
Outdated
| Verify that the snapshot class was created: | ||
|
|
||
| ```bash | ||
| kubectl get volumesnapshotclass |
rollandf
force-pushed
the
csi-v1.0
branch
2 times, most recently
from
b795b38 to
c12d32e
Compare
examples/README.md
Outdated
|
|
||
| ## How to test RBD Snapshot feature | ||
|
|
||
| Before continuing, make sure you enabled the required feature gate 'VolumeSnapshotDataSource=true' in your Kubernetes cluster. |
There was a problem hiding this comment.
'VolumeSnapshotDataSource=true' to VolumeSnapshotDataSource=true
examples/README.md
Outdated
| Create a snapshot from the existing PVC: | ||
|
|
||
| ```bash | ||
| $ kubectl create -f snapshot.yaml |
There was a problem hiding this comment.
check #174 (comment), I think we need to remove $ in case of no output
There was a problem hiding this comment.
Do we want this output?
volumesnapshotclass.snapshot.storage.k8s.io/csi-rbdplugin-snapclass created
There was a problem hiding this comment.
we have 2 options
$ kubectl create -f snapshot.yaml
volumesnapshotclass.snapshot.storage.k8s.io/csi-rbdplugin-snapclass created
or
kubectl create -f snapshot.yaml
note $ is removed in second option
There was a problem hiding this comment.
OK, I removed the $ when there is no output.
Thanks for the review
rollandf
force-pushed
the
csi-v1.0
branch
2 times, most recently
from
efac7d7 to
f5abb2d
Compare
examples/README.md
Outdated
|
|
||
| Verify that the snapshot class was created: | ||
|
|
||
| ```bash |
examples/README.md
Outdated
|
|
||
| To verify if your volume snapshot has successfully been created, run the following: | ||
|
|
||
| ```bash |
|
thank you @rollandf , some nit but looks great overall! |
Fixes issue ceph#164
|
@leseb mergify got a failure, can you take a look? thanks |
|
cc @leseb for mergify failure |
Add snapshot examples in CSI-v1.0
Fixes issue #174