Skip to content

Install the Run:ai Control Plane

Install the Control Plane

Run the helm command below:

helm repo add runai-backend
helm repo update
helm upgrade -i runai-backend -n runai-backend runai-backend/control-plane --version "~2.15.0" \ 
    --set global.domain=runai.apps.<OPENSHIFT-CLUSTER-DOMAIN> \ # (1)
    --set global.config.kubernetesDistribution=openshift 
  1. The subdomain configured for the OpenShift cluster.


To install a specific version, add --version <version> to the install command. You can find available versions by running helm search repo -l runai-backend.

helm upgrade -i runai-backend  ./control-plane-<version>.tgz -n runai-backend \ 
    --set global.domain=runai.apps.<OPENSHIFT-CLUSTER-DOMAIN> \ # (1)
    --set global.config.kubernetesDistribution=openshift \
    --set global.customCA.enabled=true \ # (2)
    -f custom-env.yaml  # (3)
  1. The domain configured for the OpenShift cluster. To find out the OpenShift cluster domain, run oc get routes -A
  2. See the Local Certificate Authority instructions below
  3. custom-env.yaml should have been created by the prepare installation script in the previous section.

(replace <version> with the control plane version)


Use the --dry-run flag to gain an understanding of what is being installed before the actual installation.

(Air-gapped only) Local Certificate Authority

Perform the instructions for local certificate authority.

(Optional) Additional Configurations

There may be cases where you need to set additional properties as follows:

Key Change Description
keycloakx.adminUser User name of the internal identity provider administrator This user is the administrator of Keycloak
keycloakx.adminPassword Password of the internal identity provider administrator This password is for the administrator of Keycloak
global.postgresql.auth.username PostgreSQL username Override the Run:ai default user name for the Run:ai database
global.postgresql.auth.password PostgreSQL password Override the Run:ai default password for the Run:ai database
grafana.adminUser Grafana username Override the Run:ai default user name for accessing Grafana
grafana.adminPassword Grafana password Override the Run:ai default password for accessing Grafana
thanos.receive.persistence.storageClass and postgresql.primary.persistence.storageClass Storage class The installation to work with a specific storage class rather than the default one
- name: <secret-name>
Docker secret Provide credentials for accessing the organization's docker registry. This is required for air-gapped environments
    cpu: 500m
    memory: 512Mi
    cpu: 250m
    memory: 256Mi
Pod request and limits <component> may be anyone of the following: backend, frontend, assetsService, identityManager, tenantsManager, keycloakx, grafana, authorization, orgUnitService,policyService

Connect to Run:ai User Interface

  • Run: oc get routes -n runai-backend to find the Run:ai Administration User Interface URL.
  • Log in using the default credentials: User: [email protected], Password: Abcd!234.
  • Go to the Users area and change the password.

Next Steps

Continue with installing a Run:ai Cluster.