Install the Run:ai Control Plane¶
Prerequisites and preperations¶
Make sure you have followed the Control Plane prerequisites and preperations.
Install the Control Plane¶
Run the helm command below:
helm repo add runai-backend https://runai.jfrog.io/artifactory/cp-charts-prod
helm repo update
helm upgrade -i runai-backend -n runai-backend runai-backend/control-plane --version "~2.17.0" \
--set global.domain=runai.apps.<OPENSHIFT-CLUSTER-DOMAIN> \ # (1)
--set global.config.kubernetesDistribution=openshift
- The subdomain configured for the OpenShift cluster.
Info
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)
- The domain configured for the OpenShift cluster. To find out the OpenShift cluster domain, run
oc get routes -A
- See the Local Certificate Authority instructions below
custom-env.yaml
should have been created by the prepare installation script in the previous section.
(replace <version>
with the control plane version)
Tip
Use the --dry-run
flag to gain an understanding of what is being installed before the actual installation.
Additional configurations (optional)¶
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 |
global.postgresql.auth.port | PostgreSQL port | Override the default PostgreSQL port 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 |
<component> resources: limits: cpu: 500m memory: 512Mi requests: 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 |
Use the --set
syntax in the helm command above.
Next steps¶
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.
Enable Forgot Password (optional)¶
To support the Forgot password functionality, follow the steps below.
- Go to
runai.<openshift-cluster-domain>/auth
and Log in. - Under
Realm settings
, select theLogin
tab and enable theForgot password
feature. - Under the
Email
tab, define an SMTP server, as explained here
Install Run:ai Cluster¶
Continue with installing a Run:ai Cluster.