Installation
Installation Overview
1 Pre-requisites
1.1 IBM Entitlement Key
Access Container Software Library using your IBMId to obtain your entitlement key.
1.2 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.
Note
For more information about how to access the IBM License Key Center review the getting started documentation available from the IBM support website.
1.3 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:
1.4 Operator Catalog Selection
If you have not already determined the best catalog source for your installation, refer to the information in the choosing the right IBM Maximo Operator Catalog to meet your requirements guide, or contact IBM Support for guidance.
2 Disconnected Install Preparation
2.1 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. |
2.2 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
docker run -ti --pull always quay.io/ibmmas/cli mas mirror-images
You will be prompted to set the target registry for the image mirroring and to select the version of IBM Maximo Operator Catalog to mirror and the subset of content that you wish to mirror. You can choose to mirror everything from the catalog, or control exactly what is mirrored to your private registry to reduce the time and bandwidth used to mirror the images, as well reducing the storage requirements of the registry.
This command can also be ran non-interactive, for full usgae information refer to the mirror-images command documentation, if you are looking for more detailed guidance on how to approach this activity refer to the image mirroring guide.
mas mirror-images -m direct -d /mnt/local-mirror \
-H myprivateregistry.com -P 5000 -u $REGISTRY_USERNAME -p $REGISTRY_PASSWORD \
-c v8-240430-amd64 -C 8.11.x \
--mirror-catalog --mirror-core --mirror-manage --mirror-mongo --mirror-tsm --mirror-uds --mirror-sls --mirror-cfs \
--ibm-entitlement $IBM_ENTITLEMENT_KEY \
--redhat-username $REDHAT_USERNAME --redhat-password $REDHAT_PASSWORD \
--no-confirm
2.3 Configure OpenShift to use your Private Registry for MAS
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
3 Install Maximo Application Suite
Regardless of whether you are running a connected or disconnect installation, simply run the mas install command and follow the prompts.
docker run -ti --pull always quay.io/ibmmas/cli mas install
Refer to the Interactive Install section in the install command reference for more information.