Deploy MOSTLY AI to an OpenShift cluster

You can install MOSTLY AI in an OpenShift cluster. This page covers the list of prerequisites you need and the steps for a successful installation.

💡

If you run into issues during the installation process, see Troubleshoot OpenShift deployments or contact your Customer Success Engineer.

Prerequisites

An OpenShift (4.2 or higher) cluster
- Your OpenShift cluster meets the resource requirements.
- An available Storage Class that can be mounted with RWX (ReadWriteMany) access, such as NFS, EFS, CEPH, or another.
Obtain the MOSTLY AI Helm chart from your Customer Success Engineer.
Obtain a Docker pull image secret from your Customer Success Engineer.
Install the OpenShift CLI tools. See Installing the OpenShift CLI (opens in a new tab).
Use the OpenShift CLI to log in to your OpenShift cluster. See Logging in to the OpenShift CLI (opens in a new tab).
Install Helm 3.0 or higher. See Installing Helm (opens in a new tab).
Internet connectivity to pull the Docker images from the MOSTLY AI repository.

💡

To configure the installation, you need to edit the values.yaml and define required configurations specifically for an OpenShift cluster. The file is part of the provided MOSTLY AI Helm chart.

The file contains many of the required configurations for different types of Kubernetes clusters. The steps below contain excerpts from the values.yaml file to indicate sections of the the required configurations for OpenShift. The excerpts are small sections from the file. Contents preceding and following the excerpts are indicated with an ellipsis (...).

Steps

Create the mostly-ai namespace in your OpenShift cluster.
```
oc new-project mostly-ai
```
Unarchive the MOSTLY AI Helm chart and from a terminal or a command line, change directory to the MOSTLY_AI_helm_charts directory.
```
cd MOSTLY_AI_helm_charts
```
Open the values.yaml file in an editor. You set the configurations required to deploy MOSTLI AI in an OpenShift cluster.
Comment out the K8S configurations under K8S platform ingress.
Uncomment the OpenShift configurations under OpenShift platform route.
Set the fully-qualified domain name (FQDN) of your organization.
1. Set your FQDN for the domain key. The excerpt below shows mostly.ai as the configured FQDN. Replace mostly.ai with the FQDN of your organization.
  values.yaml
```
...
name: mostlyai
domain: mostly.ai
...
```
2. Set your FQDN for the route: fqdn key under OpenShift platform route. The example below shows the line in values.yaml and the value of mostly.ai as being as the FQDN.
  values.yaml
```
...
## OpenShift platform route
route:
    fqdn: mostly.ai
...
```
Set your Docker pull image secret key in the docker_secret key. The secret key is your authentication for the MOSTLY AI Helm repository. The initial value is the following:
values.yaml
```
docker_secret: "base64 encoded secret"
```
Replace the value "base64 encoded secret" with the Docker pull image secret key provided by your Customer Success Engineer. The value must not be wrapped in quotation marks and the line should look similar to the following, where the ellipsis (...) indicates the remaining characters of the complete secret key.
values.yaml
```
docker_secret: exJhdXRocyI6eyJuZX...
```
Set the platform key to the OpenShift value ocp.
values.yaml
```
...
platform: ocp
...
```
For MOSTLY AI Coordinator, set the environment to OpenShift by setting to true the key envs: is_ocp.
values.yaml
```
...
envs:
    is_ocp: 'true'
...
```
(Optional) Add any additional annotations under the #Optional annotations for OCP Route line.
values.yaml
```
## OpenShift platform route
...
#Optional annotations for OCP Route
annotations:
```
Save your changes in the values.yaml file.
Install MOSTLY AI with the helm command.
💡
Make sure that the current directory is MOSTLY_AI_helm_charts when you run the command.
```
helm upgrade --install mostly-ai ./ --values values.yaml --namespace mostly-ai
```