A few scripts to bring up a MAS Manage on OCP Local with DB2 in the cluster (there is also a version with an external MS SQL). If you want to watch a recording of the installation, it is available on YouTube here. If you would like to use this MAS Manage on OCP Local to demo Maximo Mobile using a local emulator, check this blog. Please note that the current version works from CRC 2.11.0 (OCP 4.11.17) on.
My team and I have decided to focus a bit on the problem of installing MAS on a laptop computer in a simple way. I've tried to interest people to pull together notes and explanations on how to do that, but got not a lot of help, so we spent some of our free time on that task. I hope you will find it useful, and that you'll help us in keeping it current and improve it. These instructions will allow you to have a fully functional MAS Core + Manage, that has the Suite License Server (SLS) and DB2 on board, while UDS is either the slim version or it is remote. We need a slim or remote UDS because a full UDS deployment will not fit in the configured size of OCP Local.
First of all, you'll need a decent Laptop. I used a Lenovo ThinkPad P15 with 64 GiB of memory. In the end, you will need the availability of 14 vCPU and 30 GiB of memory in the virtual environment you will use that is Hyper-V for Windows.
If you have a smaller PC that has only 32 GB of memory but still at least 12 vCPU, you may want to try the deployment using an external MS SQL Server described here
Then you will need a locally running OCP (also know previously as CRC, i.e. Code Ready Container). Normally you would download it from the Red Hat Console page, but the version in that page is always the latest, while we need the one supported by MAS. You can download it from https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/crc/2.19.0. For Windows, the file is crc-windows-installer.zip
. Unzip it and install it. Then register to Red Hat if you haven't already, go to the Red Hat Console for OpenShift, click on the Create Cluster button, click on the Local tab. In that page, there is your pull secret that you'll need to copy and use during setup
Now you are ready for the next step. Open a command prompt and run crc setup
. Before staring a new OpenShift Local, we want to configure it so that it will allow MAS to fit. We will need to use a trick because CRC seems to have a bug in expanding the disk. We need to start it a first time, then stop it, set the new disk size and start it again.
This is the set of commands to configure it correctly and start it
crc config set consent-telemetry no
crc config set cpus 14
crc config set memory 30720
crc start
crc stop
crc config set disk-size 200
crc start
At this point you should have an OpenShift running and ready to host MAS Core + Manage. From the last ourput of crc start
you may want to record the password to log into the cluster.
Now that you have OpenShift Local running, you are almost ready to install MAS Core and Manage, but before doing that, you'll need a few files and info.
Open a Windows command prompt, and cd
to a directory in which you will want to create the MAS Local working directory.
As a firt step, let's grab the content of this repository. Issue the following command from the directory you have chosen for this work.
git clone https://github.com/evilADevil/mas-local
cd mas-local
Then you need to procure yourself a few files to add to this directory and some important information:
- The Entitled Registry (ER) key. This key will have to be enabled to get the MAS and CloudPak for Data images and you can get it by logging into My IBM and click on Container Software & Entitlement key
- A MAS license file. Put this file called
license.dat
in themas-local
directory. - A license id matching the MAS license file. You can find out what this is by open the license file in an editor, and check the first line. The license id will be the second-last number. For example, if your first line is
SERVER sls-rlks-0.rlks 0272bc344002 27000
then your license id is0272bc344002
. - The url of the remote UDS (In case you decided to use the slim version of UDS you won't need this one).
- The API key for the remote UDS (In case you decided to use the slim version of UDS you won't need this one).
- The certificates of the remote UDS (In case you decided to use the slim version of UDS you won't need this one). Put them in a file called
uds.crt
in themas-local
directory. To get the UDS info, you may want to follow these few steps:- Find a MAS system with a local UDS instance and login into it as a MAS administrator.
- Navigate to Configurations and click on the User Data Service line.
- In that page you will find the url and the certificates to put in the
uds.crt
file. You need to put two certificates in that file. Edit the UDS configuration and then edit the first and second certificate to reveal its content. Theuds.crt
content should look something like this:
-----BEGIN CERTIFICATE----- MIIFFjCCA.................aWqpSWTUTsqX -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIFazCCA.................nX5iItreGCc= -----END CERTIFICATE-----
- In that page it is also contains the name of the secret that hold the UDS API key. Take a note of it, it is something like
<MAS instance name>-usersupplied-bas-creds-system
oruds-apikey
- To get the UDS API key, you'll need to login into the OpenShift cluster where UDS is running, then:
- click on Workloads to expand the section,
- click on Secrets,
- make sure the Project at the top is
mas-<MAS instance name>-core
, - find the secret named as you noted from the MAS configuration panel, open its yaml and grab the base64 encoded
api_key
from thedata
section - decode the api key using a base64 decoder like the one on this site
In case you don't have a remote UDS or have decided to use the Slim UDS, replace the masocpl.yml
with the masocpl.suds.yml
The next step is to customize the file masocpl.yml
using the information you collected. Specifically:
- Replace
<<your ER key>>
with your ER key from step 0 above. - Replace
<<your license id>>
with the license id you obtained from step 2 above - If you are using a remote UDS, replace
<<your uds url>>
with the url obtained in step 3 above. - If you are using a remote UDS, replace
<<your uds api key>>
with the url obtained in step 4 above - Replace also the
uds_contact
info We are ready to proceed to install MAS Core and Manage
At this point, your working directory should include the following files:
local-path-storage-mod.yaml
masdevops.yaml
masocpl.yml
uds.crt
license.dat
masinst.bat
other files may be present there (like this README.md
), but these are the important ones for the installation.
Before starting the MAS installation, you need to login to the OpenShift Local instance. The crc start
command you have issued should have ended with some messages like these that include the admin credentials:
Started the OpenShift cluster.
The server is accessible via web console at:
https://console-openshift-console.apps-crc.testing
Log in as administrator:
Username: kubeadmin
Password: H2rDA-GXB82-dSdTA-cAAYu
Log in as user:
Username: developer
Password: developer
Use the 'oc' command line interface:
> @FOR /f "tokens=*" %i IN ('crc oc-env') DO @call %i
> oc login -u developer https://api.crc.testing:6443
At the command prompt, run the following commands using the password that your environment provided:
@FOR /f "tokens=*" %i IN ('crc oc-env') DO @call %i
oc login -u kubeadmin -p H2rDA-GXB82-dSdTA-cAAYu https://api.crc.testing:6443
At this point you are ready to install MAS with Manage. Run masinst
at the prompt and wait it to finish.
As the log proceed, pay attention to record the userid and password of the MAS superuser, that should look like this:
ok: [localhost] => {
"msg": [
"Maximo Application Suite is Ready, use the superuser credentials to authenticate",
"Admin Dashboard ... https://admin.masdemo.apps-crc.testing",
"Username .......... DIZv7X2eavITxb3vKtf3XRsY85UYj7FV",
"Password .......... 58Wi9n9U4yVgZ7AhXVRS4eIqEQSnMhsq"
]
}
In case you don't have the log anymore, you can always retrieve them from the masdemo-credentials-superuser
secret in the mas-masdemo-core
namespace.
After the installation completes, you may want to log into MAS administration using the MAS superuser credentials. You can fing the urls to use in the Networking -> Routes
of the mas-masdemo-core
namespace. First of all click on the masdemo-api
url and accept the self-signed certificate. In this way your browser won't have a problem in accessing the MAS APIs later on. Ignore the execption you will get and close that window. Then go back to the cluster UI and click the masdemo-admin
url. Once in MAS, navigate to the Users
section, filter by wilson
, then click on the wilson
user and reset his password. Wait for the syncronization to finish. Log out and login as wilson
. In the MAS Navigator you should see the Manage tile and you should be able to launch into it.
When you are done with your environment, you can stop it using the crc stop
command. Of course, you can restart it when needed, using the crc start
command.