Skip to content
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.

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

Add upgrade-config setting restoreVM document #641

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions docs/advanced/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:

Expand Down Expand Up @@ -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
Expand All @@ -555,7 +557,8 @@ https://your.upgrade.checker-url/v99/checkupgrade
"type": "parallel",
"concurrency": 2
}
}
},
"restoreVM": true
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/singlenodeclusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.