MAS DevOps Ansible Collection Ansible CLI
Edit on GitHub 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
Home Roles: Dependency Mgmt cos Role Variables - General Role Variables - IBM COS Role Variables - MAS Configuration Example Playbook License

cos¤

This role provides support for:

Currently this role only supports generating a system-scoped ObjectStorageCfg resource, but the generated file can be modified if you wish to use other scopes.

Role Variables - General¤

cos_type¤

Which COS provider to use; can be set to either ibm for IBM Cloud Object Storage or ocs for OpenShift Container Storage

cos_action¤

Which action you want to run for the COS instance. You can either provision or deprovision a COS instance in your IBM Cloud account.

ocp_ingress_tls_secret_name¤

This can be set to the name of the cluster default router certificate's secret, for use in rare cases where the role is unable to determine the secret name automatically.

custom_labels¤

List of comma separated key=value pairs for setting custom labels on instance specific resources.

Role Variables - IBM COS¤

cos_instance_name¤

Provide an optional name for the Object Storage instance. This is only used when cos_type is set to ibm for IBM Cloud Object Storage.

cos_location_info¤

Required. The location where the instance available - Environment Variable: COS_LOCATION - Default Value: global

cos_plan_type¤

Required (For Provisioning). The plan type of the service - Environment Variable: COS_PLAN - Default Value: standard

cos_url¤

Required (For Provisioning). The COS region location url endpoint. Needed to generage a system-scoped ObjectStorageCfg resource configuration file for MAS. - Environment Variable: COS_REGION_LOCATION_URL - Default Value: https://s3.us.cloud-object-storage.appdomain.cloud

cos_resource_key_iam_role¤

Provide an optional role when cos service credential is getting created during COS provisioning. - Environment Variable: COS_RESOURCE_KEY_IAM_ROLE - Default Value: Manager

cos_use_hmac¤

Set to false to disable the use of HMAC encrypted credentials, however doing so will prevent use of this COS instance with Maximo Application Suite.

cos_apikey¤

Required if cos_type is set to ibm. Provide your less priviledged IBM Cloud API Key for COS only

ibmcloud_apikey¤

Required if cos_type is set to ibm. Provide your IBM Cloud API Key that will be used as the default API Key across multiple roles in this collection.

cos_resourcegroup¤

Only used when cos_type is set to ibm. Provide the name of the resource group which will own the COS instance.

ibmcloud_resourcegroup¤

Only used when cos_type is set to ibm. Provide the name of the default resource group used across multiple roles in this collection.

Role Variables - MAS Configuration¤

mas_instance_id¤

The instance ID of Maximo Application Suite that the ObjectStorageCfg configuration will target. If this or mas_config_dir are not set then the role will not generate a ObjectStorageCfg template.

mas_config_dir¤

Local directory to save the generated ObjectStorageCfg resource definition. This can be used to manually configure a MAS instance to connect to the Kafka cluster, or used as an input to the suite_config role. If this or mas_instance_id are not set then the role will not generate a ObjectStorageCfg template.

include_cluster_ingress_cert_chain¤

Optional. When set to True, includes the complete certificates chain in the generated MAS configuration, when a trusted certificate authority is found in your cluster's ingress.

Example Playbook¤

Create the Ceph Object store on the existing OCS cluster and prepare the objectstorageCfg yaml to mas_config_dir.

- hosts: localhost
  any_errors_fatal: true
  vars:
    cos_type: ocs
    mas_instance_id: masinst1
    mas_config_dir: ~/masconfig
  roles:
    - ibm.mas_devops.cos

Create the IBM Cloud Object storage Instance and prepare the objectstorageCfg yaml to mas_config_dir.

- hosts: localhost
  any_errors_fatal: true
  vars:
    cos_type: ibm
    ibmcloud_apikey: <Your IBM Cloud API Key>
    mas_instance_id: masinst1
    mas_config_dir: ~/masconfig
  roles:
    - ibm.mas_devops.cos

License¤

EPL-2.0