|
| 1 | +--- |
| 2 | +weight: 10 |
| 3 | +--- |
| 4 | + |
| 5 | +# Upgrade Path |
| 6 | + |
| 7 | +:::note |
| 8 | +**Important** |
| 9 | + |
| 10 | +This document provides the upgrade path principles and supported version compatibility for `Alauda DevOps Pipelines` Operator. |
| 11 | +For detailed upgrade instructions, please refer to the [Upgrade `Alauda DevOps Pipelines` Operator](./upgrade.mdx). |
| 12 | +::: |
| 13 | + |
| 14 | +## Overview |
| 15 | + |
| 16 | +The `Alauda DevOps Pipelines` Operator follows specific upgrade path principles to ensure compatibility and stability during version transitions. |
| 17 | + |
| 18 | +### Version Types |
| 19 | + |
| 20 | +- **LTS (Long-Term Support) versions**: `4.0.x`, `4.2.x`, `4.6.x`, `4.10.x` - Recommended for production environments |
| 21 | +- **Non-LTS (Short-term) versions**: `4.1.x`, `4.3.x`, `4.5.x`, `4.7.x`, `4.9.x` - For early feature access |
| 22 | + |
| 23 | +### Upgrade Principles |
| 24 | + |
| 25 | +- Upgrades are supported between LTS versions, with the longest supported upgrade path skipping up to two intermediate LTS versions. For example: |
| 26 | + - A direct LTS upgrade: `4.0.x (LTS)` β `4.2.x (LTS)` |
| 27 | + - Longest supported upgrade range: `4.0.x (LTS)` β `4.10.x (LTS)` (skipping `4.2.x (LTS)` and `4.6.x (LTS)`) |
| 28 | +- Upgrades from non-LTS versions are only supported to the next immediate LTS version. For example: |
| 29 | + - `4.3.x` β `4.6.x (LTS)` is supported |
| 30 | + - `4.3.x` β `4.10.x (LTS)` is not supported |
| 31 | +- **Version Compatibility**: Patch versions within the same minor version are fully compatible |
| 32 | +- **Component Cohesion**: All Tekton components are upgraded together to maintain compatibility |
| 33 | + |
| 34 | +## Upgrade Paths |
| 35 | + |
| 36 | +### `Alauda DevOps Pipelines` v4.1.0 |
| 37 | + |
| 38 | +This upgrade path has been tested with `Alauda DevOps Pipelines` Operator version v4.1.0 and ACP version 4.0.3 (the latest LTS patch version available during testing) |
| 39 | + |
| 40 | +| Channel version | ACP version | Kubernetes version | |
| 41 | +|:---------------:|:-----------:|:------------------:| |
| 42 | +| release-4.0 | 4.0.3 | 1.31.6 | |
| 43 | + |
| 44 | +## Prerequisites |
| 45 | + |
| 46 | +Before initiating an upgrade, please ensure the following: |
| 47 | + |
| 48 | +1. **Version Compatibility**: Your current version falls within a supported upgrade path. |
| 49 | +2. **Component Health**: All Tekton components are in a `Ready` state. |
| 50 | +3. **Resource Availability**: The cluster has sufficient resources to support the upgrade process. |
| 51 | + |
| 52 | +## Upgrade Path Guidelines |
| 53 | + |
| 54 | +### LTS-to-LTS Upgrade Paths |
| 55 | + |
| 56 | +Upgrading between Long-Term Support (LTS) versions is recommended for production environments. We support both standard and extended upgrade paths as described below: |
| 57 | + |
| 58 | +- **Primary Path**: **Previous LTS β Current LTS** |
| 59 | + - *Description*: A direct upgrade from the immediately preceding LTS version. |
| 60 | + - *Testing Status*: All patch versions tested; latest patch versions receive comprehensive regression testing. |
| 61 | + - *Example*: `4.0.x (LTS)` β `4.2.x (LTS)` |
| 62 | + |
| 63 | +- **Extended Path**: **Up to two LTS versions back β Current LTS** |
| 64 | + - *Description*: A direct upgrade path skipping up to two intermediate LTS versions. |
| 65 | + - *Testing Status*: All patch versions tested; latest patch versions validated through extended testing. |
| 66 | + - *Example*: `4.0.x (LTS)` β `4.10.x (LTS)` (skipping `4.2.x (LTS)` and `4.6.x (LTS)`) |
| 67 | + |
| 68 | +- **Maintenance Path**: **Non-LTS (still in maintenance) β Current LTS** |
| 69 | + - *Description*: Direct upgrade from a non-LTS version still under active maintenance. |
| 70 | + - *Testing Status*: Limited testing scope; theoretically supported. |
| 71 | + - *Use Case*: For teams looking to upgrade directly from non-LTS environments while staying within support boundaries. |
| 72 | + |
| 73 | +### Upgrades to Non-LTS Versions |
| 74 | + |
| 75 | +When upgrading to a non-LTS release, the following paths are available for environments that need faster access to new features: |
| 76 | + |
| 77 | +- **Primary Path**: **Previous LTS β Current non-LTS** |
| 78 | + - *Description*: A direct upgrade from the latest LTS version. |
| 79 | + - *Testing Status*: All patch versions tested; latest patch versions receive comprehensive regression testing. |
| 80 | + - *Example*: `4.0.x (LTS)` β `4.1.x (non-LTS)` |
| 81 | + |
| 82 | +- **Extended Path**: **Two LTS versions back β Current non-LTS** |
| 83 | + - *Description*: A direct upgrade path skipping up to two intermediate LTS versions. |
| 84 | + - *Testing Status*: All patch versions tested; latest patch versions receive comprehensive regression testing. |
| 85 | + - *Use Case*: For users aiming to minimize the number of upgrade hops. |
| 86 | + - *Example*: `4.0.x (LTS)` β `4.7.x (non-LTS)` (skipping `4.2.x (LTS)` and `4.6.x (LTS)`) |
| 87 | + |
| 88 | +- **Maintenance Path**: **Non-LTS (still in maintenance) β Current non-LTS** |
| 89 | + - *Description*: Upgrade path for non-LTS versions still under support. |
| 90 | + - *Testing Status*: Limited testing scope; theoretically supported. |
| 91 | + - *Use Case*: For teams rapidly adopting new features from non-LTS releases. |
| 92 | + |
| 93 | +### Patch-Level Compatibility |
| 94 | + |
| 95 | +- **Within the Same Minor Version**: Patch upgrades (e.g., `4.0.1` β `4.0.3`) are completely compatible. |
| 96 | +- **Testing Strategy**: All patch versions within the same minor version are supported for upgrades. The latest patch version undergoes comprehensive regression testing, while earlier patch versions receive limited testing. |
| 97 | +- **Recommendation**: For production stability, we recommend upgrading to the latest patch release before initiating any major or minor version upgrade. |
| 98 | +- **Example**: While `4.0.1`, `4.0.2`, and `4.0.3` may all be eligible for upgrade to `4.1.x`, only the latest (`4.0.3`) is fully tested and validated. |
| 99 | + |
| 100 | +## Upgrade Process Reference |
| 101 | + |
| 102 | +For complete upgrade instructions, including step-by-step procedures, backup guidance, and troubleshooting: |
| 103 | + |
| 104 | +- π **[General Upgrade Guide](./upgrade.mdx)**: Comprehensive documentation for the upgrade process. |
| 105 | +- π **[Release Notes](../overview/release_notes.mdx)**: Version-specific updates, breaking changes, and new features. |
0 commit comments