Skip to content

Commit 9b311ad

Browse files
committed
πŸ“š Sync docs from alaudadevops/tektoncd-operator on 12d51820e10eedb971f26ee983479c3d9eccd2f6
Source: docs: add upgrade path documentation (#210) Author: l-qing Ref: refs/heads/release-4.1 Commit: 12d51820e10eedb971f26ee983479c3d9eccd2f6 This commit automatically syncs documentation changes from the source-docs repository. πŸ”— View source commit: AlaudaDevops/tektoncd-operator@12d5182 πŸ€– Synced on 2025-07-12 05:31:28 UTC
1 parent afff422 commit 9b311ad

File tree

4 files changed

+125
-16
lines changed

4 files changed

+125
-16
lines changed

β€Ž.github/SYNC_INFO.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2025-07-11 10:00:14 UTC
3+
- **Last synced**: 2025-07-12 05:31:28 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [5dfce6070a942c49ecdaba66b9e1551404f72792](https://github.com/alaudadevops/tektoncd-operator/commit/5dfce6070a942c49ecdaba66b9e1551404f72792)
6-
- **Triggered by**: lentil1016
7-
- **Workflow run**: [#12](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16217299572)
5+
- **Source commit**: [12d51820e10eedb971f26ee983479c3d9eccd2f6](https://github.com/alaudadevops/tektoncd-operator/commit/12d51820e10eedb971f26ee983479c3d9eccd2f6)
6+
- **Triggered by**: l-qing
7+
- **Workflow run**: [#13](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16234824150)
88

99
## Files synced:
1010
- docs/

β€Ždocs/en/overview/lifecycle_policy.mdxβ€Ž

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ weight: 35
88

99
Below is the lifecycle schedule for released versions of the `Alauda DevOps Pipelines` operator:
1010

11-
| Alauda DevOps Pipelines Version | Release Date | End of Support |
12-
| :----: | :----------: | :--------------: |
13-
| v4.1.x | 2025-07-14 | 2025-11-14 |
14-
| v4.0.x (LTS) | 2025-04-08 | 2026-04-08 |
11+
| Alauda DevOps Pipelines Version | Release Date | End of Support | Version Type |
12+
| :----: | :----------: | :--------------: | :----: |
13+
| v4.1.x | 2025-07-14 | 2025-11-14 | Non-LTS |
14+
| v4.0.x | 2025-04-08 | 2026-04-08 | LTS |
1515

16-
> For detailed component versions, see the [Compatibility and support matrix](./release_notes.mdx#compatibility-and-support-matrix)
16+
> For detailed component versions in each version, see the [Compatibility and support matrix](./release_notes.mdx#compatibility-and-support-matrix)
1717
1818
## Release Policy
1919

@@ -25,12 +25,16 @@ During these four months, we will update to the latest or second [LTS](https://g
2525

2626
## Maintenance Policy
2727

28-
Alauda provides maintenance support for 12 months for LTS versions and 4 months for non-LTS versions of the Tekton operator.
28+
Alauda provides comprehensive maintenance support for the `Alauda DevOps Pipelines` operator with different support durations based on version type.
2929

30-
During the maintenance period, Alauda will provide the following services to customers:
30+
| Version Type | Support Duration | Examples |
31+
|:------------:|:----------------:|:--------:|
32+
| LTS (Long Term Support) | 12 months | 4.0.x |
33+
| Non-LTS | 4 months | 4.1.x |
3134

32-
1. Track the patch versions released by Tekton and promptly provide patches containing bug fixes and security updates.
33-
2. Provide security updates that comply with Alauda's security standards.
34-
3. Assist customers in smoothly upgrading the Tekton operator to new versions.
35+
During the maintenance period, Alauda provides the following services:
3536

36-
Additionally, Alauda will release a security update every two months during the maintenance period to ensure the security and stability of the operator.
37+
1. **Security Updates**: Regular security patches and updates that comply with Alauda's security standards
38+
2. **Bug Fixes**: Prompt delivery of bug fixes from upstream Tekton releases
39+
3. **Upgrade Assistance**: Support for smooth operator upgrades to newer versions
40+
4. **Regular Maintenance**: Security updates released every two months to ensure stability

β€Ždocs/en/upgrade/upgrade.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 10
2+
weight: 20
33
---
44

55
# Upgrade `Alauda DevOps Pipelines` Operator
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
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

Comments
Β (0)