Home Guides Installation Usage Preparation Disconnected Install Preparation Interactive Install Non-Interactive Install More Information

Installation¤

Usage¤

For full usage information run mas install --help

Preparation¤

IBM Entitlement Key¤

Access Container Software Library using your IBMId to obtain your entitlement key.

MAS License File¤

Access IBM License Key Center, on the Get Keys menu select IBM AppPoint Suites. Select IBM MAXIMO APPLICATION SUITE AppPOINT LIC and on the next page fill in the information as below:

Field	Content
Number of Keys	How many AppPoints to assign to the license file
Host ID Type	Set to Ethernet Address
Host ID	Enter any 12 digit hexadecimal string
Hostname	Set to the hostname of your OCP instance, but this can be any value really.
Port	Set to 27000

The other values can be left at their defaults. Finally, click Generate and download the license file to your home directory as entitlement.lic.

OpenShift Cluster¤

You should already have a target OpenShift cluster ready to install Maximo Application suite into. If you do not already have one then refer to the OpenShift Container Platform installation overview.

The CLI also supports OpenShift provisioning in many hyperscaler providers:

• AWS
• IBM Cloud
• IBM DevIT FYRE (Internal)

Operator Catalog Selection¤

If you have not already determined the catalog version for your installation, refer to the information in the Operator Catalog topic, or contact IBM Support for guidance.

Disconnected Install Preparation¤

Prepare the Private Registry¤

You must have a production grade Docker v2 compatible registry such as Quay Enterprise, JFrog Artifactory, or Docker Registry. If you do not already have a private registry available to use as your mirror then you can use the setup-mirror function to deploy a private registry using the Docker registry container image inside a target OpenShift cluster.

docker run -ti --rm --pull always quay.io/ibmmas/cli mas setup-registry

The registry will be setup running on port 32500. For more details on this step, refer to the setup-registry command's documentation. Regardless of whether you set up a new registry or already had one, you need to collect the following information about your private registry:

Name	Detail
Private Hostname	The hostname by which the registry will be accessible from the target OCP cluster.
Private Port	The port number by which the registry will be accessible from the target OCP cluster.
Public Hostname	The hostname by which the registry will be accessible from the machine that will be performing image mirroring.
Public Port	The port number by which the registry will be accessible from the machine that will be performing image mirroring.
CA certificate file	The CA certificate that the registry will present on the private hostname. Save this to your home directory.
Username	Optional. Authentication username for the registry.
Password	Optional. Authentication password for the registry.

Mirror Container Images¤

Mirroring the images is a simple but time consuming process, this step must be performed from a system with internet connectivity and network access your private registry, but does not need access to your target OpenShift cluster. Three modes are available for the mirror process:

• direct mirrors images directly from the source registry to your private registry
• to-filesystem mirrors images from the source to a local directory
• from-filesystem mirrors images from a local directory to your private registry

For full details on this process review the image mirroring guide.

Configure OpenShift to use your Private Registry¤

Your cluster must be configured to use the private registry as a mirror for the MAS container images. An ImageContentSourcePolicy named mas-and-dependencies will be created in the cluster, this is also the resource that the MAS install will use to detect whether the installation is a disconnected install and tailor the options presented when you run the mas install command.

docker run -ti --pull always quay.io/ibmmas/cli mas configure-airgap

You will be prompted to provide information about the private registry, including the CA certificate necessary to configure your cluster to trust the private registry.

This command can also be ran non-interactive, for full details refer to the configure-airgap command documentation.

mas configure-airgap \
  -H myprivateregistry.com -P 5000 -u $REGISTRY_USERNAME -p $REGISTRY_PASSWORD \
  --ca-file /mnt/local-mirror/registry-ca.crt \
  --no-confirm

Interactive Install¤

Regardless of whether you are running a connected or disconnected installation, simply run the mas install command and follow the prompts, the basic structure of the interactive flow is described below. We will need the entitlement.lic file to perform the installation so we will mount your home directory into the running container. When prompted you will be able to set license file to /mnt/home/entitlement.lic

docker run -ti --rm -v ~:/mnt/home quay.io/ibmmas/cli:13.3.0 mas install

The interactive install will guide you through a series of questioned designed to help you arrive at the best configuration for your scenario, it can be broken down as below:

Non-Interactive Install¤

The following command will launch the MAS CLI container image, login to your OpenShift Cluster and start the install of MAS without triggering any prompts. This is how we install MAS in development hundreds of times every single week.

IBM_ENTITLEMENT_KEY=xxx
SUPERUSER_PASSWORD=xxx

docker run -e IBM_ENTITLEMENT_KEY -e SUPERUSER_PASSWORD -ti --rm -v ~:/mnt/home quay.io/ibmmas/cli:13.3.0  bash -c "
  oc login --token=sha256~xxxx --server=https://xxx &&
  mas install \
    --mas-catalog-version v9-250206-amd64 \
    --mas-instance-id mas1 \
    --mas-workspace-id ws1 \
    --mas-workspace-name "My Workspace"
    \
    --superuser-username superuser \
    --superuser-password '${SUPERUSER_PASSWORD}' \
    \
    --mas-channel 9.0.x \
    \
    --ibm-entitlement-key '${IBM_ENTITLEMENT_KEY}' \
    --license-file /mnt/home/entitlement.lic \
    --uds-email myemail@email.com \
    --uds-firstname John \
    --uds-lastname Barnes \
    \
    --storage-rwo ibmc-block-gold \
    --storage-rwx ibmc-file-gold-gid \
    --storage-pipeline ibmc-file-gold-gid \
    --storage-accessmode ReadWriteMany \
    \
    --accept-license --no-confirm

More Information¤

The install is designed to work on any OCP cluster, but has been specifically tested in these environments:

• IBMCloud ROKS
• Microsoft Azure
• AWS ROSA
• IBM DevIT FYRE (internal)

The engine that performs all tasks is written in Ansible, you can directly use the same automation outside of this CLI if you wish. The code is open source and available in ibm-mas/ansible-devops, the collection is also available to install directly from Ansible Galaxy, the install supports the following actions:

• IBM Maximo Operator Catalog installation
• Required dependency installation:
  • MongoDb (Community Edition)
  • IBM Suite License Service
  • IBM Data Reporter Operator
  • Red Hat Certificate Manager
• Optional dependency installation:
  • Apache Kafka
  • IBM Db2
  • IBM Cloud Pak for Data Platform and Services
    • Watson Studio Local
    • Watson Machine Learning
    • Analytics Engine (Apache Spark)
    • Cognos Analytics
  • Grafana
  • Turbonomic Kubernetes Agent
• Suite core services installation
• Suite application installation

The installation is performed inside your RedHat OpenShift cluster utilizing Openshift Pipelines

OpenShift Pipelines is a Kubernetes-native CI/CD solution based on Tekton. It builds on Tekton to provide a CI/CD experience through tight integration with OpenShift and Red Hat developer tools. OpenShift Pipelines is designed to run each step of the CI/CD pipeline in its own container, allowing each step to scale independently to meet the demands of the pipeline.