Before you install IBM® Maximo® Application Suite, you must prepare your environment so that all configuration and software dependencies are managed.
Verify that the following dependencies are set up and configured.
- Java Runtime Environment
- Certificate issuer
- Domain name and DNS server
- Instance name
- Red Hat® OpenShift®
- Apache Kafka
- Behavior Analytics Services
- Maximo Monitor:
- IBM® Db2® Warehouse*
- Maximo® Health, Maximo® Predict
* The component is bundled with the included restricted use IBM® Cloud Pak for Data entitlement. A complete list of the permitted components is available in the Maximo Application Suite License document.
For more information about environment requirements and capacity planning, see the Maximo Application Suite system requirements document.
General prerequisites for Maximo Application Suite.
Java Runtime Environment
To accept the license during installation, the workstation on which you run the Maximo Application Suite installer must have a Java Runtime Environment configured.
For more information, see the Maximo Application Suite Software Product Compatibility Report
At installation time, you can provide a Cluster Issuer that is based on a trusted certificate authority (CA) for signing the certificates that are generated for your Maximo Application Suite domains. By default, Maximo Application Suite provides
a Cluster Issuer that generates Maximo Application Suite certificates that are signed by a self-signed CA. To use your own Cluster Issuer, include the following optional parameter when you run the Maximo Application Suite installer:
For an example of automatic management and issuance of TLS certificates on Kubernetes, see cert-manager on GitHub.
Domain name and DNS server
Before you install and set up your Maximo Application Suite environment, you must decide on a domain name and work with your DNS administrators to make sure that your domain name points to your OpenShift cluster. In the examples that follow, masdomain.com is used as the example domain. The following DNS records are needed:
Important: The domain name that you assign to the Maximo Application Suite instance must be resolvable within the Red Hat® OpenShift® cluster that you are deploying to.
The instance name identifies the Maximo Application Suite installation on your Red Hat® OpenShift® cluster. Depending on how you plan to use your instance, an instance name might be nonproduction, production, or some other descriptive name.
You provide the instance name as a parameter when you run the installation script.
./install.sh -i instance_name --domain masdomain.com
OpenShift Container Platform
A OpenShift cluster must be configured and running. You can either provision your own cluster or rely on a preconfigured cloud solution.
For installation instructions, see the Prerequisites section of the Maximo Application Suite download document.
For general installation and configuration information, see the OpenShift Container Platform section of the OpenShift documentation.
OpenShift security context constraints requirements
The Maximo Application Suite installer requires that the OpenShift default restricted security context constraint (SCC) is bound to the target namespaces before installation.
By default, the installer configures Maximo Application Suite with a 20 GB volume of the default storage class.
If a default storage class is not defined in the cluster, then the storage class must be configured by setting the
LICENSING_STORAGE_CLASS environment variable before running the installation or entering the class when prompted during
the installation. This environment variable can also be used if you want to use a storage class other than the default.
The license system has no specific performance requirements for the storage class and requires only a minimum capacity of 1 GB. You can choose the cheapest or lowest quality of service storage class available in your cluster and set the size of
LICENSING_STORAGE_SIZE parameter to the lowest value that is supported by the storage class.
A MongoDB instance must be configured and running. Maximo Application Suite uses MongoDB for data dictionary and user management. Your MongoDB instance can run in the OpenShift cluster or external to it.
To complete the Maximo Monitor deployment, you need the following MongoDB information:
- Hostname and port
- Config db name
- Admin user credentials for an admin user who has table create rights.
For installation and configuration information, see the MongoDB documentation.
For Maximo Application Suite 8.0.0, MongoDB Community Edition can be used. For more information about how to set up MongoDB Community Edition on OpenShift, see the MongoDB quick start samples on GitHub.
Important: In order to work with Maximo Application Suite, your MongoDB instance must support TLS. For more information, see TLS/SSL (Transport Encryption) in the MongoDB documentation.
Maximo Monitor: Apache Kafka
Kafka forms an important part of the internal communications for services in the Maximo Application Suite. To deploy Maximo Monitor, an Apache Kafka instance must be configured and running.
After installation, to complete the Maximo Monitor deployment you need the following Apache Kafka information:
For installation and configuration information, see the Apache Kafka documentation.
With Maximo Application Suite, you can use Strimzi to run Kafka on Kubernetes. For an example of how to set up Strimzi on Red Hat® OpenShift®, see MongoDB quick start samples on GitHub.
Behavior Analytics Services
The Behavior Analytics Services Operator collects and processes Maximo Application Suite license and usage information.
Important: Maximo Application Suite records information necessary to provide you with access to the suite and to ensure that AppPoints are correctly managed based on individual user entitlements. Maximo Application Suite also records usage against different components to monitor compliance of Maximo Application Suite license terms. Register the required contact information for IBM to use in communication about compliance and usage of your Maximo Application Suite installation. For more information, see the IBM Privacy Statement.
For information about how to install the Behavior Analytics Services Operator, see the Behavior Analytics Services quick start guide for Maximo Application Suite.
The following application prerequisites must be met before you can deploy the applications.
Maximo Monitor: Db2 Warehouse
To deploy Maximo Monitor, a Db2 instance must be configured and running.
After installation, to complete the deployment of the applications that use Db2, you need the following information:
Important: For Maximo Monitor and IoT tool, you must use the secure port number.
Important: For Maximo Monitor and IoT tool, options must include:
Db2 is a core component of the Maximo Monitor application where it is used as a data lake and for data analytics storage.
You can configure the main Maximo Application Suite JDBC Db2 connection before you deploy Maximo Monitor or as part of the deployment.
Your Maximo Application Suite product includes an entitlement for IBM® Cloud Pak for Data.
To install IBM® Db2® Warehouse, see the following Cloud Pak for Data product hub documentation:
- Installing Cloud Pak for Data on a Red Hat® OpenShift® cluster
- Installing Db2 Warehouse
For an example of how to set up IBM® Cloud Pak for Data on OpenShift, see Getting started with IBM® Cloud Pak for Data and MongoDB quick start samples on GitHub.
Maximo® Health, Maximo® Predict: Application databases
To deploy Maximo® Health, a database instance must be configured and running. Maximo® Health supports IBM® Db2®, Db2 Warehouse, Microsoft® SQL Server, or Oracle Database. You cannot use the shared Maximo Monitor Db2 Warehouse database on Cloud Pak for Data. For more information about database options for Maximo® Health, see Configuring the database.
Maximo® Predict must use the shared Maximo Monitor Db2 Warehouse database on Cloud Pak for Data.
Maximo® Predict: Watson Machine Learning
To deploy Maximo® Predict, an instance of Watson Machine Learning must be configured and running.
Installing Watson Machine Learning
Your Maximo Application Suite product includes an entitlement for Watson Machine Learning.
To install Watson Machine Learning, see the following Cloud Pak for Data product hub documentation:
- Installing Cloud Pak for Data on a Red Hat® OpenShift® cluster
- Installing Watson Machine Learning
For an example of how to set up IBM® Cloud Pak for Data on OpenShift, see Getting started with IBM® Cloud Pak for Data on GitHub.
Optional requirements for your Maximo Application Suite environment.
Optional: LDAP server
To use the LDAP user registry with Maximo Application Suite, you need the following LDAP server information:
- URL of your LDAP instance
- Bind DN, and Bind password
- Base DN
- User ID Map
Optional: SAML server
To use the SAML user registry with Maximo Application Suite, you need the following SAML server information:
- Service provider name
- Name identifier format
Maximo Application Suite supports Slack for logging information. To set up Slack integration, you need the following Slack information:
- Slack channel
- Slack API key