Menu

Lumen help

Integrating an Ansible account

Before you can create an Ansible playbook task, you must first integrate an Ansible account into the Edge Services portal. Ansible uses scripts to create playbooks that are stored in a Github repository. When you create an Ansible playbook task, the task retrieves the playbook from the repository.

You can execute your automated task as a single task or combine it as part of an operational or provisioning workflow.

Note: Library tab functionality is only available for AWS (Amazon Web Services) and Azure cloud providers.

To integrate an Ansible account:

  1. Click Library, then click Integrations.

    The Edge Services portal shows the integrations created for your organization.
Edge Service Manager library integrations view
  1. Click + Add, then select Ansible.

    The Edge Services portal shows the Create Ansible Integration window.
New Ansible Integration
  1. In the Create Ansible Integration window, complete the following fields:
Field Description
NAME Type a unique name for the Ansible integration.
ENABLED Select this option to enable the integration. This option is selected by default.
ANSIBLE GIT URL Type the Ansible Git repository in HTTPS or Git URL format to be used for the integration.
DEFAULT BRANCH Type the path of the default Git branch of the playbooks. 
PLAYBOOKS PATH Type the path of the playbooks relative to the Git URL. Include the subdirectories in the URL of the playbook, which come after the Ansible GIT URL. 
ROLES PATH Type the path of the roles related to the Git URL. 
GROUP VARIABLES PATH Type the path of the group variables related to the Git URL. 
HOST VARIABLES PATH Type the path of the host variables related to the Git URL. 
USE ANSIBLE GALAXY Select this option to install the roles defined in Ansible Galaxy. Ansible Galaxy is a website with a command line tool that enables you to create, manage, install, and share roles. 
ENABLE VERBOSE LOGGING Select this option to receive detailed logging for Ansible task history.
USE MORPHEUS AGENT COMMAND BUS  Select this option to execute playbooks through a command bus instead of Single Shell Protocol (SSH). A command bus passes user commands to the handler where they perform the requested actions. 
KEY PAIR Select a previously created key pair for Github SSH authentication.
USERNAME Type your GitHub username. 
PASSWORD Type your GitHub access token. Password authentication is no longer supported. 
ACCESS TOKEN Leave this field blank.
ENABLE GIT REPOSITORY CACHING
  • To use a cached version of code that is less than five minutes old, select this option. 
  • To retrieve code from the repository each time it is invoked, clear this option. We recommend clearing this option.
  1. Click SAVE CHANGES.

    The Edge Services portal integrates the Ansible account..