docs: PAC-1967 Volume Snapshot Support (#3839)

* docs: PAC-1967 * docs: vale feedback * docs: updated content per feedback * docs: more feedback changes * docs: Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> --------- Co-authored-by: caroldelwing <[email protected]> (cherry picked from commit 361f49d)
spectrocloud · Sep 11, 2024 · d958808 · d958808
1 parent 6be5b43
commit d958808
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md b/docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md
@@ -94,6 +94,35 @@ or
 [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic)
 guide.
 
+## Volume Snapshots
+
+<!-- prettier-ignore -->
+You can include [volume snapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/) in your cluster backups if the Container Storage Interface (CSI) driver you are using supports them. For more information about volume snapshot support, check the CSI pack README for your CSI driver. You can find a list of all Packs in the <VersionedLink text="Packs List" url="/integrations/" />
+page.
+
+<!-- prettier-ignore -->
+If the CSI driver you are using includes the [csi-snapshotter](https://github.com/kubernetes-csi/external-snapshotter) component, then it supports volume snapshotting. If the CSI driver contains the snapshot controller and VolumeSnapshotClass, then all necessary components are already included in the CSI pack and nothing else is needed. If not, you must add the <VersionedLink text="Volume Snapshot Controller" url="/integrations/packs/?pack=volume-snapshot-controller" />, version 8 or greater, to your cluster profile to install the snapshot controller and VolumeSnapshotClass. These components are necessary to support taking snapshots and including them in your cluster backups. You can learn how to add a pack to a cluster profile by checking out the [Add a Pack](../../../profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-pack-addon.md) guide.
+
+You can use the table below to determine if your CSI driver supports volume snapshots and if you need to include the
+Volume Snapshot Controller pack in your cluster profile.
+
+:::tip
+
+Always refer to the CSI driver's Pack README for guidance on volume snapshot support.
+
+:::
+
+| Scenario                                                                                                                                              | Requires Volume Snapshot Controller Pack | Guidance                                                           |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------ |
+| CSI driver supports volume snapshots but does not contain all the required components, such as the Snapshot Controller, and the VolumeSnapshotClass   | Yes                                      | Include the Volume Snapshot Controller pack in the cluster profile |
+| CSI driver supports volume snapshots, contains the all required components, such as the Snapshot Controller, and has the VolumeSnapshotClass included | No                                       | Refer to the CSI Pack README for guidance                          |
+| CSI driver does not support volume snapshots                                                                                                          | No                                       | Refer to the CSI Pack README for guidance                          |
+
+### Volume Snapshots and VMO
+
+<!-- prettier-ignore -->
+Clusters deployed with the <VersionedLink text="Virtual Machine Orchestrator " url="/integrations/packs/?pack=virtual-machine-orchestrator" /> pack do not need the  <VersionedLink text="Volume Snapshot Controller" url="/integrations/packs/?pack=volume-snapshot-controller" /> as the pack already includes the required components for volume snapshots. However, you must ensure the CSI driver supports volume snapshots. Review the CSI driver's Pack README for guidance on volume snapshot support.
+
 ## etcd Backups
 
 etcd backups are enabled by default. You can edit the YAML file for a cluster's Kubernetes layer to configure its

diff --git a/...ocs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md b/...ocs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md
@@ -50,6 +50,10 @@ Use the following instructions to schedule a backup for an existing cluster.
 
 - An active cluster in Palette.
 
+<!-- prettier-ignore -->
+- If you want to include volume snapshots in the backup, ensure that your CSI driver supports volume snapshots. For more
+  information about volume support, review the CSI pack README for your CSI driver in use. Refer to the [Volume Snapshots](backup-restore.md#volume-snapshots) section for more information.
+
 ### Instructions
 
 1. Log in to [Palette](https://console.spectrocloud.com/).

diff --git a/...cs-content/clusters/cluster-management/backup-restore/restore-cluster-backup.md b/...cs-content/clusters/cluster-management/backup-restore/restore-cluster-backup.md
@@ -102,6 +102,10 @@ out to our support team at [[email protected]](mailto:support@spectroclou
   enables the destination cluster to assume the necessary IAM role to access the backup files. Refer to the
   [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) guide.
 
+<!-- prettier-ignore -->
+- If your backup contains volume snapshots, ensure that your CSI driver supports volume snapshots. For more
+  information about volume support, review the CSI pack README for your CSI driver in use. Refer to the [Volume Snapshots](backup-restore.md#volume-snapshots) section for more information.
+
 ### Instructions
 
 Use the following instructions in Palette to restore a backup to a destination cluster.