Skip to content

chore: add upgrade workbench AI-23623 #94

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
EdisonSu768 merged 1 commit into from
Feb 9, 2026
Merged

chore: add upgrade workbench AI-23623 #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
117 changes: 105 additions & 12 deletions docs/en/upgrade/upgrade-from-previous-version.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
weight: 10
---

export const prevVersion = "1.4";
export const curVer = "1.5";
export const prevVersion = '1.4'
export const curVer = '1.5'

# Upgrade Alauda AI
# Upgrade Alauda AI

:::info
Upgrade from {prevVersion} to {curVer}
Expand All @@ -23,8 +23,6 @@ Please ignore `Creating Alauda AI Cluster Instance` since we are upgrading **Ala
2. [Uploading](../installation/ai-cluster.mdx#uploading) operator bundle packages to the destination cluster.
3. To upgrade, follow the process described below.



## Upgrading

The following procedure describes how to upgrade from **Alauda AI** {prevVersion} to {curVer}.
Expand All @@ -45,16 +43,100 @@ After the upgrade is complete, please confirm that the status of **Alauda AI Ess

The procedure for upgrading both operators is nearly identical, with only the target component being different.

| Step | Alauda AI Operator | Alauda AI Model Serving Operator |
| :--- | :--- | :--- |
| Step | Alauda AI Operator | Alauda AI Model Serving Operator |
|:----------------|:--------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------|
| **1. Navigate** | Log into the Web Console, then go to **Marketplace > OperatorHub** in the **Administrator** view. | Log into the Web Console, then go to **Marketplace > OperatorHub** in the **Administrator** view. |
| **2. Select** | Select your target **cluster**. | Select your target **cluster**. |
| **3. Click** | Click the **Alauda AI** card. | Click the **Alauda AI Model Serving** card. |
| **4. Confirm** | Click **Confirm** on the upgrade prompt. | Click **Confirm** on the upgrade prompt. |
| **2. Select** | Select your target **cluster**. | Select your target **cluster**. |
| **3. Click** | Click the **Alauda AI** card. | Click the **Alauda AI Model Serving** card. |
| **4. Confirm** | Click **Confirm** on the upgrade prompt. | Click **Confirm** on the upgrade prompt. |

:::info
Once the new version is uploaded and recognized by the platform, an upgrade prompt will appear at the top of the operator's page.
:::

### Upgrading Cluster Plugins

:::info
This step is **only required if you have deployed** any of the following cluster plugins: **Alauda AI Workbench**, **Alauda AI MLflow**, or **Alauda AI Volcano**. If you have not deployed any of these plugins, you can skip this step.

For more information about cluster plugins, refer to <ExternalSiteLink name="acp" href="extend/index.html" children="Alauda Container Platform - Extend" />.
:::

The procedure to upgrade cluster plugins involves uploading new version packages and then upgrading them from the Web Console. The following plugins require upgrading:

- Alauda AI Workbench
- Alauda AI MLflow
- Alauda AI Volcano

#### Uploading Cluster Plugins

Upload the new cluster plugin packages to the global cluster. For detailed instructions on how to upload cluster plugins, refer to <ExternalSiteLink name="acp" href="extend/upload_package.html#upload-a-cluster-plugin" children="Uploading Cluster Plugins" />.

Repeat the upload process for each plugin that you have deployed.

:::info
After the upload is completed, wait approximately 10–15 minutes for the platform to synchronize the new version information.
:::

#### Verifying the New Version

Navigate to **Administrator > Marketplace > Upload Packages** and switch to the **Cluster Plugin** tab. Locate each uploaded plugin to verify that the new version is displayed.

#### Upgrading from Web Console

1. Navigate to **Administrator > Clusters > Clusters**.
2. Click on the cluster where the plugins are deployed.
3. Switch to the **Functional Components** tab in the cluster details page.
4. Locate the cluster plugins that have available upgrades—an upgrade icon will be displayed next to them.
5. Click the **Upgrade** button for the plugin you want to upgrade.
6. Review the upgrade information in the popup window, confirm the plugin version to be upgraded, and click the **Upgrade** button to start the upgrade process.

Repeat this process for each plugin that you have deployed.

:::info
Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Features** tab of the cluster details page.
:::
Comment on lines +96 to +98
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Potential inconsistency in tab name reference.

Line 89 refers to the "Functional Components tab" but line 97 mentions the "Features tab". Please verify these are the correct tab names or if they should be consistent.

Suggested fix if they should be the same 
 :::info
-Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Features** tab of the cluster details page.
+Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Functional Components** tab of the cluster details page.
 :::
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:::info
Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Features** tab of the cluster details page.
:::
:::info
Once the new version is uploaded and recognized by the platform, the **Upgrade** button will become available for each plugin on the **Functional Components** tab of the cluster details page.
:::
🤖 Prompt for AI Agents 
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 96 - 98, The
documentation currently uses two different tab names ("Functional Components"
and "Features") — check the actual UI to confirm the correct tab label and make
them consistent; update the text in upgrade-from-previous-version.mdx to use the
verified tab name in both places (replace the "Functional Components" mention or
the "Features" mention accordingly) and ensure any surrounding context (e.g.,
"cluster details page" or "Features tab of the cluster details page") matches
the UI wording exactly.


### Enabling Fine-Tuning and Training Features

:::info
Once the new version is uploaded and recognized by the platform, an upgrade prompt will appear at the top of the operator's page.
This step is **required if you want to use** the fine-tuning and training features in the upgraded version. If you do not need these features, you can skip this step.

For detailed information about fine-tuning and training features, refer to <ExternalSiteLink name="acp" href="installation/fine-tuning.html" children="Enable Fine-Tuning and Training Features" />.
:::

To enable the fine-tuning and training features, you need to configure the `AmlCluster` resource by setting the `pretrain` and `tuneModels` flags to `true`.

1. Navigate to **Administrator > Clusters > Resources**.
2. Enter `amlcluster` in the search box on the left side.
3. Click the **Correlated with Cluster** panel to find the `AmlCluster` resource named `default`.
4. Edit the resource and set `pretrain` and `tuneModels` to `true` under `spec.values.experimentalFeatures`.

```yaml
apiVersion: amlclusters.aml.dev/v1alpha2
kind: AmlCluster
metadata:
name: default
spec:
values:
experimentalFeatures:
pretrain: true #[!code callout]
tuneModels: true #[!code callout]
```

<Callouts>
1. When set to `true`, the **Training** item appears in the left navigation
menu. 2. When set to `true`, the **Fine-Tuning** item appears in the left
navigation menu.
</Callouts>
Comment on lines +127 to +131
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Awkward line breaks in Callouts content.

The numbered items inside the <Callouts> component have line breaks in the middle of sentences, making them hard to read. The text "menu. 2." on line 129 shows where item 1 ends and item 2 begins mid-line.

Suggested formatting fix 
 <Callouts>
-  1. When set to `true`, the **Training** item appears in the left navigation
-  menu. 2. When set to `true`, the **Fine-Tuning** item appears in the left
-  navigation menu.
+  1. When set to `true`, the **Training** item appears in the left navigation menu.
+  2. When set to `true`, the **Fine-Tuning** item appears in the left navigation menu.
 </Callouts>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Callouts>
1. When set to `true`, the **Training** item appears in the left navigation
menu. 2. When set to `true`, the **Fine-Tuning** item appears in the left
navigation menu.
</Callouts>
<Callouts>
1. When set to `true`, the **Training** item appears in the left navigation menu.
2. When set to `true`, the **Fine-Tuning** item appears in the left navigation menu.
</Callouts>
🤖 Prompt for AI Agents 
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 127 - 131,
The text inside the Callouts component has awkward mid-sentence breaks; update
the content of the <Callouts> block so each numbered item is a single continuous
line or use a proper ordered list (e.g., "1. When set to `true`, the
**Training** item appears in the left navigation menu." on its own line and "2.
When set to `true`, the **Fine-Tuning** item appears in the left navigation
menu." on the next line) to remove the "menu. 2." break and improve readability.


:::note
After enabling these features, ensure that the required cluster plugins are installed:

- **Volcano** cluster plugin for training job scheduling
- **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)
:::
Comment on lines +133 to +138
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Note block closing marker may be incorrectly indented.

The ::: closing marker on line 138 appears to be indented (preceded by spaces). In MDX, the closing fence should typically start at the beginning of the line to properly close the admonition block. This could cause rendering issues.

Suggested fix 
 :::note
 After enabling these features, ensure that the required cluster plugins are installed:

 - **Volcano** cluster plugin for training job scheduling
 - **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)
-  :::
+:::
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:::note
After enabling these features, ensure that the required cluster plugins are installed:
- **Volcano** cluster plugin for training job scheduling
- **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)
:::
:::note
After enabling these features, ensure that the required cluster plugins are installed:
- **Volcano** cluster plugin for training job scheduling
- **MLflow** cluster plugin for training experiment monitoring (requires PostgreSQL)
:::
🤖 Prompt for AI Agents 
In `@docs/en/upgrade/upgrade-from-previous-version.mdx` around lines 133 - 138,
The closing admonition marker for the MDX note block (the `:::` that follows the
list mentioning Volcano and MLflow) is indented and may not close the block
correctly; remove any leading spaces so the closing `:::` starts at the
beginning of the line (no indentation) to properly terminate the `:::note`
block.


## Verification

<Steps>
Expand All @@ -71,7 +153,9 @@ Should returns `Ready`:
NAME READY REASON
default True Succeeded
```

### Alauda AI Model Serving

Check the status field from the `KnativeServing` resource which named `default-knative-serving`:

```bash
Expand All @@ -84,4 +168,13 @@ Should returns `InstallSuccessful`:
NAME DEPLOYED REASON
default-knative-serving True UpgradeSuccessful
```
</Steps>

### Alauda AI Cluster Plugins

In the **Administrator** view, navigate to **Marketplace > Cluster Plugins** and confirm that the following cluster plugins show `Installed` status with the new version:

- Alauda AI Workbench (if deployed)
- Alauda AI MLflow (if deployed)
- Alauda AI Volcano (if deployed)

</Steps>