Enable CSI Snapshot Support on a Cluster

Enable CSI Snapshot Support for Programmatic Creation of Longhorn Backups


It is the responsibility of the Kubernetes distribution to deploy the snapshot controller as well as the related custom resource definitions.

For more information, see CSI Volume Snapshots.

If your Kubernetes Distribution Does Not Bundle the Snapshot Controller

You may manually install these components by executing the following steps.

Note that the snapshot controller YAML files mentioned below deploy into the default namespace.


Please install the same release version of snapshot CRDs and snapshot controller to ensure that the CRD version is compatible with the snapshot controller.

For general use, update the snapshot controller YAMLs with an appropriate namespace prior to installing.

For example, on a vanilla Kubernetes cluster, update the namespace from default to kube-system prior to issuing the kubectl create command.

Install the Snapshot CRDs:

  1. Download the files from https://github.com/kubernetes-csi/external-snapshotter/tree/release-4.0/client/config/crd
  2. Run kubectl create -f client/config/crd.
  3. Do this once per cluster.

Install the Common Snapshot Controller:

  1. Download the files from https://github.com/kubernetes-csi/external-snapshotter/tree/release-4.0/deploy/kubernetes/snapshot-controller
  2. Update the namespace to an appropriate value for your environment (e.g. kube-system)
  3. Run kubectl create -f deploy/kubernetes/snapshot-controller.
  4. Do this once per cluster.

See the Usage section from the kubernetes external-snapshotter git repo for additional information.

Add a Default VolumeSnapshotClass

Ensure the availability of the Snapshot Beta CRDs. Afterwards create a default VolumeSnapshotClass.

kind: VolumeSnapshotClass
apiVersion: snapshot.storage.k8s.io/v1beta1
  name: longhorn
driver: driver.longhorn.io
deletionPolicy: Delete

© 2019-2024 Longhorn Authors | Documentation Distributed under CC-BY-4.0

© 2024 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.