diff --git a/docs/advanced/settings.md b/docs/advanced/settings.md index ea606b62c7..ca6775cc82 100644 --- a/docs/advanced/settings.md +++ b/docs/advanced/settings.md @@ -507,7 +507,7 @@ https://your.upgrade.checker-url/v99/checkupgrade **Definition**: Upgrade-related configuration. -**Default value**: `{"imagePreloadOption":{"strategy":{"type":"sequential"}}}` +**Default value**: `{"imagePreloadOption":{"strategy":{"type":"sequential"}}, "restoreVM": false}` **Supported options and fields**: @@ -546,6 +546,8 @@ https://your.upgrade.checker-url/v99/checkupgrade ::: +- `restoreVM`: Option that enables Harvester to automatically restore running VMs after a single-node cluster is upgraded. The default value is `false`, which causes all VMs to be stopped after the upgrade is completed. When set to `true`, Harvester restarts VMs that were running before the upgrade was started. VMs that were paused before the upgrade are not restarted. + **Example**: ```json @@ -555,7 +557,8 @@ https://your.upgrade.checker-url/v99/checkupgrade "type": "parallel", "concurrency": 2 } - } + }, + "restoreVM": true } ``` diff --git a/docs/advanced/singlenodeclusters.md b/docs/advanced/singlenodeclusters.md index b1795075c8..efd664cead 100644 --- a/docs/advanced/singlenodeclusters.md +++ b/docs/advanced/singlenodeclusters.md @@ -55,6 +55,6 @@ If you want Longhorn to create multiple replicas on a node with multiple disks, ## Upgrades and Maintenance -Single-node clusters do not support [Live Migration](../vm/live-migration.md), so VMs become unavailable during cluster upgrades. Harvester forcibly shuts down all VMs before starting the upgrade process. +Single-node clusters do not support [Live Migration](../vm/live-migration.md), so VMs become unavailable during cluster upgrades. Harvester forcibly shuts down all VMs before starting the upgrade process. You can configure Harvester to automatically restore running VMs using the `restoreVM` option of the [`upgrade-config`](./settings.md#upgrade-config) setting. Enabling [Maintenance Mode](../host/host.md#node-maintenance) is also not possible because that operation relies on Live Migration functionality, and Harvester cannot place the only control plane in Maintenance Mode.