feat: add v1.5.2 upgrade docs

starbops · starbops · commit 5f98d74415b0 · 2025-09-23T15:20:39.000+08:00
Signed-off-by: Zespre Chang &lt;zespre.chang@suse.com&gt;
diff --git a/docs/upgrade/troubleshooting.md b/docs/upgrade/troubleshooting.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 15
+sidebar_position: 17
 sidebar_label: Troubleshooting
 title: "Troubleshooting"
 ---
diff --git a/docs/upgrade/v1-1-2-to-v1-2-0.md b/docs/upgrade/v1-1-2-to-v1-2-0.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 14
+sidebar_position: 16
 sidebar_label: Upgrade from v1.1.2 to v1.2.0 (not recommended)
 title: "Upgrade from v1.1.2 to v1.2.0 (not recommended)"
 ---
diff --git a/docs/upgrade/v1-2-0-to-v1-2-1.md b/docs/upgrade/v1-2-0-to-v1-2-1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 13
+sidebar_position: 15
 sidebar_label: Upgrade from v1.1.2/v1.1.3/v1.2.0 to v1.2.1
 title: "Upgrade from v1.1.2/v1.1.3/v1.2.0 to v1.2.1"
 ---
diff --git a/docs/upgrade/v1-2-1-to-v1-2-2.md b/docs/upgrade/v1-2-1-to-v1-2-2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 12
+sidebar_position: 14
 sidebar_label: Upgrade from v1.2.1 to v1.2.2
 title: "Upgrade from v1.2.1 to v1.2.2"
 ---
diff --git a/docs/upgrade/v1-2-2-to-v1-3-1.md b/docs/upgrade/v1-2-2-to-v1-3-1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 11
+sidebar_position: 13
 sidebar_label: Upgrade from v1.2.2/v1.3.0 to v1.3.1
 title: "Upgrade from v1.2.2/v1.3.0 to v1.3.1"
 ---
diff --git a/docs/upgrade/v1-3-1-to-v1-3-2.md b/docs/upgrade/v1-3-1-to-v1-3-2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 12
 sidebar_label: Upgrade from v1.3.1 to v1.3.2
 title: "Upgrade from v1.3.1 to v1.3.2"
 ---
diff --git a/docs/upgrade/v1-3-2-to-v1-4-0.md b/docs/upgrade/v1-3-2-to-v1-4-0.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 9
+sidebar_position: 11
 sidebar_label: Upgrade from v1.3.2 to v1.4.0
 title: "Upgrade from v1.3.2 to v1.4.0"
 ---
diff --git a/docs/upgrade/v1-4-0-to-v1-4-1.md b/docs/upgrade/v1-4-0-to-v1-4-1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 8
+sidebar_position: 10
 sidebar_label: Upgrade from v1.4.0 to v1.4.1
 title: "Upgrade from v1.4.0 to v1.4.1"
 ---
@@ -330,4 +330,4 @@ The workaround is to disable the setting [Automatically Delete Workload Pod When
 
 The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
 
-Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-4-1-to-v1-4-2.md b/docs/upgrade/v1-4-1-to-v1-4-2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 9
 sidebar_label: Upgrade from v1.4.1 to v1.4.2
 title: "Upgrade from v1.4.1 to v1.4.2"
 ---
@@ -100,4 +100,4 @@ The workaround is to disable the setting [Automatically Delete Workload Pod When
 
 The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
 
-Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-4-1-to-v1-4-3.md b/docs/upgrade/v1-4-1-to-v1-4-3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 8
 sidebar_label: Upgrade from v1.4.1/v1.4.2 to v1.4.3
 title: "Upgrade from v1.4.1/v1.4.2 to v1.4.3"
 ---
@@ -203,4 +203,4 @@ The workaround is to disable the setting [Automatically Delete Workload Pod When
 
 The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
 
-Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-4-2-to-v1-5-0.md b/docs/upgrade/v1-4-2-to-v1-5-0.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 7
 sidebar_label: Upgrade from v1.4.2/v1.4.3 to v1.5.0
 title: "Upgrade from v1.4.2/v1.4.3 to v1.5.0"
 ---
@@ -211,4 +211,4 @@ The workaround is to disable the setting [Automatically Delete Workload Pod When
 
 The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
 
-Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-4-2-to-v1-5-1.md b/docs/upgrade/v1-4-2-to-v1-5-1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 6
 sidebar_label: Upgrade from v1.4.2/v1.4.3 to v1.5.1
 title: "Upgrade from v1.4.2/v1.4.3 to v1.5.1"
 ---
@@ -134,4 +134,4 @@ The workaround is to disable the setting [Automatically Delete Workload Pod When
 
 The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
 
-Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-4-2-to-v1-5-2.md b/docs/upgrade/v1-4-2-to-v1-5-2.md
@@ -0,0 +1,137 @@
+---
+sidebar_position: 5
+sidebar_label: Upgrade from v1.4.2/v1.4.3 to v1.5.2
+title: "Upgrade from v1.4.2/v1.4.3 to v1.5.2"
+---
+
+<head>
+  <link rel="canonical" href="https://docs.harvesterhci.io/v1.6/upgrade/v1-4-2-to-v1-5-2"/>
+</head>
+
+## General Information
+
+An **Upgrade** button appears on the **Dashboard** screen whenever a new Harvester version that you can upgrade to becomes available. For more information, see [Start an upgrade](./automatic.md#start-an-upgrade).
+
+You can directly upgrade from v1.4.2 to v1.5.2 because Harvester allows a maximum of one minor version upgrade for underlying components. Harvester v1.4.2 and v1.4.3 use the same minor version of RKE2 (v1.31), while Harvester v1.5.0, v1.5.1 and v1.5.2 use the next minor version (v1.32).
+
+For information about upgrading Harvester in air-gapped environments, see [Prepare an air-gapped upgrade](./automatic.md#prepare-an-air-gapped-upgrade).
+
+### Update Harvester UI Extension on Rancher v2.11.0
+
+You must use **v1.5.2** of the Harvester UI Extension to import Harvester v1.5.2 clusters on Rancher v2.11.0.
+
+1. On the Rancher UI, go to **local > Apps > Repositories**.
+
+1. Locate the repository named **harvester**, and then select **⋮ > Refresh**.
+
+1. Go to the **Extensions** screen.
+
+1. Locate the extension named **Harvester**, and then click **Update**.
+
+1. Select version **1.5.2**, and then click **Update**.
+
+1. Allow some time for the extension to be updated, and then refresh the screen.
+
+---
+
+## Known Issues
+
+### 1. Air-gapped Upgrade Stuck with `ImagePullBackOff` Error in Fluentd and Fluent Bit Pods
+
+The upgrade may become stuck at the very beginning of the process, as indicated by 0% progress and items marked **Pending** in the **Upgrade** dialog of the Harvester UI.
+
+![](/img/v1.5/upgrade/upgrade-dialog-with-empty-status.png)
+
+Specifically, Fluentd and Fluent Bit pods may become stuck in the `ImagePullBackOff` status. To check the status of the pods, run the following commands:
+
+```bash
+$ kubectl -n harvester-system get upgrades -l harvesterhci.io/latestUpgrade=true
+NAME                 AGE
+hvst-upgrade-x2hz8   7m14s
+
+$ kubectl -n harvester-system get upgradelogs -l harvesterhci.io/upgrade=hvst-upgrade-x2hz8
+NAME                            UPGRADE
+hvst-upgrade-x2hz8-upgradelog   hvst-upgrade-x2hz8
+
+$ kubectl -n harvester-system get pods -l harvesterhci.io/upgradeLog=hvst-upgrade-x2hz8-upgradelog
+NAME                                                        READY   STATUS             RESTARTS   AGE
+hvst-upgrade-x2hz8-upgradelog-downloader-6cdb864dd9-6bw98   1/1     Running            0          7m7s
+hvst-upgrade-x2hz8-upgradelog-infra-fluentbit-2nq7q         0/1     ImagePullBackOff   0          7m42s
+hvst-upgrade-x2hz8-upgradelog-infra-fluentbit-697wf         0/1     ImagePullBackOff   0          7m42s
+hvst-upgrade-x2hz8-upgradelog-infra-fluentbit-kd8kl         0/1     ImagePullBackOff   0          7m42s
+hvst-upgrade-x2hz8-upgradelog-infra-fluentd-0               0/2     ImagePullBackOff   0          7m42s
+```
+
+This occurs because the following container images are neither preloaded in the cluster nodes nor pulled from the internet:
+
+- `ghcr.io/kube-logging/fluentd:v1.15-ruby3`
+- `ghcr.io/kube-logging/config-reloader:v0.0.5`
+- `fluent/fluent-bit:2.1.8`
+
+To fix the issue, perform any of the following actions:
+
+- Update the Logging CR to use the images that are already preloaded in the cluster nodes. To do this, run the following commands against the cluster:
+
+  ```bash
+  # Get the Logging CR names
+  OPERATOR_LOGGING_NAME=$(kubectl get loggings -l app.kubernetes.io/name=rancher-logging -o jsonpath="{.items[0].metadata.name}")
+  INFRA_LOGGING_NAME=$(kubectl get loggings -l harvesterhci.io/upgradeLogComponent=infra -o jsonpath="{.items[0].metadata.name}")
+
+  # Gather image info from operator's Logging CR
+  FLUENTD_IMAGE_REPO=$(kubectl get loggings $OPERATOR_LOGGING_NAME -o jsonpath="{.spec.fluentd.image.repository}")
+  FLUENTD_IMAGE_TAG=$(kubectl get loggings $OPERATOR_LOGGING_NAME -o jsonpath="{.spec.fluentd.image.tag}")
+
+  FLUENTBIT_IMAGE_REPO=$(kubectl get loggings $OPERATOR_LOGGING_NAME -o jsonpath="{.spec.fluentbit.image.repository}")
+  FLUENTBIT_IMAGE_TAG=$(kubectl get loggings $OPERATOR_LOGGING_NAME -o jsonpath="{.spec.fluentbit.image.tag}")
+
+  CONFIG_RELOADER_IMAGE_REPO=$(kubectl get loggings $OPERATOR_LOGGING_NAME -o jsonpath="{.spec.fluentd.configReloaderImage.repository}")
+  CONFIG_RELOADER_IMAGE_TAG=$(kubectl get loggings $OPERATOR_LOGGING_NAME -o jsonpath="{.spec.fluentd.configReloaderImage.tag}")
+
+  # Patch the Logging CR
+  kubectl patch logging $INFRA_LOGGING_NAME --type=json -p="[{\"op\":\"replace\",\"path\":\"/spec/fluentbit/image\",\"value\":{\"repository\":\"$FLUENTBIT_IMAGE_REPO\",\"tag\":\"$FLUENTBIT_IMAGE_TAG\"}}]"
+  kubectl patch logging $INFRA_LOGGING_NAME --type=json -p="[{\"op\":\"replace\",\"path\":\"/spec/fluentd/image\",\"value\":{\"repository\":\"$FLUENTD_IMAGE_REPO\",\"tag\":\"$FLUENTD_IMAGE_TAG\"}}]"
+  kubectl patch logging $INFRA_LOGGING_NAME --type=json -p="[{\"op\":\"replace\",\"path\":\"/spec/fluentd/configReloaderImage\",\"value\":{\"repository\":\"$CONFIG_RELOADER_IMAGE_REPO\",\"tag\":\"$CONFIG_RELOADER_IMAGE_TAG\"}}]"
+  ```
+
+  The status of the Fluentd and Fluent Bit pods should change to `Running` in a moment and the upgrade process should continue after the Logging CR is updated. If the Fluentd pod is still in the `ImagePullBackOff` status, try deleting it with the following command to force it to restart:
+
+  ```bash
+  UPGRADE_NAME=$(kubectl -n harvester-system get upgrades -l harvesterhci.io/latestUpgrade=true -o jsonpath='{.items[0].metadata.name}')
+  UPGRADELOG_NAME=$(kubectl -n harvester-system get upgradelogs -l harvesterhci.io/upgrade=$UPGRADE_NAME -o jsonpath='{.items[0].metadata.name}')
+
+  kubectl -n harvester-system delete pods -l harvesterhci.io/upgradeLog=$UPGRADELOG_NAME,harvesterhci.io/upgradeLogComponent=aggregator
+  ```
+
+- On a computer with internet access, pull the required container images and then export them to a TAR file. Next, transfer the TAR file to the cluster nodes and then import the images by running the following commands on each node:
+
+  ```bash
+  # Pull down the three container images
+  docker pull ghcr.io/kube-logging/fluentd:v1.15-ruby3
+  docker pull ghcr.io/kube-logging/config-reloader:v0.0.5
+  docker pull fluent/fluent-bit:2.1.8
+
+  # Export the images to a tar file
+  docker save \
+    ghcr.io/kube-logging/fluentd:v1.15-ruby3 \
+    ghcr.io/kube-logging/config-reloader:v0.0.5 \
+    fluent/fluent-bit:2.1.8 > upgradelog-images.tar
+
+  # After transferring the tar file to the cluster nodes, import the images (need to be run on each node)
+  ctr -n k8s.io images import upgradelog-images.tar
+  ```
+
+  The upgrade process should continue after the images are preloaded.
+
+- (Not recommended) Restart the upgrade process with logging disabled. Ensure that the **Enable Logging** checkbox in the **Upgrade** dialog is not selected.
+
+Related issue: [#7955](https://github.com/harvester/harvester/issues/7955)
+
+### 2. Virtual Machines That Use Migratable RWX Volumes Restart Unexpectedly
+
+A [Longhorn issue](https://github.com/longhorn/longhorn/issues/11158) causes virtual machines that use migratable [RWX volumes](https://docs.harvesterhci.io/v1.5/rancher/csi-driver/#rwx-volumes-support) to restart unexpectedly when the CSI plugin pods are restarted. This issue affects Harvester v1.4.x and v1.5.x.
+
+The workaround is to disable the setting [Automatically Delete Workload Pod When The Volume Is Detached Unexpectedly](https://longhorn.io/docs/1.8.0/references/settings/#automatically-delete-workload-pod-when-the-volume-is-detached-unexpectedly) on the Longhorn UI before starting the upgrade. You must enable the setting again once the upgrade is completed.
+
+The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
+
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-5-0-to-v1-5-1.md b/docs/upgrade/v1-5-0-to-v1-5-1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 sidebar_label: Upgrade from v1.5.0 to v1.5.1
 title: "Upgrade from v1.5.0 to v1.5.1"
 ---
@@ -42,4 +42,4 @@ The workaround is to disable the setting [Automatically Delete Workload Pod When
 
 The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
 
-Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-5-0-to-v1-5-2.md b/docs/upgrade/v1-5-0-to-v1-5-2.md
@@ -0,0 +1,45 @@
+---
+sidebar_position: 3
+sidebar_label: Upgrade from v1.5.0/v1.5.1 to v1.5.2
+title: "Upgrade from v1.5.0/v1.5.1 to v1.5.2"
+---
+
+<head>
+  <link rel="canonical" href="https://docs.harvesterhci.io/v1.6/upgrade/v1-5-0-to-v1-5-2"/>
+</head>
+
+## General Information
+
+An **Upgrade** button appears on the **Dashboard** screen whenever a new Harvester version that you can upgrade to becomes available. For more information, see [Start an upgrade](./automatic.md#start-an-upgrade).
+
+For information about upgrading Harvester in air-gapped environments, see [Prepare an air-gapped upgrade](./automatic.md#prepare-an-air-gapped-upgrade).
+
+### Update Harvester UI Extension on Rancher v2.11.0
+
+You must use **v1.5.2** of the Harvester UI Extension to import Harvester v1.5.2 clusters on Rancher v2.11.0.
+
+1. On the Rancher UI, go to **local > Apps > Repositories**.
+
+1. Locate the repository named **harvester**, and then select **⋮ > Refresh**.
+
+1. Go to the **Extensions** screen.
+
+1. Locate the extension named **Harvester**, and then click **Update**.
+
+1. Select version **1.5.2**, and then click **Update**.
+
+1. Allow some time for the extension to be updated, and then refresh the screen.
+
+---
+
+## Known Issues
+
+### 1. Virtual Machines That Use Migratable RWX Volumes Restart Unexpectedly
+
+A [Longhorn issue](https://github.com/longhorn/longhorn/issues/11158) causes virtual machines that use migratable [RWX volumes](https://docs.harvesterhci.io/v1.5/rancher/csi-driver/#rwx-volumes-support) to restart unexpectedly when the CSI plugin pods are restarted. This issue affects Harvester v1.4.x and v1.5.x.
+
+The workaround is to disable the setting [Automatically Delete Workload Pod When The Volume Is Detached Unexpectedly](https://longhorn.io/docs/1.8.0/references/settings/#automatically-delete-workload-pod-when-the-volume-is-detached-unexpectedly) on the Longhorn UI before starting the upgrade. You must enable the setting again once the upgrade is completed.
+
+The issue will be fixed in Longhorn v1.8.3, v1.9.1, and later versions. Harvester v1.6.0 will include Longhorn v1.9.1. 
+
+Related issues: [#8534](https://github.com/harvester/harvester/issues/8534) and [#11158](https://github.com/longhorn/longhorn/issues/11158)
diff --git a/docs/upgrade/v1-5-0-to-v1-6-0.md b/docs/upgrade/v1-5-0-to-v1-6-0.md
@@ -152,4 +152,5 @@ esac
 
 The workaround is to replace the above contents generated from gopkg.in/yaml.v3 for `/etc/wicked/scripts/setup_bond.sh` and `/etc/wicked/scripts/setup_bridge.sh` in `/oem/90_custom.yaml` file. Once the file is updated, the upgrade process should resume its progress.
 
-Related issue: [#9033](https://github.com/harvester/harvester/issues/9033)
+Related issue: [#9033](https://github.com/harvester/harvester/issues/9033)
+
