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 index ee8a318c0a..e40a1f1b0e 100644 --- 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,17 @@ or [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic) guide. +### Backup Cluster Resources + +Palette backups are safe to restore to any cluster and include persistent data. A cluster-wide backup operation of the +source cluster can be configured using three options. The following table summarizes the different options. + +| **Backup Configuration** | **Description** | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Always** | Include all cluster-wide resources regardless of any selected namespaces. This option is designed for restore operations to be performed exclusively on the source cluster. | +| **Auto** | Include persistent volumes that are linked to claims within the selected namespaces, but exclude cluster-wide resources. This is the default option for new backups. | +| **Never** | Excludes all cluster-wide resources, including persistent volumes. | + ## Volume Snapshots diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md b/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md index fc0b82227d..39a143875e 100644 --- a/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md +++ b/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md @@ -15,33 +15,22 @@ the source cluster. :::info -Palette uses open source Velero to provide backup and restore capabilities. You can learn more about Velero by checking -out their [Restore Reference](https://velero.io/docs/main/restore-reference) and -[Backup Reference](https://velero.io/docs/main/backup-reference). +Palette uses Velero to provide backup and restore capabilities. Check out their +[Restore Reference](https://velero.io/docs/main/restore-reference) and +[Backup Reference](https://velero.io/docs/main/backup-reference) to learn more about the project. ::: -You can schedule a cluster backup or initiate a backup on demand. You can define a backup schedule in the cluster -configuration for an existing cluster or while deploying a cluster. +You can schedule a cluster backup or initiate a backup on demand. You can define a backup schedule during cluster +creation or in the cluster settings of an existing cluster. Palette supports scheduling recurring backups, with the ability to customize the frequency and the time. You can also -specify the backup expiry period, meaning the duration, after which Palette will delete the backup automatically. For +specify the backup expiry period, meaning the duration after which Palette will delete the backup automatically. For example, you can schedule a backup for every week on Sunday at midnight and automatically expire the backup after three months. Additionally, you can initiate a backup on demand for an existing cluster. -The following sections will describe the prerequisites and the detailed instructions to create a cluster backup. You can -schedule a backup or initiate a backup on demand. - -- [Schedule a Backup](#schedule-a-backup) - -- [On-demand Backup](#on-demand-backup) - -
- ## Schedule a Backup -Use the following instructions to schedule a backup for an existing cluster. - ### Prerequisites - An available backup location in Palette. Refer to the @@ -54,86 +43,99 @@ Use the following instructions to schedule a backup for an existing cluster. - 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 + :::warning + + Ensure that `manifests.volume-snapshot-class.deletionPolicy` is set to the `Retain` value if you have configured as a layer in your cluster profile. This setting allows volume snapshot content to be retained when volume snapshots are deleted, facilitating backup and restore functionality. -1. Log in to [Palette](https://console.spectrocloud.com/). + ```yaml hideClipboard {5} + volume-snapshot-class: + create: true + name: "spectro-volume-snapshot-class" + driver: "" + deletionPolicy: "Retain" + ``` -2. Navigate to the left **Main Menu** and select **Clusters**. + ::: -3. Select a cluster you want to back up. Ensure the cluster status is _Healthy_. +### Enablement -4. Click on the **Settings drop-down Menu** in the top right corner, and select **Cluster Settings**. +1. Log in to [Palette](https://console.spectrocloud.com/). -5. Next, on the **Settings Menu**, select the **Schedule Backups**. The screenshot below highlights the fields for - scheduling a backup. +2. Navigate to the left **Main Menu**, and then select **Clusters**. The list of clusters appears. -
+3. Select a cluster you want to back up. The cluster **Overview** appears. Ensure the cluster status is _Healthy_. - ![A screenshot highlighting the fields for scheduling a backup for an existing cluster.](/clusters_cluster-management_backup-restore_scheduled-backup.webp) +4. Click on the **Settings Menu** in the top right corner, and select **Cluster Settings**. The **Settings** pane + appears. -6. Fill out the required input fields to schedule a backup. Refer to the table to learn more about each input field. +5. Select **Schedule Backups**. The backup configuration appears. - | **Field** | **Description** | - | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **Backup prefix** | Palette will generate a name automatically. Provide a prefix string you want to prepend to the auto-generated name. | - | **Select backup location** | Choose a backup location. You must configure a location before creating a backup. | - | **Backup schedule** | Create a backup schedule of your choice. You can review the scheduling options below the current table. | - | **Select period until expiry** | Select an expiry duration for the backups. Palette will delete the backup after the expiry duration. | - | **Include all disks** | Select this checkbox if you want to include all the disks in the backup. | - | **Include cluster resources** | Select the checkbox if you want Palette to back up the cluster-scoped and the namespace-scoped resources. However, if you do not select the checkbox, Palette will back up only the namespace-scoped resources. | - | **Include Namespaces** (Optional) | Palette will back up all namespaces by default. However, you can specify any namespaces you do not want backed up. | + ![A screenshot highlighting the fields for scheduling a backup for an existing cluster.](/clusters_cluster-management_backup-restore_scheduled-backup.webp) -
+6. Fill out the required input fields to schedule a backup. Refer to the following table to learn more about each input + field. -:::info + | **Field** | **Description** | + | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | + | **Backup prefix** | Palette will generate a name automatically. Provide a prefix string you want to prepend to the auto-generated name. | + | **Select backup location** | Choose a backup location. You must configure a location before creating a backup. | + | **Backup schedule** | Create a backup schedule of your choice. Palette provides several scheduling options, including a fully customized date. | + | **Select period until expiry** | Select an expiry duration for the backups. Palette will delete the backup after the expiry duration. | + | **Include all disks** | Select this checkbox if you want to include all the disks in the backup. | + | **Include cluster-wide resources** | Select one the options from the dropdown. The available options are **Auto**, **Always** and **Never**. **Auto** is selected by default. | + | **Include Namespaces** (Optional) | Palette will back up all namespaces by default. However, you can specify any namespaces you do not want backed up. | - In Kubernetes, there are two types of resources: cluster-scoped and namespace-scoped. + :::info - Cluster-scoped resources, such as StorageClasses, ClusterRoles, and others, are visible and accessible to all users in the cluster, regardless of the namespaces. + In Kubernetes, there are two types of resources: cluster-scoped and namespace-scoped. - Namespace-scoped resources, like Pods, Deployments, Services, and others, belong to a specific namespace and can only be accessed by users with the necessary permissions. + Cluster-scoped resources, such as StorageClasses, ClusterRoles, and others, are visible and accessible to all users + in the cluster, regardless of the namespaces. -::: + Namespace-scoped resources, like Pods, Deployments, Services, and others, belong to a specific namespace and can only + be accessed by users with the necessary permissions. -
+ ::: - A cluster backup supports the following scheduling options: + A cluster backup supports the following scheduling options: - * You can customize your backup to occur at a specific month, day, hour, and minute that suits your needs. - * Every week on Sunday at midnight - * Every two weeks at midnight - * Every month on the first at midnight - * Every two months on the first at midnight - * Never + - You can customize your backup to occur at a specific month, day, hour, and minute that suits your needs. + - Every week on Sunday at midnight + - Every two weeks at midnight + - Every month on the first at midnight + - Every two months on the first at midnight + - Never -7. Click on the **Create Backup** button. + A cluster-wide backup operation of the source cluster can be configured using three options. The following table + summarizes the different options. -You now have successfully created a scheduled backup for the selected cluster. You can view the status of the backup in -the **Backups** tab. + | **Backup Configuration** | **Description** | + | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Always** | Include all cluster-wide resources regardless of any selected namespaces. This option is designed for restore operations to be performed exclusively on the source cluster. | + | **Auto** | Include persistent volumes that are linked to claims within the selected namespaces, but exclude cluster-wide resources. This is the default option for new backups. | + | **Never** | Excludes all cluster-wide resources, including persistent volumes. | -### Validate +7. Click on **Save Changes**. Depending on the size of the cluster, the backup process may take some time to complete. + You can view the status of the backup in the **Backups** tab. -Use the following steps to validate creating a backup in Palette. +### Validate 1. Log in to [Palette](https://console.spectrocloud.com/). -2. Navigate to the left **Main Menu**, and select **Clusters**. +2. Navigate to the left **Main Menu**, and then select **Clusters**. -3. Select the cluster from where you created the backup. Palette displays the details of the selected cluster. +3. Select the cluster that you configured a backup for. The cluster **Overview** appears. 4. Navigate to the **Backups** tab and click on the **Backups** nested tab. Palette displays a list of all available - backups for the current cluster, including the newly created one. The screenshot below shows an example backup. This - step validates that you have successfully created the backup. + backups for the current cluster, including the newly created one. -![A screenshot highlighting the list of available backups for the specific cluster.](/clusters_cluster-management_backup-restore_view-backup.webp) + ![A screenshot highlighting the list of available backups for the specific cluster.](/clusters_cluster-management_backup-restore_view-backup.webp) 5. You can click on the newly created backup from the list to view its details. Palette displays the backup name, status, creation date, expiry date, list of backed-up namespaces, and a boolean field indicating whether the backup includes all disks and cluster-scoped resources. -## On-demand Backup - -Use the following instructions to create an on-demand backup for an existing cluster. +## On-Demand backup ### Prerequisites @@ -141,68 +143,85 @@ Use the following instructions to create an on-demand backup for an existing clu [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md). -### Instructions - - An active cluster in Palette. + +- 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. + + :::warning + + Ensure that `manifests.volume-snapshot-class.deletionPolicy` is set to the `Retain` value if you have configured as a layer in your cluster profile. This setting allows volume snapshot content to be retained when volume snapshots are deleted, facilitating backup and restore functionality. + + ```yaml hideClipboard {5} + volume-snapshot-class: + create: true + name: "spectro-volume-snapshot-class" + driver: "" + deletionPolicy: "Retain" + ``` + + ::: + +### Enablement + 1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to the left **Main Menu** and select **Clusters**. 3. Select a cluster you want to back up. Ensure the cluster status is _Healthy_. -4. Navigate to the **Backups** tab and click on the **Create Backup** button. The screenshot below shows the popup - window Palette opens to initiate an on-demand backup.

- -
+4. Navigate to the **Backups** tab and click on the **Create Backup** button. The **Create Backup** window appears. ![A screenshot highlighting the fields for an on-demand backup for an existing cluster.](/clusters_cluster-management_backup-restore_ondemand-backup.webp) 5. Use the following information to configure a scheduled backup. - | **Field** | **Description** | - | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **Backup name** | Provide a name for the backup. | - | **Select backup location** | Choose a backup location. You must configure a backup location before creating a backup. Refer to the [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) guides to learn about adding a backup location using static or dynamic credentials. | - | **Select period until expiry** | Select an expiry duration for the backup. The backup will be automatically removed after the expiry duration. | - | **Include all disks** | Select this checkbox if you want to include PVs and volume snapshots in the backup. | - | **Include cluster resources** | Select the checkbox if you want to include cluster-scoped resources in the backup. If you do not select the checkbox, Palette will back up only the namespace-scoped resources. | - | **Include Namespaces** (Optional) | Palette will back up all namespaces by default. However, you can specify namespaces you do not want backed up. | + | **Field** | **Description** | + | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Backup name** | Provide a name for the backup. | + | **Select backup location** | Choose a backup location. You must configure a backup location before creating a backup. Refer to the [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) guides to learn about adding a backup location using static or dynamic credentials. | + | **Select period until expiry** | Select an expiry duration for the backup. The backup will be automatically removed after the expiry duration. | + | **Include all disks** | Select this checkbox if you want to include PVs and volume snapshots in the backup. | + | **Include cluster-wide resources** | Select one the options from the dropdown. The available options are **Auto**, **Always** and **Never**. **Auto** is selected by default. | + | **Include Namespaces** (Optional) | Palette will back up all namespaces by default. However, you can specify namespaces you do not want backed up. | -
+ :::info -:::info + In Kubernetes, there are two types of resources: cluster-scoped and namespace-scoped. - In Kubernetes, there are two types of resources: cluster-scoped and namespace-scoped. + Cluster-scoped resources, such as StorageClasses, ClusterRoles, and others, are visible and accessible to all users + in the cluster, regardless of the namespaces. - Cluster-scoped resources, such as StorageClasses, ClusterRoles, and others, are visible and accessible to all users in the cluster, regardless of the namespaces. + Namespace-scoped resources, like Pods, Deployments, Services, and others, belong to a specific namespace and can only + be accessed by users with the necessary permissions. - Namespace-scoped resources, like Pods, Deployments, Services, and others, belong to a specific namespace and can only be accessed by users with the necessary permissions. + ::: -::: - -
+ A cluster-wide backup operation of the source cluster can be configured using three options. The following table + summarizes the different options. -6. Click on the **Create Backup** button. + | **Backup Configuration** | **Description** | + | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Always** | Include all cluster-wide resources regardless of any selected namespaces. This option is designed for restore operations to be performed exclusively on the source cluster. | + | **Auto** | Include persistent volumes that are linked to claims within the selected namespaces, but exclude cluster-wide resources. This is the default option for new backups. | + | **Never** | Excludes all cluster-wide resources, including persistent volumes. | -You now have successfully created a backup for the selected cluster. Depending on the size of the cluster, the backup -process may take some time to complete. You can view the status of the backup in the **Backups** tab. +6. Click on the **Create Backup** button. Depending on the size of the cluster, the backup process may take some time to + complete. You can view the status of the backup in the **Backups** tab. ### Validate -Use the following steps to validate creating a backup in Palette.
- 1. Log in to [Palette](https://console.spectrocloud.com/). -2. Navigate to the left **Main Menu**, and select **Clusters**. +2. Navigate to the left **Main Menu**, and then select **Clusters**. -3. Select the cluster from where you created the backup. Palette displays the details of the selected cluster. +3. Select the cluster that you configured a backup for. The cluster **Overview** appears. 4. Navigate to the **Backups** tab and click on the **Backups** nested tab. Palette displays a list of all available - backups for the current cluster, including the newly created one. The screenshot below shows an example backup. This - step validates that you have successfully created the backup. + backups for the current cluster, including the newly created one. -![A screenshot highlighting the list of available backups for the specific cluster.](/clusters_cluster-management_backup-restore_view-backup.webp) + ![A screenshot highlighting the list of available backups for the specific cluster.](/clusters_cluster-management_backup-restore_view-backup.webp) 5. You can click on the newly created backup from the list to view its details. Palette displays the backup name, status, creation date, expiry date, list of backed-up namespaces, and a boolean field indicating whether the backup diff --git a/static/assets/docs/images/clusters_cluster-management_backup-restore_ondemand-backup.webp b/static/assets/docs/images/clusters_cluster-management_backup-restore_ondemand-backup.webp index 4c5237822b..42b590b87d 100644 Binary files a/static/assets/docs/images/clusters_cluster-management_backup-restore_ondemand-backup.webp and b/static/assets/docs/images/clusters_cluster-management_backup-restore_ondemand-backup.webp differ diff --git a/static/assets/docs/images/clusters_cluster-management_backup-restore_scheduled-backup.webp b/static/assets/docs/images/clusters_cluster-management_backup-restore_scheduled-backup.webp index 3e9853c995..b97156c7e8 100644 Binary files a/static/assets/docs/images/clusters_cluster-management_backup-restore_scheduled-backup.webp and b/static/assets/docs/images/clusters_cluster-management_backup-restore_scheduled-backup.webp differ diff --git a/static/assets/docs/images/clusters_cluster-management_backup-restore_view-backup.webp b/static/assets/docs/images/clusters_cluster-management_backup-restore_view-backup.webp index 3daad4e00d..52be41f039 100644 Binary files a/static/assets/docs/images/clusters_cluster-management_backup-restore_view-backup.webp and b/static/assets/docs/images/clusters_cluster-management_backup-restore_view-backup.webp differ