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 install_operator gencfg_mongo
Home Roles: Dependency Mgmt sls Role Variables Role Variables - Installation Role Variables - Configuration Role Variables - Bootstrap [SLS 3.7.0 and higher] Role Variables - Bootstrap [Partly deprecated in SLS 3.7.0] Role Variables - SLSCfg Example Playbook License

sls¤

Install IBM Suite License Service and generate a configuration that can be directly applied to IBM Maximo Application Suite.

The role assumes that you have already installed the Certificate Manager in the target cluster. This action is performed by the cert_manager role if you want to use this collection to install the cert-manager operator.

Role Variables¤

sls_action¤

Inform the role whether to perform an install or uninstall of the Suite License Service.

Role Variables - Installation¤

If sls_url is set then the role will skip the installation of an SLS instance and simply generate the SLSCfg resource for the SLS instance defined.

artifactory_username¤

Provide your artifactory username, primarily used to update the image pull secret in development.

artifactory_token¤

Provide your artifactory api key, primarily used to update the image pull secret in development.

sls_catalog_source¤

Defines the OLM catalog to be used to install SLS. Set to ibm-sls-operators if you want to deploy pre-release development builds of SLS or leave as the default ibm-operator-catalog for the released versions.

sls_channel¤

The SLS OLM subscription channel to be installed.

sls_namespace¤

Define the namespace where sls must be installed.

sls_icr_cpopen¤

The container registry source for all container images deployed by the SLS operator. From SLS 3.8.0 onwards this will be the only variable to set the registry. Override to use development images.

sls_instance_name¤

Defines the instance ID to be used for SLS installation.

sls_icr_cp [Deprecated in SLS 3.8.0]¤

The container registry source for all container images deployed by the SLS operator. The api-licensing container image has moved to icr.io/cpopen in SLS 3.8.0. Set this variable for SLS 3.7.0 and lower. Override to use development images.

ibm_entitlement_key [Deprecated in SLS 3.8.0]¤

Provide your IBM entitlement key. This is now deprecated in SLS 3.8.0. Provide this only for versions up to 3.7.0.

sls_entitlement_username [Deprecated in SLS 3.8.0]¤

Username for entitled registry. This username will be used to create the image pull secret. This is now deprecated in SLS 3.8.0. Provide this only for versions up to 3.7.0.

sls_entitlement_key [Deprecated in SLS 3.8.0]¤

An IBM entitlement key specific for SLS installation, primarily used to override ibm_entitlement_key in development. This is now deprecated in SLS 3.8.0. Provide this only for versions up to 3.7.0.

Role Variables - Configuration¤

sls_domain¤

SLS can be configured to be externally accessible through a route by setting the domain. Set the domain if SLS is used by application suites that are installed in separate OpenShift clusters.

sls_auth_enforce¤

Determines whether authorization is enforced. If set to true, clients must use mTLS with certificates generated from the client registration flow for SLS API calls.

sls_mongo_retrywrites¤

Set to true if MongoDB support retryable writes. In case if retryable writes is not supported (like in case of Amazon DocumentDB), set to false

sls_compliance_enforce¤

Determines whether compliance is enforced. If there are not enough tokens to support the request. If compliance is not enforced, license checkout requests will be allowed even if there are not enough tokens to support the request.

sls_registration_open¤

Determines whether registration is open. If set to true, clients will be able to register themselves with SLS and use SLS APIs.

sls_mongodb_cfg_file¤

Location of a MAS MongoCfg definition (as generated by the mongodb role). If provided the role will use the information in that config file to configure SLS.

sls_mongodb.hosts¤

Defines list of host and port pair for MongoDb to be used with SLS.

sls_mongodb.certificates¤

Defines list of Certificates for MongoDb to be used with SLS.

sls_mongodb.username¤

Defines the MongoDB Username.

sls_mongodb.password¤

Defines the MongoDb Password.

mas_pod_templates_dir¤

Provide the directory where supported pod templates configuration files are defined. This role will look for a configuration file named ibm-sls-licenseservice.yml in the named directory. The content of the configuration file should be the yaml block that you wish to be inserted into the LicenseService spec under a top level podTemplates element, e.g. podTemplates: {object}.

For examples refer to the BestEfforts reference configuration in the MAS CLI, for full documentation of the supported options refer to the Customizing Pod Templates in the product documentation.

Role Variables - Bootstrap [SLS 3.7.0 and higher]¤

entitlement_file¤

Defines the License File to be used to bootstrap SLS. Don't set if you wish to setup entitlement later on.

Role Variables - Bootstrap [Partly deprecated in SLS 3.7.0]¤

bootstrap.license_file [Deprecated in SLS 3.7.0]¤

Defines the License File to be used to bootstrap SLS. Don't set if you wish to setup entitlement later on. Note: this variable used to be called bootstrap.entitlement_file and defaulted to {{mas_config_dir}}/entitlement.lic, this is no longer the case and SLS_LICENSE_FILE has to be set in order to bootstrap. This is now deprecated in SLS 3.7.0. Use this only for versions up to 3.6.0.

bootstrap.license_id [Deprecated in SLS 3.7.0]¤

Defines the License Id to be used to bootstrap SLS. This must be set when bootstrap.license_file is also set and should match the licenseId from the license file. Don't set if you wish to setup entitlement later on. Note: this is now deprecated in SLS 3.7.0. Use this only for versions up to 3.6.0.

bootstrap.registration_key¤

Defines the Registration Key to be used to bootstrap SLS. Don't set if you wish to setup entitlement later on

Role Variables - SLSCfg¤

mas_instance_id¤

The instance ID of Maximo Application Suite that the SlsCfg configuration will target.

mas_config_dir¤

Local directory to save the generated SlsCfg resource definition. This can be used to manually configure a MAS instance to connect to SLS instance, 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 SlsCfg template.

sls_url¤

The URL of the LicenseService to be called when the Maximo Application Suite is registered with SLS.

mas_license_sync_frequency¤

The sync frequency of user license sync cronjob between Maximo Application Suite and SLS.

sls_tls_crt¤

The TLS CA certificate of the LicenseService to be used when the Maximo Application Suite is registered with SLS. Takes precedence over sls_tls_crt_local_file_path.

sls_tls_crt_local_file_path¤

The path on the local system to a file containing the TLS CA certificate of the LicenseService to be used when the Maximo Application Suite is registered with SLS. This variable is only used if sls_tls_crt has not been set.

sls_registration_key¤

The Registration key of the LicenseService instance to be used when the Maximo Application Suite is registered with SLS.

custom_labels¤

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

mas_pod_templates_dir¤

Provide the directory where supported pod templates configuration files are defined. This role will look for a configuration file named ibm-mas-slscfg.yml in the named directory. The content of the configuration file should be the yaml block that you wish to be inserted into the SlsCfg spec under a top level podTemplates element, e.g. podTemplates: {object}.

For examples refer to the BestEfforts reference configuration in the MAS CLI, for full documentation of the supported options refer to the Customizing Pod Templates in the product documentation.

Example Playbook¤

Install and generate a configuration [up to SLS 3.6.0]¤

- hosts: localhost
  any_errors_fatal: true
  vars:
    ibm_entitlement_key: xxxx
    mas_instance_id: inst1
    mas_config_dir: /home/me/masconfig
    sls_mongodb_cfg_file: "/etc/mas/mongodb.yml"

    bootstrap:
      license_id: "aa78dd65ef10"
      license_file: "/etc/mas/entitlement.lic"
      registration_key: xxxx

  roles:
    - ibm.mas_devops.sls

Install and upload license file [SLS 3.7.0]¤

- hosts: localhost
  any_errors_fatal: true
  vars:
    ibm_entitlement_key: xxxx
    mas_instance_id: inst1
    sls_mongodb_cfg_file: "/etc/mas/mongodb.yml"
    entitlement_file: "/etc/mas/entitlement.lic"

  roles:
    - ibm.mas_devops.sls

Install and upload license file [from SLS 3.8.0]¤

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_instance_id: inst1
    sls_mongodb_cfg_file: "/etc/mas/mongodb.yml"
    entitlement_file: "/etc/mas/entitlement.lic"

  roles:
    - ibm.mas_devops.sls

Generate a configuration for an existing installation¤

- hosts: localhost
  any_errors_fatal: true
  vars:
    mas_instance_id: inst1
    mas_config_dir: /home/me/masconfig

    sls_tls_crt_local_file_path: "/home/me/sls.crt"
    slscfg_url: "https://xxx"
    slscfg_registration_key: "xxx"

  roles:
    - ibm.mas_devops.sls

License¤

EPL-2.0