Skip to content

Commit fbe9b00

Browse files
WebberHuang1118ihcsim
WebberHuang1118
and
ihcsim
committed
fix/improve backward/forward compatibilty for VM Backup and Restore
Signed-off-by: Webber Huang <webber.huang@suse.com> Co-authored-by: Ivan Sim <1330522+ihcsim@users.noreply.github.com>
1 parent 2c1c587 commit fbe9b00

8 files changed

Lines changed: 57 additions & 7 deletions

File tree

‎docs/advanced/addons/lvm-local-storage.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,8 @@ You can also create a new virtual machine with the volume of the LVM StorageClas
152152

153153
- **Provisioner**: Select **lvm.driver.harvesterhci.io**.
154154
- **Volume Snapshot Class Name**: Select **lvm-snapshot**.
155-
- **Backup Volume Snapshot Class Name**: Select **lvm-snapshot**.
156155

157-
![](/img/v1.4/csi-driver-lvm/update-csi-driver-config-02.png)
156+
![](/img/v1.2/advanced/csi-driver-config-external.png)
158157

159158
1. On the **Virtual Machines** screen, select the target virtual machine, and then select **⋮** > **Take Virtual Machine Snapshot**.
160159

‎docs/advanced/csidriver.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ Before you can make use of Harvester's **Backup & Snapshot** features, you need
5555
1. Find and select **csi-driver-config**, and then select **⋮** > **Edit Setting** to access the configuration options.
5656
1. Set the **Provisioner** to the third-party CSI driver in the settings.
5757
1. Next, Configure the **Volume Snapshot Class Name**. This setting points to the name of the `VolumeSnapshotClass` used for creating volume snapshots or VM snapshots.
58-
1. Similarly, Configure the **Backup Volume Snapshot Class Name**. This corresponds to the name of the `VolumeSnapshotClass` responsible for creating VM backups.
5958

6059
![csi-driver-config-external](/img/v1.2/advanced/csi-driver-config-external.png)
6160

‎static/img/v1.2/advanced/csi-driver-config-external.png‎

-93.4 KB
Loading

‎versioned_docs/version-v1.3/advanced/csidriver.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,20 @@ Before you can make use of Harvester's **Backup & Snapshot** features, you need
5757
1. Find and select **csi-driver-config**, and then select **⋮** > **Edit Setting** to access the configuration options.
5858
1. Set the **Provisioner** to the third-party CSI driver in the settings.
5959
1. Next, Configure the **Volume Snapshot Class Name**. This setting points to the name of the `VolumeSnapshotClass` used for creating volume snapshots or VM snapshots.
60-
1. Similarly, Configure the **Backup Volume Snapshot Class Name**. This corresponds to the name of the `VolumeSnapshotClass` responsible for creating VM backups.
6160

6261
![csi-driver-config-external](/img/v1.2/advanced/csi-driver-config-external.png)
6362

63+
:::caution
64+
65+
- Once upgraded to **v1.4.2 or higher**, Harvester will block setting **Backup Volume Snapshot Class Name** for third-party storage, because except for **Longhorn V1 Data Engine**, **Backup** is not included in the CSI standard. There is no general way to have a remote backup for all kinds of storage providers.
66+
- Harvester will be unable to restore all the existing VM backups with third-part storage, since the data never has a remote copy.
67+
- Please refer to the following tickets for more details:
68+
- https://github.com/harvester/harvester/issues/7316
69+
- https://github.com/harvester/harvester/issues/7755
70+
- https://github.com/harvester/harvester/issues/7737
71+
72+
:::
73+
6474
## Use the CSI driver
6575

6676
After successfully configuring these settings, you can utilize the third-party StorageClass. You can apply the third-party StorageClass when creating an empty volume or adding a new block volume to a VM, enhancing your Harvester cluster's storage capabilities.

‎versioned_docs/version-v1.3/advanced/settings.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,17 @@ You must configure the following information before using features related to ba
177177
}
178178
```
179179

180+
:::caution
181+
182+
- Once upgraded to **v1.4.2 or higher**, Harvester will block setting **Backup Volume Snapshot Class Name** for third-party storage, because except for **Longhorn V1 Data Engine**, **Backup** is not included in the CSI standard. There is no general way to have a remote backup for all kinds of storage providers.
183+
- Harvester will be unable to restore all the existing VM backups with third-part storage, since the data never has a remote copy.
184+
- Please refer to the following tickets for more details:
185+
- https://github.com/harvester/harvester/issues/7316
186+
- https://github.com/harvester/harvester/issues/7755
187+
- https://github.com/harvester/harvester/issues/7737
188+
189+
:::
190+
180191
### `default-vm-termination-grace-period-seconds`
181192

182193
**Versions**: v1.2.0 and later

‎versioned_docs/version-v1.4/advanced/addons/lvm-local-storage.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,19 @@ You can also create a new virtual machine with the volume of the LVM StorageClas
152152

153153
- **Provisioner**: Select **lvm.driver.harvesterhci.io**.
154154
- **Volume Snapshot Class Name**: Select **lvm-snapshot**.
155-
- **Backup Volume Snapshot Class Name**: Select **lvm-snapshot**.
156155

157-
![](/img/v1.4/csi-driver-lvm/update-csi-driver-config-02.png)
156+
![](/img/v1.2/advanced/csi-driver-config-external.png)
157+
158+
:::caution
159+
160+
- Staring from **v1.4.2**, Harvester will block setting **Backup Volume Snapshot Class Name** for third-party storage, becuase except for **Longhorn V1 Data Engine**, **Backup** is not included in the CSI standard. There is no general way to have a remote backup for all kinds of storage providers.
161+
- If the **VM Backup** with third-party storage was already created mistakenly before **v1.4.2**, Harvester will refuse to restore it, since the data never has a remote copy
162+
- Please refer to the following tickets for more details:
163+
- https://github.com/harvester/harvester/issues/7316
164+
- https://github.com/harvester/harvester/issues/7755
165+
- https://github.com/harvester/harvester/issues/7737
166+
167+
:::
158168

159169
1. On the **Virtual Machines** screen, select the target virtual machine, and then select **⋮** > **Take Virtual Machine Snapshot**.
160170

‎versioned_docs/version-v1.4/advanced/csidriver.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,20 @@ Before you can make use of Harvester's **Backup & Snapshot** features, you need
5555
1. Find and select **csi-driver-config**, and then select **⋮** > **Edit Setting** to access the configuration options.
5656
1. Set the **Provisioner** to the third-party CSI driver in the settings.
5757
1. Next, Configure the **Volume Snapshot Class Name**. This setting points to the name of the `VolumeSnapshotClass` used for creating volume snapshots or VM snapshots.
58-
1. Similarly, Configure the **Backup Volume Snapshot Class Name**. This corresponds to the name of the `VolumeSnapshotClass` responsible for creating VM backups.
5958

6059
![csi-driver-config-external](/img/v1.2/advanced/csi-driver-config-external.png)
6160

61+
:::caution
62+
63+
- Once upgraded to **v1.4.2 or higher**, Harvester will block setting **Backup Volume Snapshot Class Name** for third-party storage, because except for **Longhorn V1 Data Engine**, **Backup** is not included in the CSI standard. There is no general way to have a remote backup for all kinds of storage providers.
64+
- Harvester will be unable to restore all the existing VM backups with third-part storage, since the data never has a remote copy.
65+
- Please refer to the following tickets for more details:
66+
- https://github.com/harvester/harvester/issues/7316
67+
- https://github.com/harvester/harvester/issues/7755
68+
- https://github.com/harvester/harvester/issues/7737
69+
70+
:::
71+
6272
## Use the CSI driver
6373

6474
After successfully configuring these settings, you can utilize the third-party StorageClass. You can apply the third-party StorageClass when creating an empty volume or adding a new block volume to a VM, enhancing your Harvester cluster's storage capabilities.

‎versioned_docs/version-v1.4/advanced/settings.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,17 @@ You must configure the following information before using features related to ba
177177
}
178178
```
179179

180+
:::caution
181+
182+
- Once upgraded to **v1.4.2 or higher**, Harvester will block setting **Backup Volume Snapshot Class Name** for third-party storage, because except for **Longhorn V1 Data Engine**, **Backup** is not included in the CSI standard. There is no general way to have a remote backup for all kinds of storage providers.
183+
- Harvester will be unable to restore all the existing VM backups with third-part storage, since the data never has a remote copy.
184+
- Please refer to the following tickets for more details:
185+
- https://github.com/harvester/harvester/issues/7316
186+
- https://github.com/harvester/harvester/issues/7755
187+
- https://github.com/harvester/harvester/issues/7737
188+
189+
:::
190+
180191
### `default-vm-termination-grace-period-seconds`
181192

182193
**Versions**: v1.2.0 and later

0 commit comments

Comments
 (0)