Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Volume Snapshot Support #3839

Merged
merged 7 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 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/" />
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
page.

<!-- prettier-ignore -->
If the CSI driver includes the [csi-snapshotter](https://github.com/kubernetes-csi/external-snapshotter), 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, including for backup purposes. 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.
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
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" /> do not need the <VersionedLink text="Volume Snapshot Controller" url="/integrations/packs/?pack=volume-snapshot-controller" /> as the VMO pack 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.
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

## etcd Backups

etcd backups are enabled by default. You can edit the YAML file for a cluster's Kubernetes layer to configure its
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 are want to include volume snapshots in the backup, ensure that your CSI driver supports volume snapshots. For more
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
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/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ backup. To learn more about the restore operation, refer to the Velero
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.
Expand Down