Skip to content

update docs: Revise the DevOps upgrade/migration strategy document fo… #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tik-seven merged 7 commits into from
Dec 15, 2025
Merged

update docs: Revise the DevOps upgrade/migration strategy document fo… #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a4d144b
update docs: Revise the DevOps upgrade/migration strategy document fo…
inerlooe Dec 12, 2025
d0c3315
docs: revise the DevOps upgrade/migration strategy document for upgra…
inerlooe Dec 14, 2025
e1b900b
Fix document format.
inerlooe Dec 15, 2025
9ed5898
Fix document format.
inerlooe Dec 15, 2025
ed71d87
Fix document format.
inerlooe Dec 15, 2025
6a48492
Fix document format.
inerlooe Dec 15, 2025
faf1f42
docs: revise the DevOps upgrade/migration strategy document for upgra…
inerlooe Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions docs/en/upgrade/migrating-devops-v3-to-v4.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,21 @@ sourceSHA: 03b11615a739095db87029e6b3ad9b9986a42c6033f4d265744147def3832b5a

# Migrating Alauda DevOps to Alauda DevOps (Next-Gen)

This guide details the upgrade strategy and procedures for `Alauda DevOps` to `Alauda DevOps (Next-Gen)` when migrating from `Alauda Container Platform` `v3.18` or `v4.0` to `v4.1`.
This guide details the upgrade strategy and procedures for `Alauda DevOps` to `Alauda DevOps (Next-Gen)`, Suitable for `ACP` upgrade scenarios:

## Prerequisites

### Upgrade ACP Platform
- `v3.18` --> `v4.0`
- `v3.18` --> `v4.1`
- `v4.0` --> `v4.1`

First, upgrade the `ACP` platform to version `v4.1`. For detailed instructions, refer to <ExternalSiteLink name="container_platform" href="upgrade/overview.html" children="Upgrading Container Platform" />.
## Prerequisites

### Upgrade Alauda DevOps to v3.20

Before migration, ensure that `Alauda DevOps` is upgraded to version `v3.20`. This step is required for compatibility and successful migration to `Alauda DevOps (Next-Gen)`. Please refer to [Upgrading Alauda DevOps to v3.20](./upgrading-devops-v3.mdx)



## Migrating Alauda DevOps

Starting from **ACP v4.1**, the following **Alauda DevOps v3** operators will no longer be maintained, so completing the migration on **ACP v4.1** is necessary.
Starting from **ACP v4.1**, the following **Alauda DevOps v3** operators will no longer be maintained. Therefore, migrating these operators is required.

| Operator | Status |
| -------------------------- | ----------- |
Expand Down Expand Up @@ -49,7 +47,7 @@ The `.z` in version numbers indicates the latest available patch version for tha

:::

2. Navigate to the **CLI Tools** section in the **Alauda Customer Portal** and download the `violet` tool to upload Operators to`ACP`, For specific operation steps, refer to <ExternalSiteLink name="container_platform" href="ui/cli_tools/#downloading-the-tool" children="Uploading Operators" />.
2. Navigate to the **CLI Tools** section in the **Alauda Customer Portal** and download the `violet` tool to upload Operators to`ACP`. For specific operation steps, refer to <ExternalSiteLink name="container_platform" href="ui/cli_tools/#downloading-the-tool" children="Uploading Operators" />

### Migrating Alauda DevOps

Expand All @@ -65,4 +63,17 @@ Please refer to the following documents for migrating each operator:

## Next Steps

You have now completed the migration from `Alauda DevOps` to `Alauda DevOps (Next Generation)`. In `Alauda DevOps (Next Gen)`, if you want to use the updated version for each Operator, you can further learn how to upgrade to the updated version in each operator's documentation.
You have now completed the migration from `Alauda DevOps` to `Alauda DevOps (Next-Gen)`. In `Alauda DevOps (Next-Gen)`, if you want to use the updated version for each Operator, you can further learn how to upgrade to the updated version in each operator's documentation.

::: warning

**Important Restriction**

If you need to continue using the **Build** and **Release** features from **Alauda DevOps v3**, you must maintain `Alauda DevOps Pipelines` at version `v4.0.z`.

**Prohibited Actions**

**Do NOT upgrade** `Alauda DevOps Pipelines` beyond `v4.0.z` under any circumstances. Upgrading to versions above `v4.0.z` will cause irreversible compatibility issues with `katanomi`, potentially breaking existing **Build** and **Release** pipelines.

:::

88 changes: 62 additions & 26 deletions docs/en/upgrade/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,52 +9,88 @@ title: Overview

# Overview

When upgrading `Alauda Container Platform (ACP)` to `v4.1`, the upgrade strategy for `Alauda DevOps` depends on your current platform version. In all scenarios, migration to `Alauda DevOps (Next-Gen)` is **mandatory** to ensure platform **security**, **maintainability**, and compatibility with `ACP v4.1`.
This guide provides a detailed introduction to the upgrade/migration strategy of `Alauda DevOps` in the scenario of upgrading from `Alauda Container Platform (ACP)` `v4.0` or `v4.1` to `v4.2`.

# Upgrade Scenarios

<Tabs>
<Tab label="Upgrading from ACP v3.18">
<Tab label="Upgrading from ACP v4.0">

If your current `ACP` version is `v4.0`, the upgrade path for `Alauda DevOps` is as follows:

1. **Migrate to Alauda DevOps (Next-Gen)**

Before upgrading ACP, verify your current DevOps operator versions:

- If your operators do not match the [Alauda DevOps (Next-Gen) Version Matrix](#next-gen), you must perform migration by following [Migrating Alauda DevOps to Alauda DevOps (Next-Gen)](./migrating-devops-v3-to-v4.mdx).
- If you have already completed migration on `ACP` `v4.0` and your operators match the [Alauda DevOps (Next-Gen) Version Matrix](#next-gen), you may skip this step and proceed directly to ACP platform upgrade.

2. **Upgrade ACP Platform**

If your current ACP version is `v3.18` , the `Alauda DevOps` upgrade path includes **two required steps**:
Upgrade the `ACP` platform to version `v4.2`. For detailed instructions, refer to <ExternalSiteLink name="container_platform" href="upgrade/overview.html" children="Upgrading Container Platform" />.

1. **Upgrade `Alauda DevOps` to v3.20**
This version ensures compatibility with `ACP v4.1` and serves as the foundation for migration.
3. **Upgrade each operator to a newer version (optional)**

2. **Migrate `Alauda DevOps` to Alauda DevOps (Next-Gen)**
Migration to the next-generation architecture is required to maintain platform security and long-term support.
if you want to use the updated version for each Operator, you can further learn how to upgrade to the updated version in each operator's documentation, please refer to [Upgrade each operator to a newer version](#upgrade)

</Tab>

<Tab label="Upgrading from ACP v4.0">
<Tab label="Upgrading from ACP v4.1">

1. **Upgrade ACP Platform**

Before starting the upgrade of `ACP`, in `ACP` `v4.1`, the Migration `Alauda DevOps` to `Alauda DevOps (Next Gen)` should have been completed. Please confirm that the DevOps-related operator versions are consistent: [Alauda DevOps (Next-Gen) Version Matrix](#next-gen). If your operators do not match the **Version Matrix**, you must perform migration by following [Migrating Alauda DevOps to Alauda DevOps (Next-Gen)](./migrating-devops-v3-to-v4.mdx).

Upgrade the `ACP` platform to version `v4.2`. For detailed instructions, refer to <ExternalSiteLink name="container_platform" href="upgrade/overview.html" children="Upgrading Container Platform" />

2. **Upgrade each operator to a newer version (optional)**

If your current ACP version is `v4.0`, verify that `Alauda DevOps` has already been upgraded to **v3.20** before proceeding.
After confirming the version, you must **migrate to `Alauda DevOps (Next-Gen)`** to align with `ACP v4.1` requirements.
if you want to use the updated version for each Operator, you can further learn how to upgrade to the updated version in each operator's documentation, please refer to [Upgrade each operator to a newer version](#upgrade).

</Tab>
</Tabs>

# Why Migration Is Mandatory

Migration to `Alauda DevOps (Next-Gen)` is required for the following reasons:

1. Enhanced **security**, improved **maintainability**, and overall platform robustness.
2. Starting from **ACP v4.1**, the following `Alauda DevOps v3` Operators will reach **end-of-life** and will **no longer be maintained or deployable**:
## Ensure that Alauda DevOps has been migrated to Alauda DevOps (Next-Gen)

On `ACP` `v4.0` or `v4.1`, ensure that `Alauda DevOps` has already been migrated to `Alauda DevOps (Next-Gen)`. If your Alauda DevOps-related operators are at the versions listed below, you must perform the migration first. Please refer to [Migrating Alauda DevOps to Alauda DevOps (Next-Gen)](./migrating-devops-v3-to-v4.mdx)

### Alauda DevOps v3.20 version matrix before migration

| Alauda DevOps Operator | Operator Version | Tool Instance Version |
| -------------------------- | ---------------- | --------------------- |
| Alauda DevOps GitLab v3 | v3.20.z | v14.0.z |
| Alauda DevOps Nexus v3 | v3.20.z | v3.69.z |
| Alauda DevOps SonarQube v3 | v3.20.z | v9.9.z |
| Alauda DevOps Harbor v3 | v3.20.z | v2.6.z |
| Alauda DevOps Tekton v3 | v3.20.z | - |

### Alauda DevOps (Next-Gen) version matrix after migration \{#next-gen}

| Alauda DevOps Operator | Version |
| ------------------------------------------------------------ | --------- |
| Alauda DevOps Pipelines (replace `Alauda DevOps Tekton v3`) | v4.0.z |
| Alauda Build of Gitlab | v17.8.z |
| Alauda Build of Harbor | v2.12.z |
| Alauda Build of SonarQube | v2025.1.z |
| Alauda Build of Nexus | v3.76.z |

## Upgrade each operator to a newer version (optional) \{#upgrade}

You have now completed the migration from `Alauda DevOps` to `Alauda DevOps (Next-Gen)`. In `Alauda DevOps (Next-Gen)`, if you want to use the updated version for each Operator, you can further learn how to upgrade to the updated version in each operator's documentation.

::: warning

**Important Restriction**

If you need to continue using the **Build** and **Release** features from **Alauda DevOps v3**, you must maintain `Alauda DevOps Pipelines` at version `v4.0.z`.

| Operator Name | Status |
| -------------------------- | ----------- |
| Alauda DevOps Tekton v3 | End-of-life |
| Alauda DevOps GitLab v3 | End-of-life |
| Alauda DevOps Harbor v3 | End-of-life |
| Alauda DevOps SonarQube v3 | End-of-life |
| Alauda DevOps Nexus v3 | End-of-life |
**Prohibited Actions**

# Summary
**Do NOT upgrade** `Alauda DevOps Pipelines` beyond `v4.0.z` under any circumstances. Upgrading to versions above `v4.0.z` will cause irreversible compatibility issues with `katanomi`, potentially breaking existing **Build** and **Release** pipelines.

| Step | Description | Required |
| ------------------- | ------------------------------------------------------------ | -------- |
| Upgrade to v3.20 | Upgrade `Alauda DevOps` to version 3.20 to ensure compatibility with `ACP v4.1`. | ✅ Yes |
| Migrate to Next-Gen | Migrate to `Alauda DevOps (Next-Gen)` to enhance security and maintainability, and to meet ACP v4.1 requirements. | ✅ Yes |
:::

# References

Expand Down
14 changes: 8 additions & 6 deletions docs/en/upgrade/upgrading-devops-v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
---
weight: 29
weight: 31
sourceSHA: 03b11615a739095db87029e6b3ad9b9986a42c6033f4d265744147def3832b5a
---

# Upgrading Alauda DevOps to v3.20

This guide provides a detailed explanation of the strategy and steps for upgrading `Alauda DevOps` to `v3.20` when upgrading from `Alauda Container Platform` `v3.18` or `4.0` to `v4.1`.

This guide provides a detailed explanation of the strategy and steps for upgrading `Alauda DevOps` to `v3.20`, Suitable for `ACP` upgrade scenarios:

- `v3.18` --> `v4.0`
- `v3.18` --> `v4.1`
- `v4.0` --> `v4.1`

## Prerequisites

### Upgrade ACP Platform

First, Upgrade `Alauda Container Platform` platform from `v3.18` or `v4.0` to `v4.1`. For detailed instructions, refer to <ExternalSiteLink name="container_platform" href="upgrade/overview.html" children="Upgrading Container Platform" />.
Upgrade the `ACP` platform to version `v4.0` or `v4.1`. For detailed instructions, refer to <ExternalSiteLink name="container_platform" href="upgrade/overview.html" children="Upgrading Container Platform" />, Select the ACP document version you need to upgrade to.



Expand All @@ -37,7 +39,7 @@ Each Operator upgrade takes no more than 20 minutes.
| Alauda DevOps SonarQube v3 | v3.20.z | v9.9.z |
| Alauda DevOps Harbor v3 | v3.20.z | v2.6.z |
| Alauda DevOps Tekton v3 | v3.20.z | - |
| Devops Tool Operator (Required) | v3.20.z | - |
| Devops Tool (Required) | v3.20.z | - |
| Alauda DevOps v3 (Required) | v3.20.z | v0.11.z |
| Alauda DevOps Eventing v3 (Required) | v3.20.z | v1.10.z |
| Alauda DevOps Jenkins v3 (Required) | v3.20.z | v2.516.z |
Expand All @@ -53,7 +55,7 @@ Each Operator upgrade takes no more than 20 minutes.

:::note

- **For `DevOps Tool Operator`, `Alauda DevOps v3`, `Alaida DevOps Eventing v3`, and `Alauda DevOps Jenkins v3` , if it doesn't exist, please deploy it directly.**
- **For `DevOps Tool`, `Alauda DevOps v3`, `Alaida DevOps Eventing v3`, and `Alauda DevOps Jenkins v3` , if it doesn't exist, please deploy it directly.**
:::

### Upgrade Instance
Expand Down