Chapter 3. Installing and deploying OpenShift AI

Procedure

1. Open a new terminal window.

2. Follow these steps to log in to your OpenShift Container Platform cluster as a cluster administrator:

   1. In the upper-right corner of the OpenShift web console, click your user name and select Copy login command.
   2. After you have logged in, click Display token.

   3. Copy the Log in with this token command and paste it in the OpenShift command-line interface (CLI).

      $ oc login --token=<token> --server=<openshift_cluster_url>

3. Create a namespace for installation of the Operator by performing the following actions:

   1. Create a namespace YAML file, for example, rhods-operator-namespace.yaml.

      apiVersion: v1
      kind: Namespace
      metadata:
        name: redhat-ods-operator 1

      1

      redhat-ods-operator is the recommended namespace for the Operator.

   2. Create the namespace in your OpenShift Container Platform cluster.

      $ oc create -f rhods-operator-namespace.yaml

      You see output similar to the following:

      namespace/redhat-ods-operator created

4. Create an operator group for installation of the Operator by performing the following actions:

   1. Create an OperatorGroup object custom resource (CR) file, for example, rhods-operator-group.yaml.

      apiVersion: operators.coreos.com/v1
      kind: OperatorGroup
      metadata:
        name: rhods-operator
        namespace: redhat-ods-operator 1

      1

      You must specify the same namespace that you created earlier in this procedure.

   2. Create the OperatorGroup object in your OpenShift Container Platform cluster.

      $ oc create -f rhods-operator-group.yaml

      You see output similar to the following:

      operatorgroup.operators.coreos.com/rhods-operator created

5. Create a subscription for installation of the Operator by performing the following actions:

   1. Create a Subscription object CR file, for example, rhods-operator-subscription.yaml.

      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: rhods-operator
        namespace: redhat-ods-operator 1
      spec:
        name: rhods-operator
        channel: stable 2
        source: redhat-operators
        sourceNamespace: openshift-marketplace

      1

      You must specify the same namespace that you created earlier in this procedure.

      2

      For channel, select a value of fast, stable, stable-x.y eus-x.y, or alpha. For more information about selecting an update channel, see Understanding update channels.

   2. Create the Subscription object in your OpenShift Container Platform cluster to install the Operator.

      $ oc create -f rhods-operator-subscription.yaml

      You see output similar to the following:

      subscription.operators.coreos.com/rhods-operator created

Procedure

1. Log in to the OpenShift Container Platform web console as a cluster administrator.
2. In the web console, click Operators OperatorHub.
3. On the OperatorHub page, locate the Red Hat OpenShift AI Operator by scrolling through the available Operators or by typing Red Hat OpenShift AI into the Filter by keyword box.
4. Click the Red Hat OpenShift AI tile. The Red Hat OpenShift AI information pane opens.
5. Select a Channel. For information about subscription update channels, see Understanding update channels.
6. Select a Version.
7. Click Install. The Install Operator page opens.
8. Review or change the selected channel and version as needed.
9. For Installation mode, note that the only available value is All namespaces on the cluster (default). This installation mode makes the Operator available to all namespaces in the cluster.
10. For Installed Namespace, select Operator recommended Namespace: redhat-ods-operator.

11. For Update approval, select one of the following update strategies:

    • Automatic: New updates in the update channel are installed as soon as they become available.

    • Manual: A cluster administrator must approve any new updates before installation begins.

      Important

      By default, the Red Hat OpenShift AI Operator follows a sequential update process. This means that if there are several versions between the current version and the target version, Operator Lifecycle Manager (OLM) upgrades the Operator to each of the intermediate versions before it upgrades it to the final, target version.

      If you configure automatic upgrades, OLM automatically upgrades the Operator to the latest available version. If you configure manual upgrades, a cluster administrator must manually approve each sequential update between the current version and the final, target version.

      For information about supported versions, see Red Hat OpenShift AI Life Cycle.

12. Click Install.

    The Installing Operators pane appears. When the installation finishes, a checkmark appears next to the Operator name.

Procedure

1. Open a new terminal window.

2. Follow these steps to log in to your OpenShift Container Platform cluster as a cluster administrator:

   1. In the upper-right corner of the OpenShift web console, click your user name and select Copy login command.
   2. After you have logged in, click Display token.

   3. Copy the Log in with this token command and paste it in the OpenShift command-line interface (CLI).

      $ oc login --token=<token> --server=<openshift_cluster_url>

3. Create a DataScienceCluster object custom resource (CR) file, for example, rhods-operator-dsc.yaml.

   apiVersion: datasciencecluster.opendatahub.io/v1
   kind: DataScienceCluster
   metadata:
     name: default-dsc
   spec:
     components:
       codeflare:
         managementState: Removed
       dashboard:
         managementState: Removed
       datasciencepipelines:
         managementState: Removed
       kserve:
         managementState: Removed 1 2
       kueue:
         managementState: Removed
       modelmeshserving:
         managementState: Removed
       ray:
         managementState: Removed
       workbenches:
         managementState: Removed

   1

   To fully install the KServe component, which is used by the single-model serving platform to serve large models, you must install Operators for Red Hat OpenShift Service Mesh and Red Hat OpenShift Serverless and perform additional configuration. See Serving large models.

   2

   If you have not enabled the KServe component (that is, you set the value of the managementState field to Removed), you must also disable the dependent Service Mesh component to avoid errors. See Disabling KServe dependencies.

4. In the spec.components section of the CR, for each OpenShift AI component shown, set the value of the managementState field to either Managed or Removed. These values are defined as follows:

   Managed

   The Operator actively manages the component, installs it, and tries to keep it active. The Operator will upgrade the component only if it is safe to do so.

   Removed

   The Operator actively manages the component but does not install it. If the component is already installed, the Operator will try to remove it.

   Important
   • To learn how to fully install the KServe component, which is used by the single-model serving platform to serve large models, see Serving large models.
   • To learn how to configure the distributed workloads feature that uses the CodeFlare, KubeRay, and Kueue components, see Configuring distributed workloads.

5. Create the DataScienceCluster object in your OpenShift Container Platform cluster to install the specified OpenShift AI components.

   $ oc create -f rhods-operator-dsc.yaml

   You see output similar to the following:

   datasciencecluster.datasciencecluster.opendatahub.io/default created

Procedure

1. Log in to the OpenShift Container Platform web console as a cluster administrator.
2. In the web console, click Operators Installed Operators and then click the Red Hat OpenShift AI Operator.

3. Create a DataScienceCluster object to install OpenShift AI components by performing the following actions:

   1. Click the Data Science Cluster tab.
   2. Click Create DataScienceCluster.

   3. For Configure via, select YAML view.

      An embedded YAML editor opens showing a default custom resource (CR) for the DataScienceCluster object.

   4. In the spec.components section of the CR, for each OpenShift AI component shown, set the value of the managementState field to either Managed or Removed. These values are defined as follows:

      Managed

      The Operator actively manages the component, installs it, and tries to keep it active. The Operator will upgrade the component only if it is safe to do so.

      Removed

      The Operator actively manages the component but does not install it. If the component is already installed, the Operator will try to remove it.

      Important
      • To learn how to install the KServe component, which is used by the single-model serving platform to serve large models, see Serving large models.
      • If you have not enabled the KServe component (that is, you set the value of the managementState field to Removed), you must also disable the dependent Service Mesh component to avoid errors. See Disabling KServe dependencies.
      • To learn how to configure the distributed workloads feature that uses the CodeFlare and KubeRay components, see Configuring distributed workloads.
4. Click Create.

Procedure

1. Log in to the OpenShift Container Platform web console as a cluster administrator.
2. In the web console, click Operators Installed Operators and then click the Red Hat OpenShift AI Operator.
3. Click the Data Science Cluster tab.
4. On the DataScienceClusters page, click the default object.

5. Click the YAML tab.

   An embedded YAML editor opens showing the custom resource (CR) file for the DataScienceCluster object.

6. In the spec.components section of the CR, for each OpenShift AI component shown, set the value of the managementState field to either Managed or Removed. These values are defined as follows:

   Note

   If a component shows with the component-name: {} format in the spec.components section of the CR, the component is not installed.

   Managed

   The Operator actively manages the component, installs it, and tries to keep it active. The Operator will upgrade the component only if it is safe to do so.

   Removed

   The Operator actively manages the component but does not install it. If the component is already installed, the Operator will try to remove it.

   Important
   • To learn how to install the KServe component, which is used by the single-model serving platform to serve large models, see Serving large models.
   • If you have not enabled the KServe component (that is, you set the value of the managementState field to Removed), you must also disable the dependent Service Mesh component to avoid errors. See Disabling KServe dependencies.

   • If they are not already present in the CR file, you can install the CodeFlare, KubeRay, and Kueue components by adding the codeflare, ray, and kueue entries to the spec.components section of the CR and setting the managementState field for the components to Managed.
   • To learn how to configure the distributed workloads feature that uses the CodeFlare, KubeRay, and Kueue components, see Configuring distributed workloads.

7. Click Save.

   For any components that you updated, OpenShift AI initiates a rollout that affects all pods to use the updated image.

Procedure

1. Log in to the OpenShift web console as a cluster administrator.
2. In the web console, click Operators Installed Operators and then click the Red Hat OpenShift AI Operator.

3. Disable the OpenShift Service Mesh component as follows:

   1. Click the DSC Initialization tab.
   2. Click the default-dsci object.
   3. Click the YAML tab.

   4. In the spec section, add the serviceMesh component (if it is not already present) and configure the managementState field as shown:

      spec:
       serviceMesh:
         managementState: Removed

   5. Click Save.

Verification

1. In the web console, click Operators Installed Operators and then click the Red Hat OpenShift AI Operator.

   The Operator details page opens.

2. In the Conditions section, confirm that there is no ReconcileComplete condition with a status value of Unknown.

Procedure

1. Log in to the OpenShift Container Platform as a cluster administrator.
2. Click Operators Installed Operators and then click the Red Hat OpenShift AI Operator.
3. Click the DSC Initialization tab.
4. Click the default-dsci object.
5. Click the YAML tab.

6. In the spec section, update the .spec.devFlags.logmode flag with the log level that you want to set.

   apiVersion: dscinitialization.opendatahub.io/v1
   kind: DSCInitialization
   metadata:
     name: default-dsci
   spec:
     devFlags:
       logmode: development

7. Click Save.