MAS DevOps Ansible Collection Ansible CLI
Home Ansible Automation Platform OCP Install Cloud Pak For Data Install Core Add AIBroker Add IoT Add Manage Add Monitor Add Optimizer Add Predict Add Visual Inspection Update Upgrade Uninstall Core Backup & Restore ocp_cluster_monitoring ocp_config ocp_deprovision ocp_efs ocp_github_oauth ocp_login ocp_node_config ocp_provision ocp_roks_upgrade_registry_storage ocp_upgrade ocp_verify appconnect aws_bucket_access_point aws_documentdb_user aws_policy aws_route53 aws_user_creation aws_vpc cert_manager cis common-services configure_manage_eventstreams cos cos_bucket cp4d_admin_pwd_update cp4d cp4d_service db2 dro eck grafana ibm_catalogs kafka nvidia_gpu mongodb ocs sls turbonomic uds mirror_case_prepare mirror_extras_prepare mirror_images mirror_ocp ocp_contentsourcepolicy ocp_simulate_disconnected_network registry suite_app_config suite_app_install suite_app_uninstall suite_app_upgrade suite_app_rollback suite_app_backup_restore suite_certs suite_config suite_db2_setup_for_manage suite_dns suite_install suite_manage_attachments_config suite_manage_birt_report_config suite_manage_bim_config suite_manage_customer_files_config suite_manage_imagestitching_config suite_manage_import_certs_config suite_manage_load_dbc_scripts suite_manage_logging_config suite_manage_pvc_config suite_uninstall suite_upgrade suite_rollback suite_verify suite_backup_restore ansible_version_check entitlement_key_rotation gencfg_jdbc gencfg_watsonstudio gencfg_workspace gencfg_mongo
Home Playbooks Install Manage Application Playbook Content Required environment variables Optional Cloud Pak for Data Installation Usage

Install Manage Application¤

This playbook will add Maximo Manage to an existing IBM Maximo Application Suite Instance. Refer to the oneclick-core playbook to set up the MAS Core Platform before running this playbook. The playbook will also create an in-cluster Db2 instance using the IBM Db2 Universal Operator, which will be automatically set up as the system-level JDBC configuration in MAS.

Playbook Content¤

  1. Install Cloud Pak for Data (optional, set CPD_INSTALL_PLATFORM)
  2. Add Cognos to CP4D (optional, set CPD_INSTALL_COGNOS)
  3. Add Watson Studio Local to CP4D (optional, set CPD_INSTALL_WSL)
  4. Create Db2 Instance using IBM Db2 Universal Operator
  5. Initialize Db2 Instance for Maximo Manage
  6. Configure MAS to use the new Db2 Instance
  7. Configure MAS to use BYO database (optional, set CONFIGURE_EXTERNAL_DB)
  8. Install Maximo Manage Application
  9. Configure Maximo Manage Workspace
  10. Configure Manage Attachments (optional, set CONFIGURE_MANAGE_ATTACHMENTS)
  11. Configure Manage Building Information Models (optional, set CONFIGURE_MANAGE_BIM)

See the individual pages for each of these roles for more information and full details of all configuration options available in this playbook.

Required environment variables¤

Tip

Manage requires the user to select one or more application components to enable in the workspace. By default the base component at the latest version will be installed if no MAS_APPWS_COMPONENTS is set. To customise the components that are enabled use the MAS_APPWS_COMPONENTS environment variable, for example to enable Manage(base) and Health set it to the following:

export MAS_APPWS_COMPONENTS="base=latest,health=latest"

To enable Asset Investment Optimizer, optional feature of health. Set MANAGE_AIO_FLAG to true. By default this flag is set to false . This featue is only avalaible on Manage with health as a addon or on Health as a Standalone install.

export MANAGE_AIO_FLAG=true

Optional Cloud Pak for Data Installation¤

Optional integration with Cloud Pak for Data is supported in Maximo Manage. This can be enabled in the playbook as below:

export CPD_INSTALL_PLATFORM=true
export CPD_INSTALL_COGNOS=true
export CPD_INSTALL_WSL=true
export CPD_PRODUCT_VERSION=x.y.z

Usage¤

Tip

If you do not want to set up all the dependencies on your local system, you can run the install inside our docker image as well: docker run -ti --pull always quay.io/ibmmas/cli

In-Cluster Db2¤

export MAS_INSTANCE_ID=inst1
export MAS_CONFIG_DIR=~/masconfig
export IBM_ENTITLEMENT_KEY=xxx

oc login --token=xxxx --server=https://myocpserver
ansible-playbook ibm.mas_devops.oneclick_add_manage

Bring Your Own Database¤

If you do not want to use the Db2 Universal Operator to provide the datbase for Maximo Manage then you can configure the playbook as below:

export MAS_INSTANCE_ID=inst1
export MAS_CONFIG_DIR=~/masconfig
export IBM_ENTITLEMENT_KEY=xxx

export CONFIGURE_EXTERNAL_DB=true
export DB_INSTANCE_ID=maxdbxx
export MAS_JDBC_USER=maximo
export MAS_JDBC_PASSWORD=xxx
export MAS_JDBC_URL=xxx

export MAS_APP_SETTINGS_DB_SCHEMA=maximo
export MAS_APP_SETTINGS_TABLESPACE=maxdata
export MAS_APP_SETTINGS_INDEXSPACE=maxindex

oc login --token=xxxx --server=https://myocpserver
ansible-playbook ibm.mas_devops.oneclick_add_manage

For full details of configuration options available refer to the gencfg_jdbc role documentation.

Cloud Pak For Data Integration¤

To install CP4D with Cognos and/or Watson Studio Local optional dependencies:

export MAS_INSTANCE_ID=inst1
export MAS_CONFIG_DIR=~/masconfig
export IBM_ENTITLEMENT_KEY=xxx

export CPD_INSTALL_PLATFORM="true"
export CPD_INSTALL_COGNOS="true"
export CPD_INSTALL_WSL="true"
export CPD_PRODUCT_VERSION="4.6.6"

oc login --token=xxxx --server=https://myocpserver
ansible-playbook ibm.mas_devops.oneclick_add_manage

For full details of configuration options available refer to the cp4d & cp4d_service role documentation.

Health Standalone Install¤

To install Health as a Standalone application, set MAS_APP_ID and MAS_APPWS_COMPONENTS as below:

export MAS_INSTANCE_ID=inst1
export MAS_CONFIG_DIR=~/masconfig
export IBM_ENTITLEMENT_KEY=xxx

export MAS_APP_ID=health
export MAS_APPWS_COMPONENTS="health=latest"

oc login --token=xxxx --server=https://myocpserver
ansible-playbook ibm.mas_devops.oneclick_add_manage

Warning

Note that installing Health standalone will prevent the use of all other Manage components. It is recommended to install Manage normally and just enable the Health component in the Manage application.