Skip to content

Instructions for checking status of new Volume snapshot and update Volume Snapshot page #302

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.

Sign up for GitHub

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

Merged
LucasSaintarbor merged 20 commits into from
Jul 31, 2023
Merged

Instructions for checking status of new Volume snapshot and update Volume Snapshot page #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a08dc83
Added reference to (https://github.com/harvester/harvester/issues/283…
LucasSaintarbor Apr 18, 2023
a8e2405
Added screenshots / revised content
LucasSaintarbor Apr 18, 2023
6761cd8
Add / update screenshots
LucasSaintarbor Apr 18, 2023
615ad15
Small style changes. Added a new h3 for viewing replicaiton status / …
LucasSaintarbor May 2, 2023
196fa9d
Add h3 to wrong section. Corrected mistake.
LucasSaintarbor May 2, 2023
ce5dfa5
Small update "...view the replication and health status for your new …
LucasSaintarbor May 2, 2023
9385d70
Replaced "your" with "the"
LucasSaintarbor May 2, 2023
ce9bbd6
Merge branch 'harvester:main' into 2838-volume-snapshot-page-update
LucasSaintarbor May 15, 2023
0615d7c
Apply suggestions from code review
LucasSaintarbor Jun 22, 2023
5e390df
Update steps for creating volume snapshots
LucasSaintarbor Jun 29, 2023
3d22d1a
Remove replication and health status section
LucasSaintarbor Jul 6, 2023
5b6b494
Delete restore-volume-snapshot-5.png
LucasSaintarbor Jul 6, 2023
f4f2b4c
Delete restore-volume-snapshot-6.png
LucasSaintarbor Jul 6, 2023
fe8b4d5
Delete restore-volume-snapshot-7.png
LucasSaintarbor Jul 6, 2023
0a31124
Update volume-snapshots.md
LucasSaintarbor Jul 28, 2023
987cd05
Merge branch 'main' into 2838-volume-snapshot-page-update
LucasSaintarbor Jul 28, 2023
bf302d0
Fix link to header > `restore-a-new-volume-from-a-volume-snapshot`
LucasSaintarbor Jul 28, 2023
51f6786
Merge branch 'main' into 2838-volume-snapshot-page-update
LucasSaintarbor Jul 31, 2023
ad1e666
Update v1.1 docs + small formatting changes
LucasSaintarbor Jul 31, 2023
a74d0e0
Update image links for v1.1
LucasSaintarbor Jul 31, 2023
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
2 changes: 1 addition & 1 deletion docs/volume/edit-volume.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2. Select StorageClass when [restoring the volume using snapshot](./volume-snapshots.md#restore-a-new-volume-from-a-volume-snapshot).
48 changes: 28 additions & 20 deletions docs/volume/volume-snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,54 @@ keywords:
- Volume Snapshots
Description: Take a snapshot for a volume from the Volume page.
---

<head>
<link rel="canonical" href="https://docs.harvesterhci.io/v1.1/volume/volume-snapshots"/>
</head>

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.
46 changes: 27 additions & 19 deletions versioned_docs/version-v1.1/volume/volume-snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,42 +12,50 @@ Description: Take a snapshot for a volume from the Volume page.
<link rel="canonical" href="https://docs.harvesterhci.io/v1.1/volume/volume-snapshots"/>
</head>

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.