Skip to content

terraform-ibm-modules/terraform-ibm-mas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maximo Application Suite on Existing Red Hat OpenShift Cluster module

Stable (With quality checks) latest release pre-commit Renovate enabled semantic-release

Use this module to install Maximo Application Suite on your existing Red Hat OpenShift Cluster.

For more information about the Maximo Application Suite refer to the official documentation available here

Overview

Reference architectures

[Maximo Application Suite Deployable Architecture]

terraform-ibm-mas

Usage

You can use the modular design of this module to provision Maximo Application Suite Core offering or Maximo Application Suite Core + Manage offering.

module "maximo" {

  source                       = "terraform-ibm-modules/mas/ibm"
  version                      = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release. For example, 1.6.1
  cluster_id                   = var.cluster_id
  deployment_flavor            = var.deployment_flavor # For example, core
  entitlement_key              = var.entitlement_key
  mas_instance_id              = var.mas_instance_id # For example, inst1
  mas_license                  = var.mas_license
  contact_email                = var.contact_email
  contact_firstname            = var.contact_firstname
  contact_lastname             = var.contact_lastname
  cluster_config_endpoint_type = var.cluster_config_endpoint_type
  mas_workspace_id             = var.mas_workspace_id # For example, wrkid1
  mas_workspace_name           = var.mas_workspace_name # For example, wrkns1
  pipeline_storage_class       = var.pipeline_storage_class # For example, ibmc-vpc-block-retain-10iops-tier
  storage_class_rwo            = var.storage_class_rwo # For example, ibmc-vpc-block-retain-10iops-tier
  storage_class_rwx            = var.storage_class_rwx # For example, ibmc-vpc-file-500-iops (file storage required for db2)

}

Required IAM access policies

You need the following permissions to run this module.

  • IAM services - Kubernetes Service service - Editor platform access - Manager service access

Requirements

Name Version
terraform >= 1.3.0
helm >= 2.8.0, <3.0.0
ibm >= 1.59.0, < 2.0.0
local >= 2.0.0, <2.5.1
null >= 3.2.1, < 4.0.0

Modules

No modules.

Resources

Name Type
helm_release.maximo_helm_release resource
null_resource.install_verify resource
null_resource.maximo_admin_url resource
ibm_container_cluster_config.cluster_config data source
local_file.admin_url data source

Inputs

Name Description Type Default Required
cluster_config_endpoint_type Specify which type of endpoint to use for for cluster config access: 'default', 'private', 'vpe', 'link'. 'default' value will use the default endpoint of the cluster. string "default" no
cluster_id Enter Id of the target IBM Cloud Red Hat OpenShift cluster. This cluster ID can be found under the Red Hat OpenShift clusters section. string n/a yes
contact_email Enter the email ID for Data Reporter Operator string n/a yes
contact_firstname Enter your first name to be used in Data Reporter Operator string n/a yes
contact_lastname Enter your last name to be used in Data Reporter Operator string n/a yes
deployment_flavor Select core for Maximo Application Suite Core deployment and select manage for Maximo Application Suite Core+Manage deployment. Maximo Application Suite Core is deployed by using the MongoDB Community edition and Maximo Manage is deployed with internal Db2 on Red Hat OpenShift cluster. string n/a yes
entitlement_key Enter entitlement key to access IBM Image registry. For more information, see Entitlement Keys You can use an existing secret in Secrets Manager or add your entitlement key directly. string n/a yes
mas_instance_id Enter the Maximo Application Suite instance Id. It can be any instance name lesser than 8 characters in length such as inst1 string n/a yes
mas_license Enter Maximo Application Suite License file content. For more information, see IBM Support - Licensing You can use an existing secret in Secrets Manager or add your entitlement key directly. string n/a yes
mas_workspace_id Enter the Maximo Application Suite workspace Id. string "wrkid1" no
mas_workspace_name Enter the Maximo Application Suite workspace name string "wrkns1" no
pipeline_storage_class Enter the storage class for pipeline. Default value is ibmc-vpc-block-retain-10iops-tier. Make sure this storage class is present under Storage > StorageClasses section on your Red Hat OpenShift cluster section. string "ibmc-vpc-block-retain-10iops-tier" no
storage_class_rwo Enter the storage class (read-write once). Default value is ibmc-vpc-block-retain-10iops-tier. Make sure this storage class is present under Storage > StorageClasses section on your Red Hat OpenShift cluster section. string "ibmc-vpc-block-retain-10iops-tier" no
storage_class_rwx Enter the storage class (read-write many). Enter file storage class for DB2. Default value is ibmc-vpc-file-500-iops. Make sure this storage class is present under Storage > StorageClasses section on your Red Hat OpenShift cluster section. string "ibmc-vpc-file-500-iops" no

Outputs

Name Description
maximo_admin_url Admin URL of MAS/Manage application

Contributing

You can report issues and request features for this module in GitHub issues in the module repo. See Report an issue or request a feature.

To set up your local development environment, see Local development setup in the project documentation.