Alauda AI

Install Workbench

Starting with v0.2.0, Workbench is delivered as an independent OLM Helm operator. Install the Alauda AI Workbench Operator and create a Workbench custom resource (CR) to deploy Workbench.

TOC

Version CompatibilityPrerequisitesInstall the Workbench operatorCreate the Workbench custom resourceVerification

Version Compatibility

Use a compatible Alauda AI and Workbench version pair:

Workbench versionCompatible Alauda AI versionNotes
v0.2.0v2.8.1Alauda AI Operator (aml-operator) v2.8.1 automatically corrects the v0.2.0 Workbench-CR namespace issue.
v0.2.2v2.5.0 and later (>= v2.5.0)Workbench v0.2.2 is compatible with Alauda AI v2.5.0 and later.

Prerequisites

  • A compatible Alauda AI version is installed on the target cluster. See Install Alauda AI.
  • The target cluster has sufficient resources for Workbench workloads.
  • Optional: Alauda Service Mesh (Istio) is required only for the Elyra Kubeflow Pipelines run-URL redirect. Istio integration is disabled by default.

Install the Workbench operator

In Administrator view:

  1. Open Marketplace > OperatorHub.
  2. Select the target cluster and open Alauda AI Workbench Operator.
  3. Select the version of the operator that you uploaded, then install it.
  4. Wait for the operator to become ready.

Create the Workbench custom resource

After the Workbench operator is ready, open its All Instances tab and create a Workbench instance in the kubeflow namespace. Do not create the CR in the aml-operator namespace or in another namespace.

Alternatively, you can create the resource with kubectl:

apiVersion: workbench.alauda.io/v1alpha1
kind: Workbench
metadata:
  name: workbench
  namespace: kubeflow
spec:
  global:
    istio:
      enabled: false

Save the manifest as workbench.yaml, then apply it:

kubectl apply -f workbench.yaml

Set spec.global.istio.enabled to true only when the target cluster runs Alauda Service Mesh and you need Elyra-generated KFP run URLs to redirect through the Kubeflow Istio ingress gateway.

NOTE

For Workbench v0.2.0, aml-operator v2.8.1 automatically repairs an existing Workbench CR that was created outside the required kubeflow namespace. Create new Workbench CRs in kubeflow so that the installation is correct from the start.

Verification

Check the Workbench CR status:

kubectl -n kubeflow get workbench workbench

The resource should report that it is ready. You can also verify the Workbench resources created by the operator:

# The Workbench instance is in the required namespace.
kubectl -n kubeflow get workbench

# The workspace controller is available.
kubectl -n kubeflow get deploy workspace-controller-controller-manager

# Built-in IDE templates are registered.
kubectl get workspacekind

After the deployment is ready, open Alauda AI and confirm that Workbench appears and that you can open the Workbench list.