suite_manage_doclinks_config
The role suite_manage_attachments_config
is deprecated and getting replaced by this one.
This role extends support for configuring S3 / Cloud Object Storage to store Manage application doclinks. Note: This role should be executed after Manage application is deployed and activated as it needs Manage up and running prior configuring doclinks features.
You can run cos
role to provision an IBM Cloud Object Storage or you can provide existing IBM Cloud Object Storage or AWS S3 information to use it as storage for Manage application doclinks.
To switch from one provider to the other, serverBundleProperties
in manageWorkspace CR must be reset before running this role again.
Role Variables
mas_manage_doclinks_provider
Required. Defines the storage provider type to be used to store Manage application's doclinks. Currently available options are:
ibm
: Configures IBM Cloud Object Storage as storage system for Manage attachments.aws
: Configures Amazon S3 buckets as storage system for Manage attachments.filestorage
: Configures the local file system/PV for Manage attachments.
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.
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.
- Environment Variable:
MAS_MANAGE_DOCLINKS_PROVIDER
- Default Value: None.
mas_instance_id
Required. The instance ID of Maximo Application Suite. This will be used to lookup for Manage application resources.
- Environment Variable:
MAS_INSTANCE_ID
- Default Value: None
mas_workspace_id
Required. The workspace ID of Maximo Application Suite. This will be used to lookup for Manage application resources.
- Environment Variable:
MAS_WORKSPACE_ID
- Default Value: None
manage_workspace_cr_name
Optional. Name of the ManageWorkspace
Custom Resource that will be targeted to configure the new PVC definitions.
- Environment Variable:
MANAGE_WORKSPACE_CR_NAME
- Default Value:
$MAS_INSTANCE_ID-$MAS_WORKSPACE_ID
Example Playbook
The following sample can be used to configure COS for an existing Manage application instance.
- hosts: localhost
any_errors_fatal: true
vars:
mas_instance_id: masinst1
mas_workspace_id: masdev
mas_manage_doclinks_provider: ibm
cos_instance_name: cos-masinst1
ibmcos_bucket_name: manage-doclinks-bucket
ibmcloud_apikey: xxxx
roles:
- ibm.mas_devops.suite_manage_doclinks_config
The following sample playbook can be used to provision COS in IBM Cloud and configure COS for an existing Manage application instance.
- hosts: localhost
any_errors_fatal: true
vars:
mas_instance_id: masinst1
mas_workspace_id: masdev
db2_instance_name: db2w-manage
mas_manage_doclinks_provider: ibm
cos_instance_name: cos-masinst1
ibmcos_bucket_name: ibm-manage-doclinks-bucket
ibmcloud_apikey: xxxx
roles:
- ibm.mas_devops.cos
- ibm.mas_devops.suite_manage_doclinks_config
The following sample can be used to configure AWS S3 buckets for an existing Manage application instance.
- hosts: localhost
any_errors_fatal: true
vars:
mas_instance_id: masinst1
mas_workspace_id: masdev
mas_manage_doclinks_provider: aws
aws_bucket_name: s3-manage-doclinks-bucket
roles:
- ibm.mas_devops.suite_manage_doclinks_config
License
EPL-2.0