Chapter 2. Deploying OpenShift AI in a disconnected environment

Read this section to understand how to deploy Red Hat OpenShift AI as a development and testing environment for data scientists in a disconnected environment. Disconnected clusters are on a restricted network, typically behind a firewall. In this case, clusters cannot access the remote registries where Red Hat provided OperatorHub sources reside. Instead, the Red Hat OpenShift AI Operator can be deployed to a disconnected environment using a private registry to mirror the images.

Installing OpenShift AI in a disconnected environment involves the following high-level tasks:

  1. Confirm that your OpenShift Container Platform cluster meets all requirements. See Requirements for OpenShift AI Self-Managed.
  2. Add administrative users for OpenShift Container Platform. See Adding administrative users for OpenShift Container Platform.
  3. Mirror images to a private registry. See Mirroring images to a private registry for a disconnected installation.
  4. Install the Red Hat OpenShift AI Operator. See Installing the Red Hat OpenShift AI Operator.
  5. Install OpenShift AI components. See Installing and managing Red Hat OpenShift AI components.
  6. Configure user and administrator groups to provide user access to OpenShift AI. See Adding users.
  7. Provide your users with the URL for the OpenShift Container Platform cluster on which you deployed OpenShift AI. See Accessing the OpenShift AI dashboard.

2.1. Requirements for OpenShift AI Self-Managed

Your environment must meet certain requirements to receive support for Red Hat OpenShift AI.

Installation requirements

You must meet the following requirements before you are able to install OpenShift AI on your Red Hat OpenShift Container Platform cluster.

  • Product subscriptions

    • A subscription for Red Hat OpenShift AI Self-Managed

      Contact your Red Hat account manager to purchase new subscriptions. If you do not yet have an account manager, complete the form at https://www.redhat.com/en/contact to request one.

  • An OpenShift Container Platform cluster 4.12 or greater

    • Use an existing cluster or create a new cluster by following the OpenShift Container Platform documentation: OpenShift Container Platform installation overview.

      Your cluster must have at least 2 worker nodes with at least 8 CPUs and 32 GiB RAM available for OpenShift AI to use when you install the Operator. To ensure that OpenShift AI is usable, additional cluster resources are required beyond the minimum requirements.

    • A default storage class that can be dynamically provisioned must be configured.

      Confirm that a default storage class is configured by running the oc get storageclass command. If no storage classes are noted with (default) beside the name, follow the OpenShift Container Platform documentation to configure a default storage class: Changing the default storage class. For more information about dynamic provisioning, see Dynamic provisioning.

    • Open Data Hub must not be installed on the cluster.

      For more information about managing the machines that make up an OpenShift cluster, see Overview of machine management.

  • An identity provider configured for OpenShift Container Platform

    Access to the cluster as a user with the cluster-admin role; the kubeadmin user is not allowed.

    Red Hat OpenShift AI supports the same authentication systems as Red Hat OpenShift Container Platform. See Understanding identity provider configuration for more information on configuring identity providers.

  • Internet access

    Along with Internet access, the following domains must be accessible to mirror images required for the OpenShift AI Self-Managed installation:

    For CUDA-based images, the following domains must be accessible:

  • Data science pipelines configuration

    • Before you can execute a pipeline in a disconnected environment, you must mirror any images used by your pipelines to a private registry.
    • You can store your pipeline artifacts in an Amazon Web Services (AWS) Simple Storage Service (S3) bucket to ensure that you do not consume local storage. To do this, you must first configure write access to your S3 bucket on your AWS account.

      If you do not have access to Amazon S3 storage, you must configure your own storage solution for use with pipelines.

  • Install KServe dependencies

    • To support the KServe component, which is used by the single-model serving platform to serve large models, you must also install Operators for Red Hat OpenShift Serverless and Red Hat OpenShift Service Mesh and perform additional configuration. For more information, see Serving large models.
    • If you want to add an authorization provider for the single-model serving platform, you must install the Red Hat - Authorino Operator. For information, see Adding an authorization provider for the single-model serving platform.

2.2. Adding administrative users for OpenShift Container Platform

Before you can install and configure OpenShift AI for your data scientist users, you must define administrative users. Only users with the cluster-admin role can install and configure OpenShift AI.

For more information about creating a cluster admin user, see Creating a cluster admin.

2.3. Mirroring images to a private registry for a disconnected installation

You can install the Red Hat OpenShift AI Operator to your OpenShift cluster in a disconnected environment by mirroring the required container images to a private container registry. After mirroring the images to a container registry, you can install Red Hat OpenShift AI Operator using OperatorHub.

You can use the mirror registry for Red Hat OpenShift, a small-scale container registry that you can use as a target for mirroring the required container images for OpenShift AI in a disconnected environment. Use of the mirror registry for Red Hat OpenShift is optional if another container registry is already available in your installation environment.

Prerequisites

  • You have cluster-admin access to a running OpenShift Container Platform cluster, version 4.12 or greater.
  • Your host machine has access to the Internet so that it can obtain the images to populate the mirror repository.
  • You have installed the OpenShift CLI (oc).
  • You have a GitHub account linked to a verified email address.
  • If you plan to use NVIDIA GPUs, you have mirrored and deployed the NVIDIA GPU Operator. See Configuring the NVIDIA GPU Operator.
  • If you plan to use the distributed workloads component, you have mirrored the Ray cluster image.
  • If you plan to use the demo notebooks for distributed workloads, you have cloned the codeflare-sdk repository.

Procedure

  1. Create a mirror registry. See Creating a mirror registry with mirror registry for Red Hat OpenShift.
  2. Install the oc-mirror OpenShift CLI plug-in (version 4.12 or greater) to mirror registry images. See Installing the oc-mirror OpenShift CLI plug-in.
  3. Configure registry authentication. See Configuring credentials that allow images to be mirrored.
  4. Open the example image set configuration file (rhoai-<version>.md) from the disconnected installer helper repository and examine its contents.
  5. Using the example image set configuration file, create a file called imageset-config.yaml and populate it with values suitable for the image set configuration in your deployment.

    Important

    The example image set configurations are for demonstration purposes only and might need further alterations depending on your deployment.

    To identify the attributes most suitable for your deployment, examine the documentation and use cases in Mirroring images for a disconnected installation using the oc-mirror plugin.

    Your imageset-config.yaml should look similar to the following example, where openshift-pipelines-operator-rh is required for Data Science pipelines, and both serverless-operator and servicemeshoperator are required for the KServe component.

    mirror:
      operators:
        - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15
          packages:
            - name: rhods-operator
            - name: openshift-pipelines-operator-rh
              channels:
                - name: latest
            - name: serverless-operator
              channels:
                - name: stable
            - name: servicemeshoperator
              channels:
                - name: stable
    • To view a list of the available OpenShift versions:

      oc-mirror list operators
    • To see the available channels for a package:

      oc-mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v4.15 --package=<package-name>
  6. Run the oc mirror command to mirror the specified image set configuration to disk:

    $ oc mirror --config=./imageset-config.yaml file://mirror-rhods
    • Replace mirror-rhods with the target directory where you want to output the image set file.
    • The target directory path must start with file://.

      Important

      To successfully mirror the image set configuration to disk, ensure that you have installed oc-mirror OpenShift CLI (oc) plug-in, version 4.12 or greater. Versions of oc-mirror preceding version 4.12 do not allow you to mirror the full image set configuration provided.

  7. Verify that the image set .tar files were created:

    $ ls mirror-rhods
    mirror_seq1_000000.tar mirror_seq1_000001.tar

    If an archiveSize value was specified in the image set configuration file, the image set might be separated into multiple .tar files.

  8. Mirror the contents of the generated image set to the target mirror registry:

    $ oc mirror --from=./mirror-rhods docker://registry.example.com:5000
    • Replace mirror-rhods with the directory that contains your image set .tar files.
    • Replace registry.example.com:5000 with your mirror registry.
  9. Verify that the YAML files are present for the ImageContentSourcePolicy and CatalogSource resources:

    $ ls oc-mirror-workspace/results-1639608488/
    
    catalogSource-rhods-operator-live-catalog.yaml
    charts
    imageContentSourcePolicy.yaml
    mapping.txt
    release-signatures

    Replace results-1639608488 with the name of your results directory.

  10. Log in to the OpenShift CLI as a user with the cluster-admin role.
  11. Install the generated ImageContentSourcePolicy and CatalogSource resources into the cluster:

    $ oc apply -f ./oc-mirror-workspace/results-1639608488/imageContentSourcePolicy.yaml
    $ oc apply -f ./oc-mirror-workspace/results-1639608488/catalogSource-rhods-operator-live-catalog.yaml

    Replace results-1639608488 with the name of your results directory.

Verification

  • Run the following command to verify that the CatalogSource and pod were created successfully:

    $ oc get catalogsource,pod -n openshift-marketplace | grep redhat-operators
  • Check that the Red Hat OpenShift AI Operator exists in the OperatorHub:

    1. Log in to the OpenShift Container Platform cluster web console.
    2. Click OperatorsOperatorHub.

      The OperatorHub page opens.

    3. Locate the Red Hat OpenShift AI Operator.

Additional resources

2.4. Installing the Red Hat OpenShift AI Operator

This section shows how to install the Red Hat OpenShift AI Operator on your OpenShift Container Platform cluster using the command-line interface (CLI) and the OpenShift web console.

Note

If you want to upgrade from a previous version of OpenShift AI rather than performing a new installation, see Upgrading OpenShift AI in a disconnected environment.

Note

If your OpenShift cluster uses a proxy to access the Internet, you can configure the proxy settings for the Red Hat OpenShift AI Operator. See Overriding proxy settings of an Operator for more information.

2.4.1. Installing the Red Hat OpenShift AI Operator by using the CLI

The following procedure shows how to use the OpenShift command-line interface (CLI) to install the Red Hat OpenShift AI Operator on your OpenShift Container Platform cluster. You must install the Operator before you can install OpenShift AI components on the cluster.

Prerequisites

  • You have a running OpenShift Container Platform cluster, version 4.12 or greater, configured with a default storage class that can be dynamically provisioned.
  • You have cluster administrator privileges for your OpenShift Container Platform cluster.
  • You have downloaded and installed the OpenShift command-line interface (CLI). See Installing the OpenShift CLI.
  • You have mirrored the required container images to a private registry. See Mirroring images to a private registry for a disconnected installation.

Procedure

  1. Open a new terminal window.
  2. In the OpenShift command-line interface (CLI), log in to your OpenShift Container Platform cluster as a cluster administrator, as shown in the following example:

    $ oc login <openshift_cluster_url> -u <admin_username> -p <password>
  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-operator-index
        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-2-latest, eus-2-latest, or alpha. The following table describes these channels. For more information, including the lifecycle associated with each of the available subscription channels, see Red Hat OpenShift AI Self-Managed Life Cycle.
      ChannelSupportRelease frequencyRecommended environment

      fast

      One month of full support

      Every month

      Production environments with access to the latest product features.

      Select this streaming channel with automatic upgrades to avoid manually upgrading every month.

      stable

      Three months of full support

      Every three months

      Production environments with stability prioritized over new feature availability.

      Select this streaming channel with automatic upgrades to access the latest stable release and avoid manually upgrading.

      stable-x.y

      Seven months of full support

      Every three months

      Production environments with stability prioritized over new feature availability.

      Select numbered stable channels (such as stable-2-latest) to plan and execute the upgrade to the next stable release while keeping your deployment under full support.

      eus-x.y

      Seven months of full support followed by Extended Update Support for eleven months

      Every nine months

      Enterprise-grade environments that cannot upgrade within a seven month window.

      Select this streaming channel if you prioritize stability over new feature availability.

      alpha

      One month of full support

      Every month

      Development environments with early-access features that might not be functionally complete.

      Select this channel to use early-access features that enable you to test functionality and provide feedback during the development process. Early-access features are not supported with Red Hat production service level agreements (SLAs).

      For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope. For more information about the support scope of Red Hat Developer Preview features, see Developer Preview Features Support Scope.

      Note

      The embedded and beta channels are legacy channels that will be removed in a future release. Do not select the embedded or beta channels for a new installation of the Operator.

    2. As described in the preceding step, ensure that the subscription channel you specify is appropriate for your organization’s requirements.
    3. 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

Verification

  • In the OpenShift Container Platform web console, click OperatorsInstalled Operators and confirm that the Red Hat OpenShift AI Operator shows one of the following statuses:

    • Installing - installation is in progress; wait for this to change to Succeeded. This might take several minutes.
    • Succeeded - installation is successful.
  • In the web console, click HomeProjects and confirm that the following project namespaces are visible and listed as Active:

    • redhat-ods-applications
    • redhat-ods-monitoring
    • redhat-ods-operator

2.4.2. Installing the Red Hat OpenShift AI Operator by using the web console

The following procedure shows how to use the OpenShift Container Platform web console to install the Red Hat OpenShift AI Operator on your cluster. You must install the Operator before you can install OpenShift AI components on the cluster.

Prerequisites

  • You have a running OpenShift Container Platform cluster, version 4.12 or greater, configured with a default storage class that can be dynamically provisioned.
  • You have cluster administrator privileges for your OpenShift Container Platform cluster.
  • You have mirrored the required container images to a private registry. See Mirroring images to a private registry for a disconnected installation.

Procedure

  1. Log in to the OpenShift Container Platform web console as a cluster administrator.
  2. In the web console, click OperatorsOperatorHub.
  3. On the OperatorHub page, locate the Red Hat OpenShift AI Operator by scrolling through available Operators or by typing Red Hat OpenShift AI into the Filter by keyword box.
  4. Select the Operator to display additional information.
  5. Read the information about the Operator and click Install.
  6. For Update channel, select a value of fast, stable, stable-2-latest, eus-2-latest, or alpha. The following table describes these channels. For more information, including the lifecycle associated with each of the available subscription channels, see Red Hat OpenShift AI Self-Managed Life Cycle.

    ChannelSupportRelease frequencyRecommended environment

    fast

    One month of full support

    Every month

    Production environments with access to the latest product features.

    Select this streaming channel with automatic upgrades to avoid manually upgrading every month.

    stable

    Three months of full support

    Every three months

    Production environments with stability prioritized over new feature availability.

    Select this streaming channel with automatic upgrades to access the latest stable release and avoid manually upgrading.

    stable-x.y

    Seven months of full support

    Every three months

    Production environments with stability prioritized over new feature availability.

    Select numbered stable channels (such as stable-2-latest) to plan and execute the upgrade to the next stable release while keeping your deployment under full support.

    eus-x.y

    Seven months of full support followed by Extended Update Support for eleven months

    Every nine months

    Enterprise-grade environments that cannot upgrade within a seven month window.

    Select this streaming channel if you prioritize stability over new feature availability.

    alpha

    One month of full support

    Every month

    Development environments with early-access features that might not be functionally complete.

    Select this channel to use early-access features that enable you to test functionality and provide feedback during the development process. Early-access features are not supported with Red Hat production service level agreements (SLAs).

    For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope. For more information about the support scope of Red Hat Developer Preview features, see Developer Preview Features Support Scope.

    Note

    The embedded and beta channels are legacy channels that will be removed in a future release. Do not select the embedded or beta channels for a new installation of the Operator.

  7. For Installation mode, observe 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.
  8. For Installed Namespace, select redhat-ods-operator (Operator recommended).
  9. Under Update approval, select either Automatic or Manual.
  10. Click Install.

    An installation pane opens. When the installation finishes, a checkmark appears beside the Operator name in the installation pane.

Verification

  • In the OpenShift Container Platform web console, click OperatorsInstalled Operators and confirm that the Red Hat OpenShift AI Operator shows one of the following statuses:

    • Installing - installation is in progress; wait for this to change to Succeeded. This might take several minutes.
    • Succeeded - installation is successful.
  • In the web console, click HomeProjects and confirm that the following project namespaces are visible and listed as Active:

    • redhat-ods-applications
    • redhat-ods-monitoring
    • redhat-ods-operator

2.5. Installing and managing Red Hat OpenShift AI components

The following procedures show how to use the command-line interface (CLI) and OpenShift Container Platform web console to install and manage components of Red Hat OpenShift AI on your OpenShift Container Platform cluster.

2.5.1. Installing Red Hat OpenShift AI components by using the CLI

The following procedure shows how to use the OpenShift command-line interface (CLI) to install specific components of Red Hat OpenShift AI on your OpenShift Container Platform cluster.

Important

The following procedure describes how to create and configure a DataScienceCluster object to install Red Hat OpenShift AI components as part of a new installation. However, if you upgraded from version 1 of OpenShift AI (previously OpenShift Data Science), the upgrade process automatically created a default DataScienceCluster object. If you upgraded from a previous minor version, the upgrade process uses the settings from the previous version’s DataScienceCluster object. To inspect the DataScienceCluster object and change the installation status of Red Hat OpenShift AI components, see Updating the installation status of Red Hat OpenShift AI components by using the web console.

Prerequisites

Procedure

  1. Open a new terminal window.
  2. In the OpenShift command-line interface (CLI), log in to your on your OpenShift Container Platform cluster as a cluster administrator, as shown in the following example:

    $ oc login <openshift_cluster_url> -u <admin_username> -p <password>
  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

Verification

  • Confirm that there is a running pod for each component:

    1. In the OpenShift Container Platform web console, click WorkloadsPods.
    2. In the Project list at the top of the page, select redhat-ods-applications.
    3. In the applications namespace, confirm that there are running pods for each of the OpenShift AI components that you installed.
  • Confirm the status of all installed components:

    1. In the OpenShift Container Platform web console, click OperatorsInstalled Operators.
    2. Click the Red Hat OpenShift AI Operator.
    3. Click the Data Science Cluster tab and select the DataScienceCluster object called default-dsc.
    4. Select the YAML tab.
    5. In the installedComponents section, confirm that the components you installed have a status value of true.

      Note

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

2.5.2. Installing Red Hat OpenShift AI components by using the web console

The following procedure shows how to use the OpenShift Container Platform web console to install specific components of Red Hat OpenShift AI on your cluster.

Important

The following procedure describes how to create and configure a DataScienceCluster object to install Red Hat OpenShift AI components as part of a new installation. However, if you upgraded from version 1 of OpenShift AI (previously OpenShift Data Science), the upgrade process automatically created a default DataScienceCluster object. If you upgraded from a previous minor version, the upgrade process used the settings from the previous version’s DataScienceCluster object. To inspect the DataScienceCluster object and change the installation status of Red Hat OpenShift AI components, see Updating the installation status of Red Hat OpenShift AI components by using the web console.

Prerequisites

  • The Red Hat OpenShift AI Operator is installed on your OpenShift Container Platform cluster. See Installing the Red Hat OpenShift AI Operator.
  • You have cluster administrator privileges for your OpenShift Container Platform cluster.

Procedure

  1. Log in to the OpenShift Container Platform web console as a cluster administrator.
  2. In the web console, click OperatorsInstalled 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.

Verification

  • Confirm that there is a running pod for each component:

    1. In the OpenShift Container Platform web console, click WorkloadsPods.
    2. In the Project list at the top of the page, select redhat-ods-applications.
    3. In the applications namespace, confirm that there are running pods for each of the OpenShift AI components that you installed.
  • Confirm the status of all installed components:

    1. In the OpenShift Container Platform web console, click OperatorsInstalled Operators.
    2. Click the Red Hat OpenShift AI Operator.
    3. Click the Data Science Cluster tab and select the DataScienceCluster object called default-dsc.
    4. Select the YAML tab.
    5. In the installedComponents section, confirm that the components you installed have a status value of true.

      Note

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

2.5.3. Updating the installation status of Red Hat OpenShift AI components by using the web console

The following procedure shows how to use the OpenShift Container Platform web console to update the installation status of components of Red Hat OpenShift AI on your OpenShift Container Platform cluster.

Important

If you upgraded from version 1 to version 2 of OpenShift AI, the upgrade process automatically created a default DataScienceCluster object and enabled several components of OpenShift AI. If you upgraded from a previous minor version, the upgrade process used the settings from the previous version’s DataScienceCluster object.

The following procedure describes how to edit the DataScienceCluster object to do the following:

  • Change the installation status of the existing Red Hat OpenShift AI components
  • Add additional components to the DataScienceCluster object that were not available in the previous version of OpenShift AI.

Prerequisites

  • The Red Hat OpenShift AI Operator is installed on your OpenShift Container Platform cluster.
  • You have cluster administrator privileges for your OpenShift Container Platform cluster.

Procedure

  1. Log in to the OpenShift Container Platform web console as a cluster administrator.
  2. In the web console, click OperatorsInstalled 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.

Verification

  • Confirm that there is a running pod for each component:

    1. In the OpenShift Container Platform web console, click WorkloadsPods.
    2. In the Project list at the top of the page, select redhat-ods-applications.
    3. In the applications namespace, confirm that there are running pods for each of the OpenShift AI components that you installed.
  • Confirm the status of all installed components:

    1. In the OpenShift Container Platform web console, click OperatorsInstalled Operators.
    2. Click the Red Hat OpenShift AI Operator.
    3. Click the Data Science Cluster tab and select the DataScienceCluster object called default-dsc.
    4. Select the YAML tab.
    5. In the installedComponents section, confirm that the components you installed have a status value of true.

      Note

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

2.5.4. Disabling KServe dependencies

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.

Prerequisites

  • You have used the OpenShift command-line interface (CLI) or web console to disable the KServe component.

Procedure

  1. Log in to the OpenShift web console as a cluster administrator.
  2. In the web console, click OperatorsInstalled 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 OperatorsInstalled 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.