Skip to content

Commit

Permalink
add upgrade free space check to document
Browse files Browse the repository at this point in the history
Signed-off-by: Jian Wang <w13915984028@gmail.com>
  • Loading branch information
w13915984028 authored and vickyhella committed Jul 4, 2023
1 parent fd89a8d commit 64d5f33
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions docs/upgrade/automatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Note we are still working towards zero-downtime upgrade, due to some known issue
- Back up your VMs if needed.
- Do not operate the cluster during an upgrade. For example, creating new VMs, uploading new images, etc.
- Make sure your hardware meets the **preferred** [hardware requirements](../install/requirements.md#hardware-requirements). This is due to there will be intermediate resources consumed by an upgrade.
- Make sure each node has at least 25 GB of free space (`df -h /usr/local/`).
- Make sure each node has at least 30 GiB of free system partition space (`df -h /usr/local/`). If any node in the cluster has less than 30 GiB of free system partition space, the upgrade will be denied. Check [free system partition space requirement](#free-system-partition-space-requirement) for more information.

:::

Expand Down Expand Up @@ -101,7 +101,7 @@ Make sure to check [Upgrade support matrix](#upgrade-support-matrix) section fir
name: v1.0.2
namespace: harvester-system
spec:
isoChecksum: <SHA-512 checksum of the ISO>
isoChecksum: <SHA-512 checksum of the ISO>
isoURL: http://10.10.0.1/harvester.iso # change to local ISO URL
releaseDate: '20220512'
```
Expand All @@ -117,3 +117,36 @@ Make sure to check [Upgrade support matrix](#upgrade-support-matrix) section fir
```

- An upgrade button should show up on the Harvester GUI Dashboard page.

## Free system partition space requirement

_Available as of v1.2.0_

The minimum free system partition space requirement in Harvester v1.2.0 is 30 GiB, which will be revised in each release.

Harvester will check the amount of free system partition space on each node when you select **Upgrade**. If any node does not meet the requirement, the upgrade will be denied as follows

![](/img/v1.2/upgrade/upgrade_free_space_check.png)

If some nodes do not have enough free system partition space, but you still want to try upgrading, you can customize the upgrade by updating the `harvesterhci.io/minFreeDiskSpaceGB` annotation of `Version` object.

```
apiVersion: harvesterhci.io/v1beta1
kind: Version
metadata:
annotations:
harvesterhci.io/minFreeDiskSpaceGB: "30" # the value is pre-defined and may be customized
name: 1.2.0
namespace: harvester-system
spec:
isoChecksum: <SHA-512 checksum of the ISO>
isoURL: http://192.168.0.181:8000/harvester-master-amd64.iso
minUpgradableVersion: 1.1.2
releaseDate: "20230609"
```

:::caution

Setting a smaller value than the pre-defined value may cause the upgrade to fail and is not recommended in a production environment.

:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 64d5f33

Please sign in to comment.