Setup scripts for Maximo Application Suite on Redhat CodeReady Containers

mas-standalone-install is installation scripts for Maximo Application Suite (MAS) 8.7 on Red Hat CodeReady Containers (CRC). This scripts enable to install all prereqs, MongoDB, UDS, SLS, cert-manager, service binding operator, and MAS core on CRC env. An entitlement key for IBM Container Registry is a only required parameter for MAS core installation. No need the other parametersand they are configured by default for CRC. If you want to setup prereqs on a small OpenShift environment without exaggerated configurations, you can use this scripts with custom variables for your environment. Please consider Ansible scripts or any other tools for large projects.

Detailed for the scripts here: https://www.linkedin.com/pulse/running-maximo-manage-stand-alone-openshift-server-red-nishimura/

Disclaimer: I (and also IBM) do NOT support running the MAS on CRC with this guide. You need to have skills to debug K8s/OpenShift to try out the installation.

Usage

Install CRC, prereqs, and MAS Core.

$ sudo yum update && yum install jq git
$ crc setup
$ crc config set cpus 12
$ crc config set memory 32000
$ crc config set disk-size 300
$ crc config set disable-update-check true
$ crc start
$ eval $(crc oc-env)
$ oc login -u kubeadmin -p ************ https://api.crc.testing:6443
$ git clone https://github.com/nishi2go/mas-standalone-install
$ cd mas-standalone-install
$ export ENTITLEMENT_KEY=<Your Entitlement Key> # Get from https://myibm.ibm.com/products-services/containerlibrary
$ ./setup.sh

The additional script, mas-ws_setup.sh, enables to complete MAS workspace configuration except license file uploading to start deployment for MAS apps like Maximo Manage. To put your license file path to SLS_LICENSE_FILE, all of the steps of Suite setup are completed without any manual interventions.

$ export UDS_EMAIL=<Your e-mail>
$ export UDS_LASTNAME=<Your last name>
$ export UDS_FIRSTNAME=<Your first name>
$ # export SLS_LICENSE_FILE=<Your license path>
$ ./mas-ws_setup.sh

The required information to complete Suite setup can be obtained from the following command.

$ ./get_setup_params.sh

For a small OCP enviroment, use -p option with required environment variables.

$ export ENTITLEMENT_KEY=<Your Entitlement Key> # Get from https://myibm.ibm.com/products-services/containerlibrary
$ ./setup.sh -p

Environment varialbe list

ENTITLEMENT_KEY

A key for accessing IBM Container Registry. It can be obtained from here: https://myibm.ibm.com/products-services/containerlibrary

MAS_INSTANCE_ID (default: crc)

An instance ID for the deployment. https://www.ibm.com/docs/en/mas87/8.7.0?topic=installation-instance-requirements#instance_name

MAS_DOMAIN_NAME (default: mas.apps-crc.testing)

A base domain name for the deployment. https://www.ibm.com/docs/en/mas87/8.7.0?topic=installation-instance-requirements#dns

MAS_CHANNEL (default: 8.7.x)

A channel for the MAS subscription. This specifies which version to be used in the instance.

MAS_WORKSPACE_ID (default: dev)

A workspace ID for the instance. https://www.ibm.com/docs/en/mas87/8.7.0?topic=installation-instance-requirements#workspace

MAS_WORKSPACE_NAME (default: Maximo dev)

A description for the workspace ID. https://www.ibm.com/docs/en/mas87/8.7.0?topic=installation-instance-requirements#workspace

SLS_NAMESPACE (default: ibm-sls)

A namespace for Suite License Service.

SLS_STORAGE_CLASS (default: local-path)

A storage class (RWO) for persistent storage in the SLS operator. Use appropriate storage class provided by cloud provider or on-premise solutions in OCP env.

SLS_DOMAIN_NAME (default: apps-crc.testing)

A base domain name for SLS.

SLS_LICENSE_FILE

A license file path for uploading MAS AppPoints token license to SLS.

UDS_EMAIL

A contact email address to use for User Data Service communication.

UDS_LASTNAME

The given name of the owner of the provided contact email address.

UDS_FIRSTNAME

The surname of the owner of the provided contact email address.

UDS_STORAGE_CLASS (default: local-path)

A storage class (RWO) for persistent storage in the UDS operator. Use appropriate storage class provided by cloud provider or on-premise solutions in OCP env.

MONGODB_NAMESPACE (defualt: mongodb)

A namespace for the MongoDB operator.

MONGODB_REPLICAS (default: 3)

A number of instances for MongoDB service.

MONGODB_CPU_REQUEST (default: 100m)

A request parameter for CPU in the MongoDB instance. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits

MONGODB_MEM_REQUEST (default: 256Mi)

A request parameter for memory in the MongoDB instance. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits

MONGODB_CPU_LIMIT (default: 1)

A limit parameter for CPU in the MongoDB instance. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits

MONGODB_MEM_LIMIT (default: 1Gi)

A limit parameter for memory in the MongoDB instance. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits

MONGODB_STORAGE_SIZE (default: 20Gi)

The storage claim size of the provided storage class for the MongoDB instances.

MONGODB_STORAGE_LOG_SIZE (default: 2Gi)

The storage claim size of the provided storage class for the MongoDB logs.

MONGODB_STORAGE_CLASS (default: local-path)

Storage class (RWO) for persistent storage in the UDS operator. Use appropriate storage class provided by cloud provider or on-premise solutions in OCP env.

MONGODB_PASSWORD (default: auto-generated)

A MongoDB password to access the MongoDB servcies. This parameter is automatically generated when it specified in the environment variable.