MVI on Satellite Deployer

This project is based on IBM Cloud Pak Deployer https://github.com/IBM/cloud-pak-deployer
It was stripped down before satellite specific components weere added (still holds many unused artifacts). If time permits we intend to submit satellite components upstream. Credits to the developers of Cloud Pak Deployer.

The following steps will install Maximo Visual Inspection on an OpenShift cluster managed by IBM Cloud Satellite. For the purpose of this lab, the satellite location is hosted on IBM Cloud VPC.

At the time of writing this MVI 8.8, which comes with Maximo Application Suite 8.10, supports only OpenShift 4.10. With support of MVI for OpenShift 4.12 this is now tested with 4.12.

1. Prerequisites

• Podman installed
• On MacOS make sure to have mounted home folders, i.e.

podman machine init --cpus=4 --memory=4096 -v $HOME:$HOME

• Publicly accessable qcow image to RHCOS. e.g. cos://eu-de/images-mvi-on-sat/rhcos-4.10.37-x86_64-ibmcloud.x86_64.qcow2
• Resource group should exist
• Prepare ibm cloud account

2. Prepare

• Make sure podman is installed
• Build the container:

./sat-deploy.sh build

• Copy sample-configurations/sat-ibm-cloud-roks to some folder

mkdir -p data/config/sample
mkdir -p data/status/sample
cp -r ./sample-configurations/sat-ibm-cloud-roks/* data/config/sample

• Update resource_group in data/config/sample/config/sat-ibm-cloud-roks.yaml
• Update href for custom_image in data/config/sample/config/sat-ibm-cloud-roks.yaml
• Update ibm_cloud_region in data/config/sample/inventory/sample.inv
• Update ibm_cloud_location (for satellite) in data/config/sample/inventory/sample.inv

3. Create satellite + OpenShift cluster

export STATUS_DIR=$(pwd)/data/status/sample
export CONFIG_DIR=$(pwd)/data/config/sample
export IBM_CLOUD_API_KEY=*****
export IBM_ODF_API_KEY=*****
export ENV_ID=xy-mvi5  # update
export OCP_PULL_SECRET=''  # If you have a pull secret for OCP, set this variable. Keep the single quotes around the pull secret

./sat-deploy.sh env apply -e env_id="${ENV_ID}" -e IBM_ODF_API_KEY="${IBM_ODF_API_KEY}" -e OCP_PULL_SECRET='${OCP_PULL_SECRET}' -v

If you want to open the OpenShift console at this stage, connect to the private network of your Satellite Location using the wireguard configuration file found in:

data/status/sample/downloads/client.conf

4. Configure OpenShift Data Foundation(ODF)

This step is done by the automation. For background information visit ui-docs/odf.md

5. Activate OpenShift registry

This step is done by the automation. For background information visit ui-docs/registry.md

6. Add a GPU node to the environment

Edit configuration file data/config/sample/config/sat-ibm-cloud-roks.yaml and uncomment gpu node in section sat_host. Stay in the same shell as before, then requirement variables are still set. Execute the following apply command. Note that due to limited capacity of GPU instances this command may fail. If it fails, try a different zone.

./sat-deploy.sh env apply -e env_id="${ENV_ID}" -e IBM_ODF_API_KEY="${IBM_ODF_API_KEY}" -e OCP_PULL_SECRET='${OCP_PULL_SECRET}' -v --confirm-destroy

Deploy the Nvidia GPU operator

Start a shell in the deployment container:

./sat-deploy.sh env cmd -e ENV_ID="${ENV_ID}"

You should have an command prompt inside the docker container, which contains all CLIs like ibmcloud and oc. Connect to your Cloud Account and Openshift cluster:

ibmcloud login --apikey $IBM_CLOUD_API_KEY --no-region
ibmcloud oc cluster config --admin -c "${ENV_ID}-sat-roks"

ROLE_NAME=nvidia_gpu ansible-playbook ibm.mas_devops.run_role

Normally this step would fail with Satellite ROKS clusters because of the following issue NVIDIA/gpu-operator#428. We addressed this automatically in previous steps of the automation, which sets the right imagetag for the NVIDIA operator.
To learn more about this step and troubleshooting, visit ui-docs/gpu.md

7. Install Maximo core

• Copy Maximo configuration files:

mkdir -p data/status/sample/mvi
cp -r ./sample-configurations/mvi/* data/status/sample/mvi

• Edit and complete data/status/sample/mvi/masEnv.sh Look for all parametes in brackets <param>

• Create a config map in namespace ibm-common-services. This is required to ibm-commmon-services operator.

oc create namespace ibm-common-services
oc apply -f data/status/sample/mvi/ibm-cpp-config.yaml

• Run the automation playbook. cmd container should be still running. If not start again and login to OpenShift.

source /data/status/mvi/masEnv.sh
ansible-playbook ibm.mas_devops.oneclick_core

• Take a note of the superuser name and password displayed at the end of the playbook.

For more information on this step, visit ui-docs/mas.md

8. Install MVI

source /data/status/mvi/masEnv.sh
ansible-playbook ibm.mas_devops.oneclick_add_visualinspection

For more information on this step, visit ui-docs/mvi.md

9. Login as superuser and create admin user

• Using the superuser credentials that were created upon successful installation to login to MAS UI https://admin.<maximo-domain>

• Go to Administration > Users to create a new admin user (15 AppPoints) and fill in the details for the user like name, email and password.

• Create admin user

• Assign application and administration entitlements -> Premium

• Save the credentials, logout of the super user and login with the new admin user created to confirm access to the platform.

10. Expose MAS to the internet

• Edit configuration file data/config/sample/config/sat-ibm-cloud-roks.yaml and uncomment the loadbalancer.
• Run the following command:

./sat-deploy.sh env apply -e env_id="${ENV_ID}" -e IBM_ODF_API_KEY="${IBM_ODF_API_KEY}" -e OCP_PULL_SECRET='${OCP_PULL_SECRET}' -v

11. Load demo model and conect MVI mobile

12. Destroy artifacts

If the command fails due to some reason (timeout), start it again.

./sat-deploy.sh env destroy -e env_id="${ENV_ID}" --confirm-destroy