Skip to content

Commit f83fb4a

Browse files
authored
docs: update ACP 4.3 upgrade guidance (#622)
* docs: update ACP 4.3 upgrade guidance * docs: clarify cluster plugin lifecycle wording --------- Co-authored-by: MeoK <12069138+chinameok@users.noreply.github.com>
1 parent 6ebf9be commit f83fb4a

5 files changed

Lines changed: 62 additions & 17 deletions

File tree

docs/en/extend/cluster_plugin.mdx

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Plugins are published via the **violet** tool. Note:
2727
To view all plugins provided by the platform:
2828

2929
1. Navigate to the platform management view.
30-
2. Click the left navigation menu: **Administrator** > **Marketplace** > **Cluster Plugin**
30+
2. Click the left navigation menu: **Administrator** > **Marketplace** > **Cluster Plugins**
3131

3232
This page lists all available plugins along with their current status.
3333

@@ -255,6 +255,20 @@ Field explanations are the same as non-config.
255255

256256

257257

258+
## Cluster plugin life cycle values
259+
260+
The **Cluster Plugins** page uses the `cpaas.io/lifecycle-type` label to indicate how a cluster plugin is maintained and upgraded. If the label is absent, the plugin is treated as `Agnostic`.
261+
262+
In this context, `Core` means the plugin follows the ACP Core release and upgrade cycle together with the cluster Distribution Version.
263+
264+
The **Cluster Plugins** list page shows a **Life cycle** column and provides a **Life cycle** filter so you can quickly identify each plugin type.
265+
266+
| Life cycle | Description | Upgrade path |
267+
| --- | --- | --- |
268+
| `Core` | The plugin follows the ACP Core release and upgrade cycle together with the cluster Distribution Version and does not support standalone upgrade. | Upgrade the cluster to update the plugin. |
269+
| `Aligned` | The plugin follows the ACP release stream but can still be updated independently when a newer plugin version is published. | Upgrade the plugin from the Cluster Plugins list page or details page. |
270+
| `Agnostic` | The plugin is released independently from ACP. | Upgrade the plugin from the Cluster Plugins list page or details page. |
271+
258272
## Upgrade Process
259273

260274
To upgrade an existing plugin to a newer version:
@@ -270,10 +284,20 @@ To upgrade an existing plugin to a newer version:
270284
* Switch to the **Cluster Plugin** tab
271285
* The plugin details will show the newly uploaded version
272286

273-
3. Perform the upgrade:
287+
3. Review the plugin:
288+
289+
* Navigate to **Administrator** > **Marketplace** > **Cluster Plugins**
290+
* Select the target cluster
291+
* Review the plugin from the list page or open the plugin details page
292+
293+
4. Perform the upgrade:
294+
295+
* If the plugin uses the `Aligned` or `Agnostic` life cycle, start the standalone upgrade from the list page or details page
296+
* The platform upgrades the installed plugin to a newer published version
297+
298+
5. Handle `Core` plugins:
299+
300+
* `Core` plugins do not support standalone upgrades
301+
* When a newer version is detected, the plugin details page shows a reminder to upgrade the cluster instead
274302

275-
* Navigate to **Administrator** > **Clusters** > **Clusters**
276-
* Clusters with upgradable plugins will display an upgrade icon
277-
* Enter the cluster details and switch to the **Features** tab
278-
* The upgrade button will be enabled under the features component
279-
* Click **Upgrade** to complete the plugin upgrade
303+
**Note:** `Upgrade` changes the installed plugin version. `Update` remains a plugin-specific action for changing configuration or running plugin-defined update logic.

docs/en/overview/release_notes.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ ACP CLI also introduces upgrade-oriented administrator commands such as `ac adm
3232

3333
For operational guidance, see [Upgrade](/upgrade/index.mdx).
3434

35+
#### Standalone Cluster Plugin Upgrade
36+
37+
ACP 4.3 adds standalone upgrade support for cluster plugins that use the `Aligned` or `Agnostic` life cycle.
38+
39+
The **Cluster Plugins** page now shows the plugin life cycle, and eligible plugins can be upgraded independently from the list page or details page. `Core` plugins continue to follow cluster upgrades.
40+
3541
#### MicroOS-Based Global Clusters on Huawei DCS
3642

3743
ACP 4.3 allows administrators to create the `global` cluster on Huawei DCS with MicroOS-based immutable infrastructure. This extends the immutable operating model from workload clusters to platform installation scenarios on DCS.

docs/en/upgrade/overview.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ weight: 10
55

66
ACP 4.3 uses a Cluster Version Operator (CVO)-based workflow for cluster upgrades.
77

8+
In the Web Console, the upgrade request now follows a two-step flow: review RPCH items first, and then submit the upgrade request in a separate confirmation step.
9+
810
When moving the platform to a new ACP Distribution Version, the upgrade normally proceeds in two stages:
911

1012
1. Upgrade the global tier to the target Distribution Version by following the validated global-cluster procedure, including artifact preparation and preflight checks.
@@ -17,16 +19,16 @@ A workload cluster can be upgraded only to a Distribution Version that the globa
1719
- **ClusterVersionShadow (`cvsh`)**: The upgrade resource used to track current version, desired version, preflight results, execution stages, and history.
1820
- **Distribution Version**: The ACP version currently reached by a cluster. A workload cluster can be upgraded only to a Distribution Version that the global tier has already reached.
1921
- **Preflight**: Validation checks that run before the upgrade starts applying the target version. For workload clusters, review preflight results from the upgrade status output after the upgrade request is submitted.
20-
- **Available upgrade targets**: The upgrade versions that are currently offered for a cluster. For workload clusters, target versions are typically offered only after the global tier has already reached the same Distribution Version.
22+
- **Available upgrade targets**: The upgrade versions that are currently offered for a cluster. In the Web Console, the target version for the current upgrade flow is determined by the platform.
2123
- **upgrade.sh**: The preparation script that uploads artifacts and deploys or updates the cluster version operator before the upgrade proceeds.
2224
- **Global DR environment**: An environment with both a primary global cluster and a standby global cluster.
2325
- **Primary global cluster**: The global cluster that the platform access domain currently resolves to.
2426
- **Standby global cluster**: The other global cluster in the DR pair. After a failover, the roles of the two clusters are swapped.
2527

2628
## Upgrade Entry Points
2729

28-
- **Global clusters**: Follow the validated `upgrade.sh`-based procedure. After the preparation phase completes, request the upgrade from the Web Console, use ACP CLI, or update `ClusterVersionShadow.spec.desiredUpdate` directly.
29-
- **Workload clusters**: Use the Web Console or ACP CLI after the target version becomes available for the workload cluster.
30+
- **Global clusters**: Follow the validated `upgrade.sh`-based procedure. After the preparation phase completes, request the upgrade from the Web Console through the two-step RPCH review flow, use ACP CLI, or update `ClusterVersionShadow.spec.desiredUpdate` directly.
31+
- **Workload clusters**: Use the Web Console through the two-step RPCH review flow or use ACP CLI after the target Distribution Version becomes available for the workload cluster.
3032

3133
## Related Documentation
3234

docs/en/upgrade/upgrade_global_cluster.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,16 @@ After the preparation phase completes, choose one of the following entry points:
134134
* Patch `ClusterVersionShadow.spec.desiredUpdate` directly when you need to operate the underlying CVO resource.
135135
* Use ACP CLI to request the upgrade for `global` explicitly.
136136

137+
If you use the Web Console, the request follows a two-step flow:
138+
139+
* In **Step 1**, review the RPCH list.
140+
* Click **Acknowledge** to continue to **Step 2**.
141+
* In **Step 2**, review **Current Version** and **Target Version**. The page does not display a plugin list or a warning panel at this stage.
142+
* The target version is determined by the prepared upgrade artifacts and cannot be selected manually in the Web Console.
143+
* Click **Start Upgrade**.
144+
* Confirm the action in the dialog.
145+
* After confirmation, the page shows that the upgrade request has been submitted and the action enters an in-progress state.
146+
137147
`kubectl` example:
138148

139149
```bash

docs/en/upgrade/upgrade_workload_cluster.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ ACP 4.3 uses the same CVO-based workflow for workload clusters as for the `globa
1919

2020
Before requesting the upgrade, verify that:
2121

22+
* The workload cluster version is lower than the current `global` cluster version.
2223
* The global tier has already reached the target ACP Distribution Version.
2324
* In global DR environments, both the standby and primary global clusters have already reached that target Distribution Version.
24-
* The target version is available for the workload cluster.
2525

2626
### Run preflight checks
2727

@@ -44,18 +44,21 @@ For preflight block handling patterns, see [Handle preflight blocks when needed]
4444

4545
### Request the upgrade
4646

47-
After preflight passes and the target version is available for the workload cluster, choose one of the following entry points:
47+
After preflight passes, choose one of the following entry points:
4848

49-
* Request the target version from the Web Console on the workload cluster details page.
49+
* Start the upgrade from the workload cluster in the Web Console.
5050
* Use ACP CLI when your current ACP session can access the target workload cluster. To avoid ambiguity, specify the target cluster explicitly with `--cluster`.
5151

5252
If you are new to ACP CLI, see [Getting Started with ACP CLI](/ui/cli_tools/ac/getting-started.md). For session and cluster selection, see [Managing CLI Profiles](/ui/cli_tools/ac/managing-cli-profiles.md).
5353

54-
Web Console path:
54+
If you use the Web Console, the request follows a two-step flow:
5555

56-
```text
57-
Administrator > Clusters > Clusters > <workload cluster> > Functional Components
58-
```
56+
* In **Step 1**, review the RPCH list.
57+
* Click **Acknowledge** to continue to **Step 2**.
58+
* In **Step 2**, review **Current Version** and **Target Version**. The page does not display a plugin list or a warning panel at this stage.
59+
* The target version is the current `global` cluster version and cannot be selected manually in the Web Console.
60+
* Click **Start Upgrade**.
61+
* After the request is submitted, the page shows that the upgrade request has been submitted and the action enters an in-progress state.
5962

6063
ACP CLI example:
6164

0 commit comments

Comments
 (0)