Install Maximo Application Suite

The installation process includes downloading the installer from IBM Passport Advantage, acquiring your entitlement key, installing the Maximo Application Suite components on OpenShift, accessing your license on IBM.com, and configuring the core software.

Note: The following process discusses customer-managed Maximo Application Suite. For IBM managed Maximo Application Suite, no action is required and you can go directly to Getting started.

Before you begin

Before you can install Maximo Application Suite, you must:

Note: Multiple instances of Maximo Application Suite can be installed on a single cluster if each cluster has sufficient capacity. Each instance must be given a unique ID and domain.

Install Maximo Application Suite

  1. Log in to the OpenShift web console as an administrator.
  2. Copy the login token.
    1. Click your user account icon and select Copy Login Command.
    2. Copy the login token.
  3. In your local command line, paste in the login token and press enter to log in to the OpenShift cluster.
    Example:
     oc login --token=kiaj2_jkoasunJljsLdsqdsa787asd --server=https://api.myopenshiftcluster.com:6443
    
    Note: You can also use a valid token for a service account if you are using a service account for the installation.
  4. Set the entitlement key for the IBM Entitled Registry.
    Configure the system to use the entitlement key that you obtained from the IBM Container Library as described in the Maximo Application Suite download document.
    From the command line, run the following command:
    export ENTITLEMENT_KEY=<your_key>
  5. Optional: Configure Slack notification.
    If you want to use Slack as a channel for real-time installation updates and further application deployment activities, from the command line, run the following commands:
    export SLACK_CHANNEL=<slack_channel>
    export SLACK_APIKEY=<api_key>
  6. Locate and run the install.sh file.
    The install.sh file is part of the Maximo Application Suite V8.1 for Multiplatform package that you downloaded from Passport Advantage.
    You can run the installer with a number of options:
    • Run the installer with no modifications.
      Example:
      ./install.sh -i instance_name --domain masdomain.com
      Where:
      • instance_name is the OpenShift instance name that you want to use.
      • masdomain.com is the domain name for your environment.
    • Add a certificate provider.
      By default, a self-signed certificate is used. Add your certificate by including the following parameter: -c masdev-cluster-issuer
      Where masdev-cluster-issuer is the Cluster Issuer for your cluster.
      Example:
      ./install.sh -i instance_name --domain masdomain.com -c masdev-cluster-issuer
    • Optional: Configure the use of Slack for installation information.
      Example:
      ./install.sh -i instance_name --domain masdomain.com --enable-slack-notifications
  7. Accept the license terms.
    The Maximo Application Suite license terms are displayed. To continue with the installation, you must accept the license terms.

  8. Monitor the installation. Important: The installer downloads the Maximo Application Suite container images from IBM Entitled Registry. Depending on your network speed, this download might take up to 30 minutes.
    As the installer progresses, verify the successful installation of each component. If the Slack integration is configured, you receive progress updates to your Slack channel. The debug log file for each installation step is listed with the step result output:

    • Initialization
      Namespace entry example: mas-instance_name-core
      Debug log file example: logs/init-core.log
    • Installation
      Debug log file example: logs/install-mascore.log
      Domain example: masdomain.com
      During the installation step, the Maximo Application Suite super user credentials are created. The super user credentials are used for the initial postinstallation setup and are presented at the end of the installation.
      Tip: You can monitor the Maximo Application Suite initialization from the OpenShift user interface under Workloads > Pods.
      Filter by namespace to locate the Maximo Application Suite pods. Note that one pod remains uninitialized until you configure MongoDB as part of the initial setup. In addition, note that after installing IoT, the state-updater pods are restarting roughly every 20 minutes if there is no event traffic received. This is expected behavior.
      Example:
      $ kubectl get po
      NAME                                      READY   STATUS      RESTARTS   AGE
      ...
      state-state-updater-devices-...           2/2     Running     7          3h17m
      state-state-updater-things-...            2/2     Running     7          3h17m
      ...
      
  9. Review the installation summary.
    After the successful completion of the Maximo Application Suite installation, the following information is displayed:
    • Administration dashboard URL
      Example: https://admin.masdomain.com
    • Super user credentials
      Username and password in the form of two randomly generated 32-character strings.
      Important: Make a note of these credentials. If you lose them, they can be recovered only by an OpenShift administrator at:
      OpenShift dashboard > Projects > mas-instance_name-core > Workloads > Secrets > mas-superuser > Data
    • Setup sign-in URL
      Example: https://admin.masdomain.com/initialsetup

Next steps

At the end of the installation, you are presented with the username and password for the superuser account in the installation summary. You use these credentials to complete the setup of Maximo Application Suite using the URL, which is also provided.