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 General Information MAS DevOps Ansible Collection Usage Running in Docker Local Install Ansible Automation Platform Action Groups Support

MAS DevOps Ansible Collection¤

The ibm.mas_devops Ansible Collection is published on Ansible Galaxy and works with all supported releases of IBM Maximo Application Suite. Release information for the collection can be found in GitHub.

Usage¤

Run a Playbook¤

The collection includes a number of playbooks that string together multiple roles, you can directly invoke them after installing the collection:

ansible-playbook ibm.mas_devops.lite_core_roks

Run a Role¤

If you only want to perform a single action, you can directly invoke one of our roles from the command line without the need to build a playbook:

ansible localhost -m include_role -a name=ibm.mas_devops.ocp_verify

You can also use the run_role playbook:

ROLE_NAME=cert_manager ansible-playbook ibm.mas_devops.run_role

Running in Docker¤

The easiest way to use this collection is to take advantage of the ibmmas/cli container image, this negates the need to install anything on your local machine (other than docker - or podman if you prefer).

docker run -ti --rm --pull always quay.io/ibmmas/cli

Local Install¤

Install the collection direct from Ansible Galaxy, you must also install the mas-devops Python package. Python 3.11 is recommended as it is the most widely used version of Python within our development team, but any in-support version of Python should work.

ansible-galaxy collection install ibm.mas_devops
python3 -m pip install mas-devops

Optionally, you can also pin the version of the collection that you install, allowing you to control exactly what version of the collection is in use in your automation:

ansible-galaxy collection install ibm.mas_devops:18.10.4
python3 -m pip install mas-devops

The ansible collection makes use of many dependencies, you can find install scripts showing how we install these dependencies in our own container image in the ibm-mas/cli-base repository, the dependencies you need will be determined by the roles that you intend to use, refer to the roles documentation for dependency infomation.

Tip

Many systems contain more than one installation of Python, when you install the mas-devops package you must install it to the Python that Ansible is configured to use. You can check the version being used by Ansible by reviewing the output of ansible --version.

If you see the error message ERROR! Unexpected Exception, this is probably a bug: No module named 'mas' it almost certainly means that you have not installed the mas-devops package, or have added it to the wrong instance of Python.

Ansible Automation Platform¤

If you wish to use Red Hat Ansible Automation Platform then a Automation Execution Environment image is available at quay.io/ibmmas/ansible-devops-ee that contains the ibm.mas_devops collection at the same release level, plus required client packages and access to the automation content collections supported by Red Hat.

More details on how to use the ansible-devops execution environment can be found here

Action Groups¤

The collection provide a new action group ibm.mas_devops.k8s which can be used to set the default Kubernetes target cluster as an alternative to authenticating with the cluster prior to running our ansible playbooks/roles/actions, see the example below which would return the default storage classes that would be used in this collection for the specified cluster:

---
- hosts: localhost
  any_errors_fatal: true
  collections:
    - ibm.mas_devops

  module_defaults:
    group/ibm.mas_devops.k8s:
      host: "<your host url>"
      api_key: "<your api key>"

  tasks:
    - name: "Lookup default storage classes"
      ibm.mas_devops.get_default_storage_classes:
      register: classes

    - debug:
        msg: "{{classes}}"

Support¤

This Ansible collection is developed by the IBM Maximo Application Suite development team, customers may raise support tickets via the same routes they would an issue with the product itself, or raise an issue directly in the GitHub repository.