Skip to content

Commit 546950f

Browse files
authored
docs: update install commands for CRDs + snapshotter
Updates commands for better readability, adding code syntax and denoting how to use remote kustomization.
1 parent 5ad0cfb commit 546950f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,20 @@ If your Kubernetes distribution does not bundle the snapshot controller, you may
7171
There is a new validating webhook server which provides tightened validation on snapshot objects. The cluster admin or Kubernetes distribution admin should install the webhook alongside the snapshot controllers and CRDs. More details [below](#validating-webhook).
7272

7373
Install Snapshot and Volume Group Snapshot CRDs:
74-
* kubectl kustomize client/config/crd | kubectl create -f -
75-
* https://github.com/kubernetes-csi/external-snapshotter/tree/master/client/config/crd
74+
* With the repo cloned locally: `kubectl kustomize client/config/crd | kubectl create -f -`
75+
* From the repo remotely: `kubectl kustomize https://github.com/kubernetes-csi/external-snapshotter/client/config/crd | kubectl create -f -`
7676
* Do this once per cluster
7777

7878
Install Common Snapshot Controller:
7979
* Update the namespace to an appropriate value for your environment (e.g. kube-system)
80-
* kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f -
80+
* `kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f -`
8181
* Do this once per cluster
8282

8383
Install CSI Driver:
8484
* Follow instructions provided by your CSI Driver vendor.
8585
* Here is an example to install the sample hostpath CSI driver
86-
* kubectl kustomize deploy/kubernetes/csi-snapshotter | kubectl create -f -
87-
* https://github.com/kubernetes-csi/external-snapshotter/tree/master/deploy/kubernetes/csi-snapshotter
86+
* With the repo cloned locally: `kubectl kustomize deploy/kubernetes/csi-snapshotter | kubectl create -f -`
87+
* From the repo remotely: `kubectl kustomize https://github.com/kubernetes-csi/external-snapshotter/deploy/kubernetes/csi-snapshotter | kubectl create -f -`
8888

8989
### Validating Webhook
9090

0 commit comments

Comments
 (0)