Upgrade

Migrating from the Workbench Cluster Plugin

Starting with v0.2.0, Workbench is delivered as an OLM Helm operator instead of a Cluster Plugin. There is no in-place upgrade between these forms.

  1. Back up the existing Workbench resources:

    kubectl get workspacekinds,workspaces -A -o yaml > workbench-backup.yaml
  2. In Administrator > Marketplace > Cluster Plugins, uninstall the earlier Workbench cluster plugin. Preserve user PVCs, retained WorkspaceKind resources, and the aml-workbench-config ConfigMap; the operator adopts or reapplies these resources.

  3. Enable Workbench by setting spec.components.workbench.managementState to Managed in the default AmlCluster. Alauda AI installs and manages the Workbench Operator and its resources; do not create a Workbench custom resource manually. For the normal installation path, see Install Workbench.

  4. Verify the existing Workspaces and their PVCs are still present, then create and connect to a test Workbench.

If the previous installation relied on the Elyra KFP run-URL redirect, set spec.components.workbench.values.global.istio.enabled: true in the default AmlCluster. Istio integration is optional and disabled by default.

Migrating from Kubeflow Notebook

Workbench is NOT compatible with "Kubeflow Notebook" (Alauda AI <= 1.3). You need to create new "workbench" instances, the "Kubeflow Notebook" will be moved to "Advanced - Kubeflow" in the left navigation bar.

WARNING

We recommend moving to Workbench because "Kubeflow Notebook" will be deprecated in upcoming upstream Kubeflow releases.

NOTE

You can keep the PVCs used by "Kubeflow Notebook" instances in Alauda AI 1.3. Delete the Notebook instance and mount the PVC into new Workbench instances so data in your Notebook instance remains available. (NOTE Data in the container will be lost, just as when you've used pip install to install packages to the system instead of a virtual environment.)

Procedure

  1. Log in and open the Alauda AI page.
  2. Go to Workbench to open the list.
  3. Click Create and fill in the required fields.
  4. In Home Directory, select the PVC used by the previous Notebook.