From 546950fbafb35fc827e89ae41b374d44062b327b Mon Sep 17 00:00:00 2001 From: Micah Nagel Date: Mon, 23 Sep 2024 10:43:35 -0600 Subject: [PATCH] docs: update install commands for CRDs + snapshotter Updates commands for better readability, adding code syntax and denoting how to use remote kustomization. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f79903734..8a46a9d3b 100644 --- a/README.md +++ b/README.md @@ -71,20 +71,20 @@ If your Kubernetes distribution does not bundle the snapshot controller, you may 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). Install Snapshot and Volume Group Snapshot CRDs: -* kubectl kustomize client/config/crd | kubectl create -f - -* https://github.com/kubernetes-csi/external-snapshotter/tree/master/client/config/crd +* With the repo cloned locally: `kubectl kustomize client/config/crd | kubectl create -f -` +* From the repo remotely: `kubectl kustomize https://github.com/kubernetes-csi/external-snapshotter/client/config/crd | kubectl create -f -` * Do this once per cluster Install Common Snapshot Controller: * Update the namespace to an appropriate value for your environment (e.g. kube-system) -* kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - +* `kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f -` * Do this once per cluster Install CSI Driver: * Follow instructions provided by your CSI Driver vendor. * Here is an example to install the sample hostpath CSI driver - * kubectl kustomize deploy/kubernetes/csi-snapshotter | kubectl create -f - - * https://github.com/kubernetes-csi/external-snapshotter/tree/master/deploy/kubernetes/csi-snapshotter + * With the repo cloned locally: `kubectl kustomize deploy/kubernetes/csi-snapshotter | kubectl create -f -` + * From the repo remotely: `kubectl kustomize https://github.com/kubernetes-csi/external-snapshotter/deploy/kubernetes/csi-snapshotter | kubectl create -f -` ### Validating Webhook