How To
Summary
The installation of Red Hat OpenShift on AWS for Maximo Manage using the MAS DevOps Ansible Collection is described. As of this writing, the `mas provision-aws` command of the IBM MAS CLI tool does not deploy Red Hat OpenShift versions higher than 4.10. For the mean time, use the `ocp_provision` role. This MAS installation on AWS is an option to using the MAS Bring Your Own License (BYOL) on AWS. And, using the MAS DevOps Ansible Collection, single node OpenShift (SNO) can be created.
Objective
To install a single node Red Hat OpenShift (IPI mode) in AWS using the MAS DevOps Ansible Collection.
Environment
An Amazon Web Services account is needed. Since the IBM MAS CLI utility is used, a running Docker or Podman service is needed in the host environment where the installation is ran.
In the screenshots, an Ubuntu v22.04 virtual machine is used to run the IBM MAS CLI utility. The MAS DevOps Ansible Collection is deployed in a container created using the IBM MAS CLI. Note that the version of the CLI may have updated after the release of this document.
Note that the installation of the OpenShift cluster in this note uses the installer-provisioned installation (IPI) mode. The example installation show the installation of SNO in AWS, and the installation of MAS Manage on this SNO. A multinode OpenShift can be created by changing the values of appropriate variables.
Steps
Part A. Installation of Red Hat OpenShift
1. Ensure to download the Red Hat pull secret in the environment where the MAS CLI container will be deployed. (From the link provided, click the "Download pull secret" button. There is no need to download anything else from the page).
2. Create a directory in the local volume. In the screenshot, the directory, `ipi`, is created in /home/mas/aws. The Red Hat pull secret is saved as `pull-secret.dms`.
3. Create a file containing all the export commands needed to run the `ocp_provision` role.
export CLUSTER_NAME=<cluster name>
export CLUSTER_TYPE=ipi
export AWS_ACCESS_KEY_ID=<AWS access key id>
export AWS_SECRET_ACCESS_KEY=<AWS secret access key>
export IPI_DIR=/mnt/home/aws/ipi
export OCP_VERSION=4.12.36 # or desired OCP version
export IPI_PLATFORM=aws
export IPI_REGION=<AWS region>
export IPI_BASE_DOMAIN=<base domain>
export IPI_PULL_SECRET_FILE=/mnt/home/aws/pull-secret.dms
export IPI_CONTROLPLANE_REPLICAS=1
export IPI_COMPUTE_REPLICAS=0
- Cluster name will be the name of the cluster and will be added to the URL of the cluster.
- Cluster type is `ipi`. AWS access key id and AWS secret access key should be available to the user having permission to create a cluster in AWS.
- IPI directory is the directory created in item 3 in this note.
- The OCP version can be any supported version by MAS. As of this writing, the supported version is 4.12.
- IPI platform should have a value of `aws`.
- AWS region can have any value available to the AWS user. For example, it could have a value of `us-east-1` or `us-east-2`.
- The base domain is a domain obtained using AWS Route 53.
- The pull secret file is the file path to the pull secret file on the MAS CLI container.
- For a single node OpenShift, use the values 1 and 0 for the variables `IPI_CONTROLPLANE_REPLICAS` and `IPI_COMPUTE_REPLICAS`, respectively. If a multinode OpenShift is desired, change the values of these variables accordingly.
In the screenshot, this file is named `ocp_provision_vars.sh`.
4. Create the container from the ibmmas/cli image. The command makes sure that the container has its volume mounted on your local environment (~):
docker run -ti -v ~:/mnt/home --pull always quay.io/ibmmas/cli
5. Determine the path of the pull secret file from the MAS CLI container.
The following screenshot (which shows how to `exec` interactively with a running MAS CLI container named `awssno`) shows how to look for the Red Hat pull secret file, the `ipi` directory, and the file that contains the export commands for the variables needed to run the `ocp_provision` role.
6. Run the export commands by sourcing the variables file. To check that the variables have been exported into the envrionment, run an `echo` command for one or two of the variables exported. It should return the expected value. In the following screenshot, the variable `CLUSTER_NAME` is defined as `demo`.
7. Run the `ocp_provision` role:
This part will take a while. In the process, two folders are created in the IPI_DIR (see no. 2): `config` and `installer`.
The `config` folder holds logs if there is a failure in the OpenShift installation. If the installation is successful, the `config` folder contains the files generated from the OpenShift installation including the OpenShift credentials. The `installer` folder stores the OpenShift installer for the corresponding OpenShift version specified by the variable `OCP_VERSION`.
Common errors are due to incorrectly provided AWS Secret Access Key and/or Access Key ID. For help in resolving errors, submit a ticket to IBM Support and include the Ansible logs.
Successful installation of the Red Hat OpenShift cluster is shown by a `failed=0` status in the MAS CLI container.
Storage classes provisioned by default in the cluster in this example are `gp2-csi` and `gp3-csi`:
AWS resources (EC2 instance, among others) should also be created in the AWS console.
Part B. Installation of MAS Manage
Use the `mas install` command as described in the technote "Installing MAS Using the IBM MAS Utility". For the example in this technote, since the cluster is SNO, only MAS Manage can be installed.
The following screenshots show the installation of MAS core and Manage showing the running of `mas install` command, application selection, the detection of the storage classes, and the launch of the installation.
As in the technote for installing MAS using the `mas install` of IBM CLI tool, check the resulting pipeline, which which should show as succeeded after running.
If there are issues involving the MAS installation, submit a ticket to IBM Support and include the MAS must-gather data.
Related Information
Document Location
Worldwide
[{"Type":"MASTER","Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSRHPA","label":"IBM Maximo Application Suite"},"ARM Category":[{"code":"a8m3p000000GoLBAA0","label":"Maximo Application Suite-\u003EInstallation"},{"code":"a8m3p000000hAeaAAE","label":"Maximo Application Suite-\u003EMAS Applications-\u003EManage"}],"ARM Case Number":"TS012792275","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"8.10.0;8.11.0"}]
Was this topic helpful?
Document Information
Modified date:
25 January 2024
UID
ibm16998735