diff --git a/docs/volume/edit-volume.md b/docs/volume/edit-volume.md index 0740d651edd..7631e282c0c 100644 --- a/docs/volume/edit-volume.md +++ b/docs/volume/edit-volume.md @@ -31,4 +31,4 @@ If you specify a size larger than Longhorn's capacity during the expansion, the The StorageClass of an existing volume cannot be changed. However, you can change the StorageClass while restoring a new volume from the snapshot by following the steps below: 1. [Take a volume snapshot](./volume-snapshots.md#create-volume-snapshots). -2. Select StorageClass when [restoring the volume using snapshot](./volume-snapshots.md#restore-a-new-volume-using-volume-snapshot). \ No newline at end of file +2. Select StorageClass when [restoring the volume using snapshot](./volume-snapshots.md#restore-a-new-volume-from-a-volume-snapshot). \ No newline at end of file diff --git a/docs/volume/volume-snapshots.md b/docs/volume/volume-snapshots.md index 152ae1f419b..18bfd266b29 100644 --- a/docs/volume/volume-snapshots.md +++ b/docs/volume/volume-snapshots.md @@ -7,46 +7,54 @@ keywords: - Volume Snapshots Description: Take a snapshot for a volume from the Volume page. --- - +A volume snapshot represents a snapshot of a volume on a storage system. After creating a volume, you can create a volume snapshot and restore a volume to the snapshot's state. With volume snapshots, you can easily copy or restore a volume's configuration. + ## Create Volume Snapshots -:::note +You can create a volume snapshot from an existing volume by following these steps: -A recurring snapshot is currently not supported and is tracked via [harvester/harvester#572](https://github.com/harvester/harvester/issues/572) +1. Go to the **Volumes** page. -::: +1. Choose the volume that you want to take a snapshot of and select **⋮ > Take Snapshot**. + + ![create-volume-snapshot-1](/img/v1.2/volume/create-volume-snapshot-1.png) -After creating a volume, you can create volume snapshots by following the steps below: +1. Enter a **Name** for the snapshot. -1. Click the `⋮` button and select the `Take Snapshot` option. + ![create-volume-snapshot-2](/img/v1.2/volume/create-volume-snapshot-2.png) - ![create-volume-snapshot-1](/img/v1.2/volume/create-volume-snapshot-1.png) +1. Select **Create** to finish creating a new volume snapshot. -1. Configure the `Name` of the new image and click `Create`. +1. Check the status of this operation and view all volume snapshots by going to the **Volumes** page and selecting the **Snapshots** tab. When the **Ready To Use** becomes **√**, the volume snapshot is ready to use. - ![create-volume-snapshot-2](/img/v1.2/volume/create-volume-snapshot-2.png) +:::note + +A recurring snapshot is currently not supported and is tracked via [harvester/harvester#572](https://github.com/harvester/harvester/issues/572). + +::: -## Restore a New Volume using Volume Snapshot +## Restore a new volume from a volume snapshot -After creating a volume snapshot, you can restore a new volume using the volume snapshot by following the steps below: +You can restore a new volume from an existing volume snapshot by following these steps: -1. Go to the `Backup & Snapshot > Volume Snapshots` page or the `Snapshots` tab in each `Volumes` Detail page. +1. Go to the **Backup & Snapshot > Volume Snapshots** page or select a **Volume** from the **Volumes** page and go to the **Snapshots** tab. - ![restore-volume-snapshot-1](/img/v1.2/volume/restore-volume-snapshot-1.png) +1. Select **⋮ > Restore**. -1. Click the `⋮` button and select the `Restore` option. + ![restore-volume-snapshot-1](/img/v1.2/volume/restore-volume-snapshot-1.png) + + ![restore-volume-snapshot-2](/img/v1.2/volume/restore-volume-snapshot-2.png) - ![restore-volume-snapshot-2](/img/v1.2/volume/restore-volume-snapshot-2.png) +1. Specify the **Name** of the new volume. -1. Specify the `Name` of the new Volume. - ![restore-volume-snapshot-3](/img/v1.2/volume/restore-volume-snapshot-3.png) + ![restore-volume-snapshot-3](/img/v1.2/volume/restore-volume-snapshot-3.png) -1. If the source volume is not an image volume, you can also select a different `StorageClass`. +1. If the source volume is not an image volume, you can select a different **StorageClass**. You can not change the **StorageClass** if the source volume is an image volume. - ![restore-volume-snapshot-4](/img/v1.2/volume/restore-volume-snapshot-4.png) + ![restore-volume-snapshot-4](/img/v1.2/volume/restore-volume-snapshot-4.png) -1. Click `Create`. +1. Select **Create** to finish restoring a new volume. diff --git a/versioned_docs/version-v1.1/volume/volume-snapshots.md b/versioned_docs/version-v1.1/volume/volume-snapshots.md index 3db303b7a21..4f294062630 100644 --- a/versioned_docs/version-v1.1/volume/volume-snapshots.md +++ b/versioned_docs/version-v1.1/volume/volume-snapshots.md @@ -12,42 +12,50 @@ Description: Take a snapshot for a volume from the Volume page. +A volume snapshot represents a snapshot of a volume on a storage system. After creating a volume, you can create a volume snapshot and restore a volume to the snapshot's state. With volume snapshots, you can easily copy or restore a volume's configuration. + ## Create Volume Snapshots -:::note +You can create a volume snapshot from an existing volume by following these steps: -A recurring snapshot is currently not supported and is tracked via [harvester/harvester#572](https://github.com/harvester/harvester/issues/572) +1. Go to the **Volumes** page. -::: +1. Choose the volume that you want to take a snapshot of and select **⋮ > Take Snapshot**. -After creating a volume, you can create volume snapshots by following the steps below: + ![create-volume-snapshot-1](/img/v1.1/volume/create-volume-snapshot-1.png) -1. Click the `⋮` button and select the `Take Snapshot` option. +1. Enter a **Name** for the snapshot. - ![create-volume-snapshot-1](/img/v1.1/volume/create-volume-snapshot-1.png) + ![create-volume-snapshot-2](/img/v1.1/volume/create-volume-snapshot-2.png) -1. Configure the `Name` of the new image and click `Create`. +1. Select **Create** to finish creating a new volume snapshot. - ![create-volume-snapshot-2](/img/v1.1/volume/create-volume-snapshot-2.png) +1. Check the status of this operation and view all volume snapshots by going to the **Volumes** page and selecting the **Snapshots** tab. When the **Ready To Use** becomes **√**, the volume snapshot is ready to use. -## Restore a New Volume using Volume Snapshot +:::note + +A recurring snapshot is currently not supported and is tracked via [harvester/harvester#572](https://github.com/harvester/harvester/issues/572). + +::: -After creating a volume snapshot, you can restore a new volume using the volume snapshot by following the steps below: +## Restore a new volume from a volume snapshot -1. Go to the `Backup & Snapshot > Volume Snapshots` page or the `Snapshots` tab in each `Volumes` Detail page. +You can restore a new volume from an existing volume snapshot by following these steps: - ![restore-volume-snapshot-1](/img/v1.1/volume/restore-volume-snapshot-1.png) +1. Go to the **Backup & Snapshot > Volume Snapshots** page or select a **Volume** from the **Volumes** page and go to the **Snapshots** tab. -1. Click the `⋮` button and select the `Restore` option. +1. Select **⋮ > Restore**. - ![restore-volume-snapshot-2](/img/v1.1/volume/restore-volume-snapshot-2.png) + ![restore-volume-snapshot-1](/img/v1.1/volume/restore-volume-snapshot-1.png) + + ![restore-volume-snapshot-2](/img/v1.1/volume/restore-volume-snapshot-2.png) -1. Specify the `Name` of the new Volume. +1. Specify the **Name** of the new volume. - ![restore-volume-snapshot-3](/img/v1.1/volume/restore-volume-snapshot-3.png) + ![restore-volume-snapshot-3](/img/v1.1/volume/restore-volume-snapshot-3.png) -1. If the source volume is not an image volume, you can also select a different `StorageClass`. +1. If the source volume is not an image volume, you can select a different **StorageClass**. You can not change the **StorageClass** if the source volume is an image volume. - ![restore-volume-snapshot-4](/img/v1.1/volume/restore-volume-snapshot-4.png) + ![restore-volume-snapshot-4](/img/v1.1/volume/restore-volume-snapshot-4.png) -1. Click `Create`. +1. Select **Create** to finish restoring a new volume.