Chapter 6. Customizing component deployment resources
6.1. Overview of component resource customization
You can customize deployment resources that are related to the Red Hat OpenShift AI Operator, for example, CPU and memory limits and requests. For resource customizations to persist without being overwritten by the Operator, the opendatahub.io/managed: true
annotation must not be present in the YAML file for the component deployment. This annotation is absent by default.
The following table shows the deployment names for each component in the redhat-ods-applications
namespace.
Components denoted with (Technology Preview)
in this table are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using Technology Preview features in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
Component | Deployment names |
---|---|
CodeFlare | codeflare-operator-manager |
KServe |
|
Ray | kuberay-operator |
Kueue | kueue-controller-manager |
Workbenches |
|
Dashboard | rhods-dashboard |
Model serving |
|
Model registry (Technology Preview) | model-registry-operator-controller-manager |
Data science pipelines | data-science-pipelines-operator-controller-manager |
Training Operator | kubeflow-training-operator |
6.2. Customizing component resources
You can customize component deployment resources by updating the .spec.template.spec.containers.resources
section of the YAML file for the component deployment.
Prerequisites
- You have cluster administrator privileges for your OpenShift cluster.
Procedure
- Log in to the OpenShift console as a cluster administrator.
- In the Administrator perspective, click Workloads > Deployments.
-
From the Project drop-down list, select
redhat-ods-applications
. In the Name column, click the name of the deployment for the component that you want to customize resources for.
NoteFor more information about the deployment names for each component, see Overview of component resource customization.
- On the Deployment details page that appears, click the YAML tab.
-
Find the
.spec.template.spec.containers.resources
section. Update the value of the resource that you want to customize. For example, to update the memory limit to 500Mi, make the following change:
containers: - resources: limits: cpu: '2' memory: 500Mi requests: cpu: '1' memory: 1Gi
- Click Save.
- Click Reload.
Verification
- Log in to OpenShift AI and verify that your resource changes apply.
6.3. Disabling component resource customization
You can disable customization of component deployment resources, and restore default values, by adding the opendatahub.io/managed: true
annotation to the YAML file for the component deployment.
Manually removing or setting the opendatahub.io/managed: true
annotation to false
after manually adding it to the YAML file for a component deployment might cause unexpected cluster issues.
To remove the annotation from a deployment, use the steps described in Re-enabling component resource customization.
Prerequisites
- You have cluster administrator privileges for your OpenShift cluster.
Procedure
- Log in to the OpenShift console as a cluster administrator.
- In the Administrator perspective, click Workloads > Deployments.
-
From the Project drop-down list, select
redhat-ods-applications
. In the Name column, click the name of the deployment for the component to which you want to add the annotation.
NoteFor more information about the deployment names for each component, see Overview of component resource customization.
- On the Deployment details page that appears, click the YAML tab.
-
Find the
metadata.annotations:
section. Add the
opendatahub.io/managed: true
annotation.metadata: annotations: opendatahub.io/managed: true
- Click Save.
- Click Reload.
Verification
-
The
opendatahub.io/managed: true
annotation appears in the YAML file for the component deployment.
6.4. Re-enabling component resource customization
You can re-enable customization of component deployment resources after manually disabling it.
Manually removing or setting the opendatahub.io/managed:
annotation to false
after adding it to the YAML file for a component deployment might cause unexpected cluster issues.
To remove the annotation from a deployment, use the following steps to delete the deployment. The controller pod for the deployment will automatically redeploy with the default settings.
Prerequisites
- You have cluster administrator privileges for your OpenShift cluster.
Procedure
- Log in to the OpenShift console as a cluster administrator.
- In the Administrator perspective, click Workloads > Deployments.
-
From the Project drop-down list, select
redhat-ods-applications
. - In the Name column, click the name of the deployment for the component for which you want to remove the annotation.
- Click the Options menu .
- Click Delete Deployment.
Verification
- The controller pod for the deployment automatically redeploys with the default settings.