diff --git a/content/docs/1.6.0/deploy/important-notes/index.md b/content/docs/1.6.0/deploy/important-notes/index.md index c548b3b08..f54cebf81 100644 --- a/content/docs/1.6.0/deploy/important-notes/index.md +++ b/content/docs/1.6.0/deploy/important-notes/index.md @@ -15,6 +15,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Updating CSI Snapshot CRD `v1beta1` to `v1`, `v1beta1` Removed](#updating-csi-snapshot-crd-v1beta1-to-v1-v1beta1-removed) - [Engine Upgrade Enforcement](#engine-upgrade-enforcement) - [Danger Zone Setting Configuration](#danger-zone-setting-configuration) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [V2 Data Engine](#v2-data-engine) - [Longhorn System Upgrade](#longhorn-system-upgrade) - [Changing Default Huge Page Size to 2 GiB](#changing-default-huge-page-size-to-2-gib) @@ -154,6 +155,12 @@ Settings are synchronized hourly. When all volumes are detached, the settings in For V1 and V2 Data Engine settings, you can disable the Data Engines only when all associated volumes are detached. For example, you can disable the V2 Data Engine only when all V2 volumes are detached (even when V1 volumes are still attached). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + ## V2 Data Engine ### Longhorn System Upgrade diff --git a/content/docs/1.6.0/deploy/upgrade/_index.md b/content/docs/1.6.0/deploy/upgrade/_index.md index 04efb1b80..ffc031ddc 100644 --- a/content/docs/1.6.0/deploy/upgrade/_index.md +++ b/content/docs/1.6.0/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.6.1/deploy/important-notes/index.md b/content/docs/1.6.1/deploy/important-notes/index.md index 75bdb768e..f38c0afe8 100644 --- a/content/docs/1.6.1/deploy/important-notes/index.md +++ b/content/docs/1.6.1/deploy/important-notes/index.md @@ -16,6 +16,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Engine Upgrade Enforcement](#engine-upgrade-enforcement) - [Danger Zone Setting Configuration](#danger-zone-setting-configuration) - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [V2 Data Engine](#v2-data-engine) - [Longhorn System Upgrade](#longhorn-system-upgrade) - [Changing Default Huge Page Size to 2 GiB](#changing-default-huge-page-size-to-2-gib) @@ -203,6 +204,12 @@ spec: ``` From this version, you need to add group id 6 to the security context or run container as root. For more information, see [Longhorn PVC ownership and permission](../../nodes-and-volumes/volumes/pvc-ownership-and-permission) +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + ## V2 Data Engine ### Longhorn System Upgrade diff --git a/content/docs/1.6.1/deploy/upgrade/_index.md b/content/docs/1.6.1/deploy/upgrade/_index.md index aefe21864..6cc76e6a6 100644 --- a/content/docs/1.6.1/deploy/upgrade/_index.md +++ b/content/docs/1.6.1/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.6.2/deploy/important-notes/index.md b/content/docs/1.6.2/deploy/important-notes/index.md index 75bdb768e..f38c0afe8 100644 --- a/content/docs/1.6.2/deploy/important-notes/index.md +++ b/content/docs/1.6.2/deploy/important-notes/index.md @@ -16,6 +16,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Engine Upgrade Enforcement](#engine-upgrade-enforcement) - [Danger Zone Setting Configuration](#danger-zone-setting-configuration) - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [V2 Data Engine](#v2-data-engine) - [Longhorn System Upgrade](#longhorn-system-upgrade) - [Changing Default Huge Page Size to 2 GiB](#changing-default-huge-page-size-to-2-gib) @@ -203,6 +204,12 @@ spec: ``` From this version, you need to add group id 6 to the security context or run container as root. For more information, see [Longhorn PVC ownership and permission](../../nodes-and-volumes/volumes/pvc-ownership-and-permission) +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + ## V2 Data Engine ### Longhorn System Upgrade diff --git a/content/docs/1.6.2/deploy/upgrade/_index.md b/content/docs/1.6.2/deploy/upgrade/_index.md index aefe21864..6cc76e6a6 100644 --- a/content/docs/1.6.2/deploy/upgrade/_index.md +++ b/content/docs/1.6.2/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.6.3/deploy/important-notes/index.md b/content/docs/1.6.3/deploy/important-notes/index.md index d2501f98a..c0e04a517 100644 --- a/content/docs/1.6.3/deploy/important-notes/index.md +++ b/content/docs/1.6.3/deploy/important-notes/index.md @@ -17,6 +17,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Danger Zone Setting Configuration](#danger-zone-setting-configuration) - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) - [Minimum XFS Filesystem Size](#minimum-xfs-filesystem-size) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [V2 Data Engine](#v2-data-engine) - [Longhorn System Upgrade](#longhorn-system-upgrade) - [Changing Default Huge Page Size to 2 GiB](#changing-default-huge-page-size-to-2-gib) @@ -218,6 +219,12 @@ Longhorn v{{< current-version >}} does not allow the following: However, Longhorn still allows the listed actions when cloning or restoring volumes created with earlier Longhorn versions. +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + ## V2 Data Engine ### Longhorn System Upgrade diff --git a/content/docs/1.6.3/deploy/upgrade/_index.md b/content/docs/1.6.3/deploy/upgrade/_index.md index aefe21864..6cc76e6a6 100644 --- a/content/docs/1.6.3/deploy/upgrade/_index.md +++ b/content/docs/1.6.3/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.6.4/deploy/important-notes/index.md b/content/docs/1.6.4/deploy/important-notes/index.md index 48fb561e0..c93b8efec 100644 --- a/content/docs/1.6.4/deploy/important-notes/index.md +++ b/content/docs/1.6.4/deploy/important-notes/index.md @@ -18,6 +18,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) - [Minimum XFS Filesystem Size](#minimum-xfs-filesystem-size) - [Backup Data On The Remote Backup Server Might Be Deleted](#backup-data-on-the-remote-backup-server-might-be-deleted) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [V2 Data Engine](#v2-data-engine) - [Longhorn System Upgrade](#longhorn-system-upgrade) - [Changing Default Huge Page Size to 2 GiB](#changing-default-huge-page-size-to-2-gib) @@ -233,6 +234,12 @@ Starting with v{{< current-version >}}, Longhorn handles backup-related custom r For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + ## V2 Data Engine ### Longhorn System Upgrade diff --git a/content/docs/1.6.4/deploy/upgrade/_index.md b/content/docs/1.6.4/deploy/upgrade/_index.md index aefe21864..6cc76e6a6 100644 --- a/content/docs/1.6.4/deploy/upgrade/_index.md +++ b/content/docs/1.6.4/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.7.0/deploy/upgrade/_index.md b/content/docs/1.7.0/deploy/upgrade/_index.md index f89508755..45f27f7a6 100644 --- a/content/docs/1.7.0/deploy/upgrade/_index.md +++ b/content/docs/1.7.0/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.7.0/important-notes/_index.md b/content/docs/1.7.0/important-notes/_index.md index 072146fbb..2f4a1606e 100644 --- a/content/docs/1.7.0/important-notes/_index.md +++ b/content/docs/1.7.0/important-notes/_index.md @@ -16,6 +16,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Minimum XFS Filesystem Size](#minimum-xfs-filesystem-size) - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) - [Container-Optimized OS Support](#container-optimized-os-support) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [Resilience](#resilience) - [RWX Volumes Fast Failover](#rwx-volumes-fast-failover) - [Timeout Configuration for Replica Rebuilding and Snapshot Cloning](#timeout-configuration-for-replica-rebuilding-and-snapshot-cloning) @@ -161,6 +162,12 @@ From this version, you need to add group id 6 to the security context or run con Starting with Longhorn v1.7.0, Longhorn supports Container-Optimized OS (COS), providing robust and efficient persistent storage solutions for Kubernetes clusters running on COS. For more information, see [Container-Optimized OS (COS) Support](../advanced-resources/os-distro-specific/container-optimized-os-support/). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../advanced-resources/backing-image/backing-image). + ## Resilience ### RWX Volumes Fast Failover diff --git a/content/docs/1.7.1/deploy/upgrade/_index.md b/content/docs/1.7.1/deploy/upgrade/_index.md index 2da0240b5..ad63598d1 100644 --- a/content/docs/1.7.1/deploy/upgrade/_index.md +++ b/content/docs/1.7.1/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.7.1/important-notes/_index.md b/content/docs/1.7.1/important-notes/_index.md index 6e2095118..1c07f96ca 100644 --- a/content/docs/1.7.1/important-notes/_index.md +++ b/content/docs/1.7.1/important-notes/_index.md @@ -14,6 +14,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Minimum XFS Filesystem Size](#minimum-xfs-filesystem-size) - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) - [Container-Optimized OS Support](#container-optimized-os-support) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [Resilience](#resilience) - [RWX Volumes Fast Failover](#rwx-volumes-fast-failover) - [Timeout Configuration for Replica Rebuilding and Snapshot Cloning](#timeout-configuration-for-replica-rebuilding-and-snapshot-cloning) @@ -143,6 +144,12 @@ From this version, you need to add group id 6 to the security context or run con Starting with Longhorn v1.7.0, Longhorn supports Container-Optimized OS (COS), providing robust and efficient persistent storage solutions for Kubernetes clusters running on COS. For more information, see [Container-Optimized OS (COS) Support](../advanced-resources/os-distro-specific/container-optimized-os-support/). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../advanced-resources/backing-image/backing-image). + ## Resilience ### RWX Volumes Fast Failover diff --git a/content/docs/1.7.2/deploy/upgrade/_index.md b/content/docs/1.7.2/deploy/upgrade/_index.md index 2da0240b5..ad63598d1 100644 --- a/content/docs/1.7.2/deploy/upgrade/_index.md +++ b/content/docs/1.7.2/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.7.2/important-notes/_index.md b/content/docs/1.7.2/important-notes/_index.md index 5b1443874..e244ca3b3 100644 --- a/content/docs/1.7.2/important-notes/_index.md +++ b/content/docs/1.7.2/important-notes/_index.md @@ -14,6 +14,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Minimum XFS Filesystem Size](#minimum-xfs-filesystem-size) - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) - [Container-Optimized OS Support](#container-optimized-os-support) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [Resilience](#resilience) - [RWX Volumes Fast Failover](#rwx-volumes-fast-failover) - [Timeout Configuration for Replica Rebuilding and Snapshot Cloning](#timeout-configuration-for-replica-rebuilding-and-snapshot-cloning) @@ -145,6 +146,12 @@ From this version, you need to add group id 6 to the security context or run con Starting with Longhorn v1.7.0, Longhorn supports Container-Optimized OS (COS), providing robust and efficient persistent storage solutions for Kubernetes clusters running on COS. For more information, see [Container-Optimized OS (COS) Support](../advanced-resources/os-distro-specific/container-optimized-os-support/). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../advanced-resources/backing-image/backing-image). + ## Resilience ### RWX Volumes Fast Failover diff --git a/content/docs/1.7.3/deploy/upgrade/_index.md b/content/docs/1.7.3/deploy/upgrade/_index.md index 2da0240b5..ad63598d1 100644 --- a/content/docs/1.7.3/deploy/upgrade/_index.md +++ b/content/docs/1.7.3/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.7.3/important-notes/_index.md b/content/docs/1.7.3/important-notes/_index.md index 15d3454f9..dfb101e47 100644 --- a/content/docs/1.7.3/important-notes/_index.md +++ b/content/docs/1.7.3/important-notes/_index.md @@ -15,6 +15,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode) - [Container-Optimized OS Support](#container-optimized-os-support) - [Upgrade Check Events](#upgrade-check-events) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [Resilience](#resilience) - [RWX Volumes Fast Failover](#rwx-volumes-fast-failover) - [Timeout Configuration for Replica Rebuilding and Snapshot Cloning](#timeout-configuration-for-replica-rebuilding-and-snapshot-cloning) @@ -149,6 +150,12 @@ Starting with Longhorn v1.7.0, Longhorn supports Container-Optimized OS (COS), p ### Upgrade Check Events Longhorn performs a pre-upgrade check when upgrading with Helm or Rancher App Marketplace. If a check fails, the upgrade will stop and the reason for the check's failure will be recorded in an event. For more detail, see [Upgrading Longhorn Manager](../deploy/upgrade/longhorn-manager). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../advanced-resources/backing-image/backing-image). + ## Resilience ### RWX Volumes Fast Failover diff --git a/content/docs/1.8.0/deploy/upgrade/_index.md b/content/docs/1.8.0/deploy/upgrade/_index.md index f89508755..45f27f7a6 100644 --- a/content/docs/1.8.0/deploy/upgrade/_index.md +++ b/content/docs/1.8.0/deploy/upgrade/_index.md @@ -32,6 +32,12 @@ The following table outlines the supported upgrade paths. [^lastMinorVersion]: Longhorn only allows upgrades from any patch version of the last minor release before the new major version. For example, if v1.3.0 is the last minor version before v2.0, you can upgrade from any patch version of v1.3.0 to any patch version of v2.0. +## Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../../advanced-resources/backing-image/backing-image). + # Upgrading Longhorn There are normally two steps in the upgrade process: first upgrade Longhorn manager to the latest version, then manually upgrade the Longhorn engine to the latest version using the latest Longhorn manager. diff --git a/content/docs/1.8.0/important-notes/_index.md b/content/docs/1.8.0/important-notes/_index.md index dd85876b7..d460896a4 100644 --- a/content/docs/1.8.0/important-notes/_index.md +++ b/content/docs/1.8.0/important-notes/_index.md @@ -10,6 +10,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current - [Environment Check Script](#environment-check-script) - [General](#general) - [Upgrade Check Events](#upgrade-check-events) + - [Manual Checks Before Upgrade](#manual-checks-before-upgrade) - [Install/Upgrade with Helm Controller](#installupgrade-with-helm-controller) - [Automatic Expansion of RWX Volumes](#automatic-expansion-of-rwx-volumes) - [Resilience](#resilience) @@ -35,6 +36,12 @@ The functionality of the [environment check script](https://github.com/longhorn/ ### Upgrade Check Events Longhorn performs a pre-upgrade check when upgrading with Helm or Rancher App Marketplace. If a check fails, the upgrade will stop and the reason for the check's failure will be recorded in an event. For more detail, see [Upgrading Longhorn Manager](../deploy/upgrade/longhorn-manager). +### Manual Checks Before Upgrade +Automated checks are only performed on some upgrade paths, and the pre-upgrade checker may not cover some scenarios. Manual checks, performed using either kubectl or the UI, are recommended for these schenarios. You can take mitigating actions or defer the upgrade until issues are addressed. +- Ensure that all V2 Data Engine volumes are detached and the replicas are stopped. The V2 Data Engine currently does not support live upgrades. +- Avoid upgrading when volumes are in the "Faulted" status. If all the replicas are deemed unusable, they may be deleted and data may be permanently lost (if no usable backups exist). +- Avoid upgrading if a failed BackingImage exists. For more information, see [Backing Image](../advanced-resources/backing-image/backing-image). + ### Install/Upgrade with Helm Controller Longhorn also supports installation or upgrade via the HelmChart controller built into RKE2 and K3s. It allows management in a CRD YAML chart of most of the options that would normally be passed to the `helm` command-line tool. For more details on how it works, see [Install with Helm Controller](../deploy/install/install-with-helm-controller).