Snapshotter operator (shturval-snapshotter)

About the service

ParameterDescription
GUI namesnapshotter operator
System name (identifier)shturval-snapshotter
Cluster AssignmentCreate and manage VolumeSnapshots of CSI volumes for volume backup and cloning.
CriticalYes
Public repositoryCSI external-snapshotter
Dependenciesshturval-snapshotter-crds
Namespacesnapshotter

Purpose

shturval-snapshotter is a snapshotter operator based on CSI Snapshotter. Provides support for VolumeSnapshot and VolumeSnapshotClass in a cluster for compatible CSI drivers (Ceph, vSphere, NFS, etc.).

Deployment and management

shturval-snapshotter is a critical platform service. In the Shturval platform, its inclusion and life cycle in the cluster is ensured by cluster-manager (platform service); ShturvalServiceConfig (SSC) objects for linked charts are created and maintained as part of the platform configuration.

In the working environment, the module is represented by two SSCs:

  • shturval-snapshotter-crds — CRD chart (VolumeSnapshot, VolumeSnapshotClass, VolumeSnapshotContent, etc.);
  • shturval-snapshotter — operator’s main chart.

Note: The order of deployment at the platform level must take into account the dependency: first the CRD (shturval-snapshotter-crds), then the operator (shturval-snapshotter).

Recommendation: Do not edit ShturvalServiceConfig manually to change release parameters - use ShturvalServicePatch (SSP). If components were disabled during platform deployment, the corresponding SSCs could receive mode: absent; To enable, first change the shturval-snapshotter-crds mode to auto, then shturval-snapshotter.

Creating and using volume snapshots is described on the Snapshots page. To open the release parameters in the GUI, see Where to configure.

Supported CSI drivers

Snapshots are supported by the following CSI platform drivers:

The shturval-capov-csi (oVirt) and shturval-capvcd-csi (vCloud Director) modules do not support snapshots.

Operator CRD

To manage snapshots, the operator uses the following Custom Resource Definition:

CRDDescription
VolumeSnapshotClassSets attributes for creating snapshots. The main parameter is the CSI driver used.
VolumeSnapshotContentContains the actual snapshot contents associated with the VolumeSnapshot object.
VolumeSnapshotDescribes a PVC snapshot in Kubernetes - a request to create a snapshot of a specific volume.

Where to configure

Services and Repositories → Installed Services → find Snapshotter Operator (shturval-snapshotter) → Manage. Create VolumeSnapshot and VolumeSnapshotClass objects under Administration → Custom Resources or via manifests. Step-by-step instructions: Snapshots. See also StorageClasses for volumes that support snapshots.