Prerequisites for installing Maximo Application Suite on Amazon Web Services

Before you install IBM® Maximo® Application Suite, you must set up several components and gather the information that you need to specify the installation parameters.

The following components are required to install Maximo Application Suite in Amazon Web Services (AWS):

Amazon Web Services account
To install the Maximo Application Suite on Amazon Web Services (AWS), you must have an AWS account. During a Maximo Application Suite installation, a new virtual private cloud (VPC) is created in the AWS account. The Red Hat® OpenShift® cluster is then deployed in the VPC, and the Maximo Application Suite is deployed in the cluster.

For more information, see How do I create and activate a new AWS account?.

Consider deploying into a new AWS account because the permissions that are defined in the Maximo Application Suite deployment automation allows you to create administrative roles, users, or groups.

In your AWS account, create an identity and access management (IAM) user and assign a managed policy to this user that includes the required permissions to install the Maximo Application Suite. You can assign the existing AdministratorAccess managed policy or create and assign your own managed policy. For more information, see Configuring the installation permissions.

By default, your AWS account has access to all of the Amazon services that you need to install the Maximo Application Suite. These services include Amazon Route 53, CloudFormation, EC2 instances, S3 storage buckets, and the simple email service (SES). When you configure these services, ensure that you select the same geographical region where you want to install the Maximo Application Suite. For the list of supported regions, see the installation considerations topic.

Your AWS account includes default quotas for each AWS service. In the future, you might need to increase these quotas, for example if your Red Hat OpenShift cluster requires more resources. For more information, see AWS service quotas.

SSH key pair
The Amazon EC2 service uses virtual computing environments, which are also known as instances, to provide computing capacity in the AWS cloud. In an installed Maximo Application Suite on Amazon Web Services, the Red Hat OpenShift cluster nodes are EC2 instances.

For more information, see What is Amazon EC2?

When an EC2 instance is created, a key pair, which consists of a public key and a private key, must be provided. Because the Maximo Application Suite installation creates many EC2 instances, you must generate a key pair and upload it in the Amazon EC2 service before you install the Maximo Application Suite. Your Amazon Web Services account has access to the EC2 service. For more information, see Create a key pair.

When you specify the parameters for a Maximo Application Suite installation on Amazon Web Services, in the SSHKey parameter, select the public key that you generated. Keep the private key in a safe place and store it in the PEM format.

After the installation is complete, you can use the private key to connect to the cluster nodes by using Secure Shell (SSH). For more information, see Accessing the Bootnode and Red Hat OpenShift cluster.

Bootnode CIDR IP address range
When you begin a Maximo Application Suite installation, a Bootnode is created that contains all of the required information, including the parameters that you specify, to complete the installation. The Bootnode creates and installs the VPC, Red Hat OpenShift cluster, Maximo Application Suite prerequisites, and Maximo Application Suite itself.

To connect to the Bootnode, you must specify a range of IPv4 addresses that can access it. In the BootnodeSGIngressCidrIp installation parameter, enter the IP address range by using the classless inter-domain routing (CIDR) notation. For example, to allow all IP addresses to access the Bootnode, enter 0.0.0.0/0. To allow one specific IP address to access the Bootnode, enter x.x.x.x/32, for example 192.12.33.3/32. For more information about CIDR notation, see https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation.

Maximo Application Suite license for BYOL product
If you do not already have your Maximo Application Suite license key file, you can create and download it in the IBM License Key Center.

For instructions, see the steps in the Upload your license key file section of the Setting up Maximo Application Suite topic. When you create the license, provide the server parameters that are indicated in the following table:

Parameter Value
Configuration Single License Server
Host ID Type Ethernet address
Host ID A unique 12-character hexadecimal value, such as `0abcac110f02`. You can generate this value by using one of the following methods:
  • An online hexadecimal number generator, such as Online Hex Tools.
  • A command-line utility, such as the Linux® hexdump utility. For example, the following command generates a lowercase 12-character hexadecimal string:
    hexdump -n 6 -e '8/8 "%08X" 1 "\n"' /dev/urandom | tr '[:upper:]' '[:lower:]'
    

After you download the Maximo Application Suite license key file, upload it to an Amazon S3 storage bucket. Your AWS account has access to the Amazon S3 storage service. If any storage buckets are not created, first sign in to the AWS Management Console and open the Amazon S3 console. Then, click Create bucket and follow the steps in the bucket wizard. If you already have storage buckets created, in the Buckets list, choose the name of the bucket that you want to upload your Maximo Application Suite license key file to. Then, click Upload and follow the steps in the upload wizard.

For more information about using Amazon S3 buckets, see Buckets overview in the AWS documentation.

After you upload the license to the S3 bucket, record either the HTTP or the S3 location of the license, for example s3://masocp-license/entitlement.lic. You can find the S3 location in the Amazon S3 console by viewing the bucket name's properties. You enter this location when you specify the MASLicenseUrl installation parameter.

IBM Entitled Registry
The IBM Entitled Registry key is used during the installation to download the container images for the Maximo Application Suite and its applications from the IBM Entitled Registry.

Download this key from the IBM Container Library.

Pull secret
To create the Red Hat OpenShift cluster, you must provide a pull secret. To access the pull secret, complete the following steps:
  1. Create a Red Hat OpenShift account, if you do not have one already.

    Create a Red Hat Login.

  2. To access your Red Hat OpenShift entitlements, in the Passport Advantage® website, link your purchased Maximo Application Suite software to your Red Hat OpenShift account.

    For more information about how to link purchased IBM software to a Red Hat OpenShift account, see Accessing Red Hat entitlements from your IBM Cloud® Paks.

  3. Log in to the Red Hat Hybrid Cloud Console by using your Red Hat OpenShift account credentials. https://cloud.redhat.com/
  4. In the Clusters page, click Download Pull Secret.

The pull secret is a JSON-formatted text file. When you configure the Maximo Application Suite installation parameters, copy the JSON text from the file into the OpenShiftPullSecret parameter.

Red Hat OpenShift subscription
If you are deploying the Maximo Application Suite using IBM Maximo Application Suite (client-managed, without Red Hat OpenShift entitlement) marketplace product, you should own Red Hat OpenShift Container Platform (OCP) subscription, which is valid and active throughout the term of Maximo Application Suite subscription.

For more information, see Managing clusters.