• Ansible Morpheus Collection - Core
  • Requirements
  • Installation
    • Ansible 2.9
    • Ansible >= 2.10
  • Inventory Plugin Usage
    • Inventory Variables
    • Examples
      • Use in Morpheus
      • Name or Label
      • Tag
      • App
      • Cloud
    • Token Requirement
  • Ansible Roles for Morpheus Setup
  • Support Expectations

• Ansible >= 2.9

Ansible made many changes in versions past 2.9, but the collection installation methods should work for every version.

If you wish to install from Ansible galaxy, use the following: ansible-galaxy collection install morpheus.core

NOTE

Ansible 2.9 doesn't recognize the collection's inventory plugins once the collection is installed. Follow these instructions to use the inventory plugin in Ansible 2.9.

This has been tested both with the EPEL and pip installed versions of Ansible, so this method should be fairly portable.

If it doesn't exist, create the directory /usr/share/ansible/plugins/inventory

mkdir -p /usr/share/ansible/plugins/inventory

Install the collection. By default, the collection will be installed at ~/.ansible/collections/ansible_collections/morpheus/core

ansible-galaxy collection install morpheus.core

Copy or symlink the plugins/inventory/morpheus_inventory.py file to the /usr/share/ansible/plugins/inventory directory.

cp ~/.ansible/collections/ansible_collections/morpheus/core/plugins/inventory/morpheus_inventory.py /usr/share/ansible/plugins/inventory/

Run ansible-doc to confirm installation

ansible-doc -t inventory -l | grep morpheus

When using this module with Ansible 2.9, you will refer to the module in your YAML file as:

plugin: morpheus_inventory

Install the collection through Ansible

ansible-galaxy collection install morpheus.core

Run ansible-doc to confirm installation

ansible-doc -t inventory -l | grep morpheus

When using this module as a collection with Ansible >= 2.10, refer to the module in your YAML file as:

plugin: morpheus.core.morpheus_inventory

Within Morpheus, the dynamic inventory plugin will query the API and return a set of targets based on your search and organaizational criteria.

NOTES

Morpheus versions <= 5.0.0 require an API token in the inventory file to provide access to the Morpheus API. Look in the Examples section for an example using Ansible Vault.

Create an Ansible Task in Morpheus and specify the playbook you wish to run. Set the Execute Target to Local.

In Command Options specify -i <relative path>/morpheusinv.yml

This will process morpheusinv.yml as a dynamic inventory using the specified plugin.

NOTES

This plugin requires the Morpheus agent on target hosts due to credential storage methods in Morpheus.

Name searches are a simple text match. If your string is in the name anywhere, it will match. Label must match exactly, but is case insensitive.

Example:

plugin: morpheus_inventory
groups:
  - name: morphtest
    searchtype: label
    searchstring: whateverlabel
morpheus_url: <your morpheus URL>
morpheus_api_key: <your API key>

This will create a group morphtest and add any instances that have the label whateverlabel applied in Morpheus.

The tag search requires a tag name and value to be specified to add instances to a specified group.

Example:

plugin: morpheus_inventory
groups:
  - name: dockerhosts
    searchtype: tag
    searchstring:
      tagName: servertype
      tagValue: docker
  - name: morpheus_ui
    searchtype: tag
    searchstring:
      tagName: application
      tagValue: morpheus
morpheus_url: <your morpheus URL>
morpheus_api_key: <your API key>

This will create 2 groups. Instances tagged with a servertype tag with a value of docker will be put into the dockerhosts group. Instances tagged with an application tag with a value of morpheus will be put into the morpheus_ui group.

The App search type will create a group named name out of the instances in the apptier tier of app appname.

Example:

plugin: morpheus_inventory
groups:
  - name: ui
    searchtype: app
    searchstring:
      appname: 2tier
      apptier: UI
  - name: db
    searchtype: app
    searchstring:
      appname: 2tier
      apptier: Database
morpheus_url: <your morpheus URL>
morpheus_api_key: <your API key>

This will create two groups: ui and db. ui will contain instances from the UI tier of the 2tier application that was deployed in Morpheus from a blueprint. db will contain instances from the Database tier of the 2tier application.

Cloud types will match the searchstring against the cloud code or id and generate groups based on remote tags as <key>_<value>. It will also generate groups based on platform as seen by the Morpheus agent. Unknown or agent-less VMs will appear under the platform_undetected group.

Example:

plugin: morpheus_inventory
groups: 
  - searchtype: cloud
    searchstring: vmware
morpheus_url: <your morpheus URL>
morpheus_api_key: <your API key>

Since the inventory file will need to be stored in a git repository, it is not advised to store it in plain text.

We suggest encrypting the API token with Ansible Vault with the vault password stored in a file on the Morpheus UI server(s).

Acquire a token by going in your Morpheus user settings and clicking the API Access button. Any entry will be sufficient. Regenerate an Access Token and copy it.

On your Morpheus server, create a directory under /var/opt/morpheus/morpheus-ui to store the Ansible vault password. Restrict permissions on this directory to the Morpheus user that runs Ansible: morpheus-local

install -o morpheus-local -g morpheus-local -m 0770 -d /var/opt/morpheus/morpheus-ui/ansiblevault

In your task, specify --vault-password-file /var/opt/morpheus/morpheus-ui/ansiblevault/<file> in order to use the password.

Information on encrypting strings and variables for ansible is located HERE

These roles are designed for net new Morpheus configurations. They are NOT designed for removing existing items.

See README files in roles/ for information regarding the roles in this collection

Please refer to the Morpheus Open Source Code Support Policy