Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 3. 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 cluster meets all requirements. See Requirements for OpenShift AI Self-Managed.
  2. Add administrative users for OpenShift. See Adding administrative users in OpenShift.
  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 to OpenShift AI user groups.
  7. Provide your users with the URL for the OpenShift cluster on which you deployed OpenShift AI. See Accessing the OpenShift AI dashboard.

3.1. Requirements for OpenShift AI Self-Managed
Copy link

You must meet the following requirements before you can install Red Hat OpenShift AI on your Red Hat OpenShift cluster in a disconnected environment:

Product subscriptions

  • You must have 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.

Cluster administrator access to your OpenShift cluster

  • You must have an OpenShift cluster with cluster administrator access. Use an existing cluster or create a cluster by following the OpenShift Container Platform documentation: Installing a cluster in a disconnected environment.
  • After you install a cluster, configure the Cluster Samples Operator by following the OpenShift Container Platform documentation: Configuring Samples Operator for a restricted cluster.
  • 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.
  • To use OpenShift AI on single node OpenShift, the node has to have at least 32 CPUs and 128 GiB RAM.

  • Your cluster is configured with a default storage class that can be dynamically provisioned.

    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

  • Red Hat OpenShift AI uses the same authentication systems as Red Hat OpenShift Container Platform. See Understanding identity provider configuration for more information on configuring identity providers.
  • Access to the cluster as a user with the cluster-admin role; the kubeadmin user is not allowed.

Internet access on the mirroring machine

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

    • cdn.redhat.com
    • subscription.rhn.redhat.com
    • registry.access.redhat.com
    • registry.redhat.io
    • quay.io

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

    • ngc.download.nvidia.cn
    • developer.download.nvidia.com

Data science pipelines preparation

  • Data science pipelines 2.0 contains an installation of Argo Workflows. If there is an existing installation of Argo Workflows that is not installed by data science pipelines on your cluster, data science pipelines will be disabled after you install OpenShift AI. Before installing OpenShift AI, ensure that your cluster does not have an existing installation of Argo Workflows that is not installed by data science pipelines, or remove the separate installation of Argo Workflows from your cluster.
  • Before you can execute a pipeline in a disconnected environment, you must upload the images to your private registry. For more information, see Mirroring images to run pipelines in a restricted environment.
  • You can store your pipeline artifacts in an S3-compatible object storage bucket so that you do not consume local storage. To do this, you must first configure write access to your S3 bucket on your storage account.

Install KServe dependencies

Install model registry dependencies (Technology Preview feature)

  • To use the model registry component, you must also install Operators for Red Hat Authorino, Red Hat OpenShift Serverless, and Red Hat OpenShift Service Mesh. For more information about configuring the model registry component, see Configuring the model registry component.

Access to object storage

3.2. Adding administrative users in OpenShift
Copy link

Before you can install and configure OpenShift AI for your data scientist users, you must obtain OpenShift cluster administrator (cluster-admin) privileges.

To assign cluster-admin privileges to a user, follow the steps in the relevant OpenShift documentation:

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 administrator access to a running OpenShift Container Platform cluster, version 4.14 or greater.
  • You have credentials for Red Hat OpenShift Cluster Manager (https://console.redhat.com/openshift/).
  • Your mirroring machine is running Linux, has 100 GB of space available, and has access to the Internet so that it can obtain the images to populate the mirror repository.
  • You have installed the OpenShift CLI (oc).
  • If you plan to use NVIDIA GPUs, you have mirrored and deployed the NVIDIA GPU Operator. See Configuring the NVIDIA GPU Operator in the OpenShift Container Platform documentation.
  • If you plan to use data science pipelines, you have mirrored the OpenShift Pipelines operator.
  • If you plan to use the single-model serving platform to serve large models, you have mirrored the Operators for Red Hat OpenShift Serverless and Red Hat OpenShift Service Mesh. For more information, see Serving large models.
  • If you plan to use the distributed workloads component, you have mirrored the Ray cluster image.

Procedure

  1. Create a mirror registry. See Creating a mirror registry with mirror registry for Red Hat OpenShift in the OpenShift Container Platform documentation.

  2. To mirror registry images, install the oc-mirror OpenShift CLI plugin (version 4.14 or greater) on your mirroring machine running Linux. See Installing the oc-mirror OpenShift CLI plugin in the OpenShift Container Platform documentation.

    Important

    Versions of oc-mirror before version 4.14 do not allow you to mirror the full image set configuration provided.

  3. Create a container image registry credentials file that allows mirroring images from Red Hat to your mirror. See Configuring credentials that allow images to be mirrored in the OpenShift Container Platform documentation.
  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.

    • To view a list of the available OpenShift versions, run the following command. This might take several minutes. If the command returns errors, repeat the steps in Configuring credentials that allow images to be mirrored. 

      oc-mirror list operators
      Copy to Clipboard Toggle word wrap

    • To see the available channels for a package in a specific version of OpenShift Container Platform (for example, 4.15), run the following command: 

      oc-mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v4.15 --package=<package-name>
      Copy to Clipboard Toggle word wrap

    • For information about subscription update channels, see Understanding update channels.

      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. 

      kind: ImageSetConfiguration
apiVersion: mirror.openshift.io/v1alpha2
archiveSize: 4
storageConfig:
  registry:
    imageURL: registry.example.com:5000/mirror/oc-mirror-metadata
    skipTLS: false
mirror:
  operators:
    - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15
      packages:
        - name: rhods-operator
          channels:
            - name: stable
              minVersion: 2.10.0
              maxVersion: 2.10.0
        - name: openshift-pipelines-operator-rh
          channels:
            - name: stable
        - name: serverless-operator
          channels:
            - name: stable
        - name: servicemeshoperator
          channels:
            - name: stable
      Copy to Clipboard Toggle word wrap

  6. Download the specified image set configuration to a local file on your mirroring machine:

    • Replace mirror-rhoai with the target directory where you want to output the image set file.
    • The target directory path must start with file://.

    • The download might take several minutes. 

      $ oc mirror --config=./imageset-config.yaml file://mirror-rhoai
      Copy to Clipboard Toggle word wrap
      Tip

      If the tls: failed to verify certificate: x509: certificate signed by unknown authority error is returned and you want to ignore it, set skipTLS to true in your image set configuration file and run the command again.

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

    $ ls mirror-rhoai
mirror_seq1_000000.tar mirror_seq1_000001.tar
    Copy to Clipboard Toggle word wrap

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

  8. Optional: Verify that total size of the image set .tar files is around 75 GB: 

    $ du -h --max-depth=1 ./mirror-rhoai/
    Copy to Clipboard Toggle word wrap

    If the total size of the image set is significantly less than 75 GB, run the oc mirror command again.

  9. Upload the contents of the generated image set to your target mirror registry:

    • Replace mirror-rhoai with the directory that contains your image set .tar files.

    • Replace registry.example.com:5000 with your mirror registry. 

      $ oc mirror --from=./mirror-rhoai docker://registry.example.com:5000
      Copy to Clipboard Toggle word wrap
      Tip

      If the tls: failed to verify certificate: x509: certificate signed by unknown authority error is returned and you want to ignore it, run the following command: 

      $ oc mirror --dest-skip-tls --from=./mirror-rhoai docker://registry.example.com:5000
      Copy to Clipboard Toggle word wrap
  10. Log in to your target OpenShift cluster using the OpenShift CLI as a user with the cluster-admin role.

  11. Verify that the YAML files are present for the ImageContentSourcePolicy and CatalogSource resources:

    • Replace <results-directory> with the name of your results directory. 

      $ ls oc-mirror-workspace/<results-directory>/

catalogSource-cs-redhat-operator-index.yaml
charts
imageContentSourcePolicy.yaml
mapping.txt
release-signatures
      Copy to Clipboard Toggle word wrap

  12. Install the generated ImageContentSourcePolicy and CatalogSource resources into the cluster:

    • Replace <results-directory> with the name of your results directory. 

      $ oc apply -f ./oc-mirror-workspace/<results-directory>/imageContentSourcePolicy.yaml
$ oc apply -f ./oc-mirror-workspace/<results-directory>/catalogSource-cs-redhat-operator-index.yaml
      Copy to Clipboard Toggle word wrap

Verification

  • Verify that the CatalogSource and pod were created successfully: 

    $ oc get catalogsource,pod -n openshift-marketplace
    Copy to Clipboard Toggle word wrap

    This should return at least one catalog and two pods.

  • 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 Operators OperatorHub.

      The OperatorHub page opens.

    3. Confirm that the Red Hat OpenShift AI Operator is shown.
  • If you mirrored additional operators, such as OpenShift Pipelines, Red Hat OpenShift Serverless, or Red Hat OpenShift Service Mesh, check that those operators exist the OperatorHub.

3.4. Installing the Red Hat OpenShift AI Operator
Copy link

This section shows how to install the Red Hat OpenShift AI Operator on your OpenShift 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.

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

Prerequisites

Procedure

  1. Open a new terminal window.

  2. Follow these steps to log in to your OpenShift 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>
      Copy to Clipboard Toggle word wrap

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

    1. Create a namespace YAML file named rhods-operator-namespace.yaml. 

      apiVersion: v1
kind: Namespace
metadata:
  name: redhat-ods-operator
      1
      Copy to Clipboard Toggle word wrap
      1
      Defines the required redhat-ods-operator namespace for installation of the Operator.

    2. Create the namespace in your OpenShift cluster. 

      $ oc create -f rhods-operator-namespace.yaml
      Copy to Clipboard Toggle word wrap

      You see output similar to the following: 

      namespace/redhat-ods-operator created
      Copy to Clipboard Toggle word wrap

  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
      Copy to Clipboard Toggle word wrap
      1
      Defines the required redhat-ods-operator namespace.

    2. Create the OperatorGroup object in your OpenShift cluster. 

      $ oc create -f rhods-operator-group.yaml
      Copy to Clipboard Toggle word wrap

      You see output similar to the following: 

      operatorgroup.operators.coreos.com/rhods-operator created
      Copy to Clipboard Toggle word wrap

  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: <channel>
      2 
      
  source: cs-redhat-operator-index
  sourceNamespace: openshift-marketplace
  startingCSV: rhods-operator.x.y.z
      3
      Copy to Clipboard Toggle word wrap
      1
      Defines the required redhat-ods-operator namespace.
      2
      Sets the update channel. You must specify a value of fast, stable, stable-x.y eus-x.y, or alpha. For more information, see Understanding update channels.
      3
      Optional: Sets the operator version. If you do not specify a value, the subscription defaults to the latest operator version. For more information, see the Red Hat OpenShift AI Self-Managed Life Cycle Knowledgebase article.

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

      $ oc create -f rhods-operator-subscription.yaml
      Copy to Clipboard Toggle word wrap

      You see output similar to the following: 

      subscription.operators.coreos.com/rhods-operator created
      Copy to Clipboard Toggle word wrap

Verification

  • In the OpenShift web console, click Operators Installed 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 Home Projects and confirm that the following project namespaces are visible and listed as Active:

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

The following procedure shows how to use the OpenShift 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 cluster, version 4.14 or greater, configured with a default storage class that can be dynamically provisioned.
  • You have cluster administrator privileges for your OpenShift 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 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: Your environment attempts to install new updates when they are available based on the content of your mirror.

    • 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 the Red Hat OpenShift AI Life Cycle Knowledgebase article.

  12. Click Install.

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

Verification

  • In the OpenShift web console, click Operators Installed 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 Home Projects and confirm that the following project namespaces are visible and listed as Active:

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

You can use the OpenShift command-line interface (CLI) or OpenShift web console to install and manage components of Red Hat OpenShift AI on your OpenShift cluster.

To install Red Hat OpenShift AI components by using the OpenShift command-line interface (CLI), you must create and configure a DataScienceCluster object.

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.

Prerequisites

Procedure

  1. Open a new terminal window.

  2. Follow these steps to log in to your OpenShift 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>
      Copy to Clipboard Toggle word wrap

  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
    trainingoperator:
      managementState: Removed
    trustyai:
      managementState: Removed
    workbenches:
      managementState: Removed
    Copy to Clipboard Toggle word wrap
    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 Installing the single-model serving platform.
    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

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

    $ oc create -f rhods-operator-dsc.yaml
    Copy to Clipboard Toggle word wrap

    You see output similar to the following: 

    datasciencecluster.datasciencecluster.opendatahub.io/default created
    Copy to Clipboard Toggle word wrap

Verification

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

    1. In the OpenShift web console, click Workloads Pods.
    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 web console, click Operators Installed 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.

To install Red Hat OpenShift AI components by using the OpenShift web console, you must create and configure a DataScienceCluster object.

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.

Prerequisites

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. Click the Data Science Cluster tab.
  4. Click Create DataScienceCluster.

  5. For Configure via, select YAML view.

    An embedded YAML editor opens showing a default custom resource (CR) for the DataScienceCluster object, similar to the following example: 

    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
    trainingoperator:
      managementState: Removed
    trustyai:
      managementState: Removed
    workbenches:
      managementState: Removed
    Copy to Clipboard Toggle word wrap
    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 Installing the single-model serving platform.
    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.

  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:

    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
  7. Click Create.

Verification

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

    1. In the OpenShift web console, click Workloads Pods.
    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 web console, click Operators Installed 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.

You can use the OpenShift web console to update the installation status of components of Red Hat OpenShift AI on your OpenShift cluster.

Important

If you upgraded OpenShift AI, the upgrade process automatically used the values of the previous version’s DataScienceCluster object. New components are not automatically added to the DataScienceCluster object.

After upgrading OpenShift AI:

  • Inspect the default DataScienceCluster object to check and optionally update the managementState status of the existing components.
  • Add any new components to the DataScienceCluster object.

Prerequisites

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

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. 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 default custom resource (CR) for the DataScienceCluster object, similar to the following example: 

    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
    kueue:
      managementState: Removed
    modelmeshserving:
      managementState: Removed
    ray:
      managementState: Removed
    trainingoperator:
      managementState: Removed
    trustyai:
      managementState: Removed
    workbenches:
      managementState: Removed
    Copy to Clipboard Toggle word wrap

  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:

    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

  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 web console, click Workloads Pods.
    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 web console, click Operators Installed 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.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat