Skip to content

Commit d4c254b

Browse files
committed
📚 Sync docs from alaudadevops/tektoncd-operator on 35ba952dfbc3aafa0cda22b01ee0868ed455a5eb
Source: chore: sync from release-4.1(6f953) (#216) Author: l-qing Ref: refs/heads/main Commit: 35ba952dfbc3aafa0cda22b01ee0868ed455a5eb This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/tektoncd-operator@35ba952 🤖 Synced on 2025-07-15 05:55:52 UTC
1 parent 4bbe7b8 commit d4c254b

File tree

8 files changed

+1439
-700
lines changed

8 files changed

+1439
-700
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 09:18:17 UTC
3+
- **Last synced**: 2025-07-15 05:55:52 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [40f6c8755d6c858cb92086b18bfbfbf4b3733a5f](https://github.com/alaudadevops/tektoncd-operator/commit/40f6c8755d6c858cb92086b18bfbfbf4b3733a5f)
6-
- **Triggered by**: lentil1016
7-
- **Workflow run**: [#11](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16216475919)
5+
- **Source commit**: [35ba952dfbc3aafa0cda22b01ee0868ed455a5eb](https://github.com/alaudadevops/tektoncd-operator/commit/35ba952dfbc3aafa0cda22b01ee0868ed455a5eb)
6+
- **Triggered by**: l-qing
7+
- **Workflow run**: [#16](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16285294447)
88

99
## Files synced:
1010
- docs/
Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 30
2+
weight: 35
33
---
44

55
# Lifecycle Policy
@@ -8,22 +8,34 @@ weight: 30
88

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

11-
| Alauda DevOps Pipelines Version | Tekton Component Versions | Release Date | End of Support |
12-
| :----: | ------------------------ | :----------: | :--------------: |
13-
| v4.1.z | Pipelines: v0.65.z<br />Chains: v0.23.z<br />Pipelines-as-Code: v0.32.z<br />Results: v0.13.z<br />Triggers: v0.30.z<br />Tekton Hub: v1.19.z | 2025-?-? | 2026-?-? |
11+
| Alauda DevOps Pipelines Version | Release Date | End of Support | Version Type |
12+
| :----: | :----------: | :--------------: | :----: |
13+
| v4.2.x | 2025-08-? | 2026-08-? | LTS |
14+
| v4.1.x | 2025-07-14 | 2025-11-14 | Non-LTS |
15+
| v4.0.x | 2025-04-08 | 2026-04-08 | LTS |
16+
17+
> For detailed component versions in each version, see the [Compatibility and support matrix](./release_notes.mdx#compatibility-and-support-matrix)
1418
1519
## Release Policy
1620

17-
The `Alauda DevOps Pipelines` operator releases a new version every four to six months, updating the operator to the latest or second latest [LTS](https://github.com/tektoncd/community/blob/main/releases.md#support-policy) version officially released by Tekton.
21+
A new minor version of the `Alauda DevOps Pipelines` operator is released every month.
22+
23+
Within every 4-month period, the last minor version will be selected as a Long Term Support (LTS) version. LTS versions are supported for 12 months, while non-LTS versions are supported four months.
24+
25+
During these four months, we will update to the latest or second [LTS](https://github.com/tektoncd/community/blob/main/releases.md#support-policy) version officially released by Tekton.
1826

1927
## Maintenance Policy
2028

21-
Alauda provides 12 months of maintenance support for each released version of the Tekton operator.
29+
Alauda provides comprehensive maintenance support for the `Alauda DevOps Pipelines` operator with different support durations based on version type.
2230

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

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

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

docs/en/overview/release_notes.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,28 @@ title: Release Notes
1010
# Release Notes
1111

1212
::: tip
13-
The maintenance period for version **v4.1.z** is from ? ?, 2025 to ? ?, 2026.
13+
The maintenance period for version **v4.2.x** is from ? ?, 2025 to ? ?, 2026.
1414
:::
1515

1616
## Compatibility and support matrix
1717

1818
The following table shows the compatibility and support matrix between the `Alauda DevOps Pipelines` operator and ACP versions.
1919

20-
| Alauda DevOps Pipelines Version | Tekton Component Versions | ACP Version |
21-
| :------: | ------------------------- | :----------: |
22-
| v4.1.z | Pipelines: v0.65.5<br />Chains: v0.23.0<br />Pipelines-as-Code: v0.32.0<br />Results: v0.13.2<br />Triggers: v0.30.1<br />Tekton Hub: v1.19.2 | v4.0, v4.1 |
20+
| Alauda DevOps Pipelines Version | Component Version | | | | | | ACP Version |
21+
|:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|
22+
| **Operator** | **Pipelines** | **Triggers** | **CLI** | **Chains** | **Hub** | **Results** | |
23+
| 4.2.x (LTS) | ? | ? | ? | ? | ? | ? | 4.0 |
24+
| 4.1.x | 0.65.x | 0.30.x | 0.39.x | 0.23.x | 1.19.x | 0.14.x | 4.0 |
25+
| 4.0.x (LTS) | 0.65.x | 0.30.x | 0.39.x | 0.23.x | 1.19.x | 0.13.x | 4.0 |
2326

24-
## v4.1.0
27+
## v4.2.0
2528

2629
### New and Optimized Features
2730

28-
TODO: Add new features and optimizations for v4.1.0
29-
3031
### Fixed Issues
3132

32-
{/* release-notes-for-bugs?template=fixed&project=DEVOPS&version=v4.1 (next) */}
33+
{/* release-notes-for-bugs?template=fixed&project=DEVOPS&version=v4.2(next) */}
3334

3435
### Known Issues
3536

36-
{/* release-notes-for-bugs?template=unfixed&project=DEVOPS&version=v4.1 (next) */}
37-
37+
{/* release-notes-for-bugs?template=unfixed&project=DEVOPS&version=v4.2(next) */}

docs/en/upgrade/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
weight: 245
3+
---
4+
5+
# Upgrade
6+
7+
<Overview />

docs/en/upgrade/upgrade.mdx

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
weight: 20
3+
---
4+
5+
# Upgrade `Alauda DevOps Pipelines` Operator
6+
7+
This document provides instructions for upgrading the `Alauda DevOps Pipelines` Operator to a newer version using the `Marketplace`/`OperatorHub` interface in your cluster. The upgrade process is designed to be straightforward while ensuring minimal disruption to existing Tekton resources.
8+
9+
## Upgrade Overview
10+
11+
Upgrading the `Alauda DevOps Pipelines` Operator allows you to access new features, bug fixes, and improvements to the Tekton ecosystem. The `Alauda DevOps Pipelines` Operator handles the upgrade of all Tekton components (Pipelines, Triggers, Hub, etc.) according to your configuration.
12+
13+
## Before You Begin
14+
15+
Before upgrading the `Alauda DevOps Pipelines` Operator, ensure you:
16+
17+
- Have administrative access to your cluster
18+
- Review the release notes for the new version to understand any breaking changes
19+
- Verify that your existing Tekton component configurations are compatible with the new version
20+
- Confirm that all Tekton components are in a ready state
21+
22+
## Upgrade Process
23+
24+
### Using `Marketplace`/`OperatorHub`
25+
26+
1. **Access the `Marketplace`/`OperatorHub`**
27+
- Log in to your cluster's management console
28+
- Navigate to the `Marketplace` or `OperatorHub` section
29+
30+
2. **Locate the `Alauda DevOps Pipelines` Operator**
31+
- Search for `Alauda DevOps Pipelines` in the search bar
32+
- Click on the `Alauda DevOps Pipelines` card
33+
34+
3. **View Available Versions**
35+
- On the `Alauda DevOps Pipelines` Operator details page, you'll see information about the currently installed version
36+
- The interface will indicate if a newer version is available
37+
- You can click different `Channels` to view all available versions
38+
39+
4. **Initiate the Upgrade**
40+
- If the target version is in a different `Channel`, switch to the corresponding `Channel` in the `Subscription` first
41+
- If the current `Channel` has a newer version available, you will see a prompt:
42+
- **New Version Detected**
43+
- To upgrade only the current Operator, click `Confirm` to upgrade.
44+
45+
5. **Configure Upgrade Settings (if applicable)**
46+
- Some upgrades may present configuration options
47+
- In most cases, the default settings will preserve your existing configuration
48+
49+
6. **Confirm and Start the Upgrade**
50+
- Click `Confirm` to begin the process
51+
- Review the upgrade details and confirm your selection
52+
- The system will update the `Alauda DevOps Pipelines` Operator while maintaining your custom resources
53+
54+
7. **Monitor the Upgrade**
55+
- The upgrade progress will be displayed in the `OperatorHub` interface
56+
- You can also check the status in the `tekton-operator` namespace:
57+
```bash
58+
$ kubectl get pods -n tekton-operator
59+
```
60+
When all pods are in `Running` state, the operator upgrade is complete.
61+
The operator will then automatically upgrade components such as `Pipelines`, `Triggers`, `Hub`, `Chains`, etc.
62+
- Check the components upgrade status:
63+
```bash
64+
$ kubectl get tektoninstallerset -A
65+
$ kubectl get pods -n tekton-pipelines
66+
```
67+
When all components and pods are in `Ready` state, the components upgrade is complete.
68+
69+
8. **Verify the Upgrade**
70+
- Check that the `Alauda DevOps Pipelines` Operator version has been updated:
71+
```bash
72+
$ kubectl get csv -n tekton-operator
73+
74+
NAME DISPLAY VERSION REPLACES PHASE
75+
tektoncd-operator.v4.x.x Alauda DevOps Pipelines 4.x.x x Succeeded
76+
```
77+
When the `VERSION` matches the new version, the upgrade is complete.
78+
- Verify that your Tekton components are functioning correctly
79+
- Test that your pipelines can run successfully
80+
81+
## Post-Upgrade Steps
82+
83+
After the upgrade completes successfully:
84+
85+
1. **Verify Component Status**
86+
- Check that all Tekton components have been updated:
87+
```bash
88+
kubectl get tektonconfig,tektonpipeline,tektontrigger -A
89+
kubectl get tektoninstallerset -A
90+
```
91+
92+
2. **Test Functionality**
93+
- Run a simple pipeline to verify that the system is working correctly
94+
- Ensure that all existing integrations continue to function
95+
96+
3. **Update Custom Resources if Needed**
97+
- If the new version introduces changes to CRDs, you may need to update your custom resources
98+
- Refer to the release notes for specific migration steps
99+
100+
## Rollback Procedure
101+
102+
If you encounter issues with the new version, you can roll back to the previous version:
103+
104+
1. Return to the `Marketplace`/`OperatorHub` interface
105+
2. Select the `Alauda DevOps Pipelines` Operator
106+
3. `Uninstall` the current version
107+
4. Choose the previous version from the version list
108+
5. Follow the installation process for that version
109+
110+
:::note
111+
Downgrading may require additional steps to ensure compatibility of your resources with the older version.
112+
113+
This depends on the differences between the version you upgraded from and the version you upgraded to. If the differences are large, you may need to manually migrate resources.
114+
:::
115+
116+
## Troubleshooting
117+
118+
If you encounter issues during or after the upgrade:
119+
120+
- Check the `Alauda DevOps Pipelines` Operator pod logs:
121+
```bash
122+
$ kubectl logs -l name=tekton-operator -n tekton-operator
123+
```
124+
125+
- Verify the status of your Tekton resources:
126+
```bash
127+
$ kubectl get tektonconfig config -o yaml
128+
```
129+
130+
- Ensure that all components have the expected status:
131+
```bash
132+
$ kubectl get tektoninstallerset
133+
```
134+
135+
## Next Steps
136+
137+
After successfully upgrading the `Alauda DevOps Pipelines` Operator:
138+
139+
- Explore new features introduced in the latest version
140+
- Update your CI/CD pipelines to leverage new capabilities
141+
- Consider enabling additional components that may be available in the new version

docs/en/upgrade/upgrade_path.mdx

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+
| pipelines-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.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"devDependencies": {
3-
"@alauda/doom": "^1.7.1",
3+
"@alauda/doom": "^1.9.1",
44
"typescript": "^5.8.3"
55
},
66
"scripts": {

0 commit comments

Comments
 (0)