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_idms 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

suite_manage_attachments_config¤

This role extends support for configuring IBM Cloud Object Storage or Persistent Volume/File Storages for Manage application attachments.

Note: This role should be executed after Manage application is deployed and activated as it needs Manage up and running prior configuring attachments features.

By default, Manage attachments configuration uses filestorage provider; it corresponds to your cluster's default file storage system to persist the files. Alternatively, you can provide an existing IBM Cloud Object Storage by using ibm provider, or even provision a new instance by using cos role. Finally, an existing AWS S3 service can also be provided via aws provider by this same role (see details in the Role Varilables below)

Role Variables¤

mas_manage_attachments_provider¤

Required. Defines the storage provider type to be used to store Manage application's attachments. Available options are:

Note: If using ibm or aws as attachments provider, the cos_bucket role will be executed to setup a new or existing targeted COS bucket to be used to store Manage attachments, therefore make sure you set the expected variables to customize your COS bucket for Manage attachments, i.e. COS_APIKEY and COS_INSTANCE_NAME.

Note about S3: To run this role successfully for AWS s3 buckets, you must have already installed the AWS CLI.Also, you need to have AWS user credentials configured via aws configure command or simply export AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables with your corresponding AWS username credentials prior running this role.

mas_manage_attachment_configuration_mode¤

Required. Defines how attachment properties will be configured in Manage. Possible values are cr and db.

When cr is selected, attachment properties will be entered in ManageWorkspace CR for each bundle, under bundleProperties key. For this mode, manage_workspace_cr_name must be informed;

When db is selected, attachment properties will be updated directly in the database via SQL updates. For this mode, db2_instance_name, db2_namespace and db2_dbname must be informed.

mas_instance_id¤

Required. The instance ID of Maximo Application Suite. This will be used to lookup for Manage application resources.

mas_workspace_id¤

Required. The workspace ID of Maximo Application Suite. This will be used to lookup for Manage application resources.

manage_workspace_cr_name¤

Optional. Required when mas_manage_attachment_configuration_mode is set as cr. Name of the ManageWorkspace Custom Resource that will be targeted to configure the new PVC definitions.

db2_instance_name¤

Optional. Required when mas_manage_attachment_configuration_mode is set as db. The DB2 Warehouse instance name that stores your Manage application tables and data. This will be used to lookup for Manage application database and update it with the IBM Object Storage configuration.

Note: in order to obtain the value for this variable, go to the namespace where db2 is installed and look for the pod where label=engine. Select/describe the pod representing your database, and look for the value of label app. That is your db2 instance name.

db2_namespace¤

Optional. Required when mas_manage_attachment_configuration_mode is set as db. The namespace in your cluster that hosts the DB2 Warehouse instance name. This will be used to lookup for Manage application database and update it with the IBM Object Storage configuration. If you do not provide it, the role will try to find the Db2 Warehouse in db2u namespace.

db2_dbname¤

Optional. Required when mas_manage_attachment_configuration_mode is set as db. Name of the database within the instance.

Example Playbook¤

The following sample can be used to configure COS for an existing Manage application instance's attachments via ManageWorkspace CR update (note cr as configuration mode + ma_instance_id and mas_workspace_id, which will be used to infer the CR name):

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_manage_attachment_configuration_mode: cr
    mas_instance_id: masinst1
    mas_workspace_id: masdev
    cos_instance_name: cos-masinst1
    cos_bucket_name: manage-attachments-bucket
    ibmcloud_apikey: xxxx
    mas_manage_attachments_provider: ibm
  roles:
    - ibm.mas_devops.suite_manage_attachments_config

The following sample playbook can be used to provision COS in IBM Cloud and configure COS for an existing Manage application instance's attachments via SQL updates in database (note db as configuration mode + db2_instance_name):

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_manage_attachment_configuration_mode: db
    mas_instance_id: masinst1
    mas_workspace_id: masdev
    db2_instance_name: db2w-manage
    cos_instance_name: cos-masinst1
    cos_bucket_name: manage-attachments-bucket
    ibmcloud_apikey: xxxx
    mas_manage_attachments_provider: ibm
  roles:
    - ibm.mas_devops.cos
    - ibm.mas_devops.suite_manage_attachments_config

The following sample playbook can be used to deploy Manage with default persistent storage for Manage attachments (PVC mount path /DOCLINKS), and configure Manage system properties with the corresponding attachments settings; via SQL updates in database:

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_manage_attachment_configuration_mode: db
    mas_app_id: manage
    mas_app_channel: 8.4.x
    mas_instance_id: masinst1
    mas_workspace_id: masdev
    db2_instance_name: db2w-manage
    mas_app_settings_persistent_volumes_flag: true
    mas_manage_attachments_provider: filestorage
  roles:
    - ibm.mas_devops.db2
    - ibm.mas_devops.suite_db2_setup_for_manage
    - ibm.mas_devops.suite_config
    - ibm.mas_devops.suite_app_install
    - ibm.mas_devops.suite_app_config
    - ibm.mas_devops.suite_manage_attachments_config

The following sample can be used to configure AWS S3 buckets for an existing Manage application instance's attachments.

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_instance_id: masinst1
    mas_workspace_id: masdev
    db2_instance_name: db2w-manage
    aws_bucket_name: manage-attachments-bucket
    mas_manage_attachments_provider: aws
  roles:
    - ibm.mas_devops.suite_manage_attachments_config

License¤

EPL-2.0