Skip to main content

Install the Ansible Integration

Automate event actions between Ansible and BigPanda.

BigPanda supports a standard integration for both the Ansible Automation Platform and Ansible Automation with EDA Controller.

Ansible Automation Platform

Ansible Automation Platform is an enterprise platform used to configure systems, deploy software, and automate repetitive processes across the IT infrastructure.

Create an App Key

Create an app key in BigPanda.

Integration specific

You'll need a separate app key for each integrated system.

https://files.readme.io/9865f2f-Integrations_App_Key_Creation.jpg

App Key Configuration in BigPanda

Get an Ansible Automation Platform API Token

  1. Navigate to the Users section in Ansible Automation Platform.

  2. Select the user that needs a token.

  3. Under the Token section on the Users page, click Add. This action will open the Create user token page.

  4. In the Description field, add a descriptor to easily identify this token.

  5. In the Scope section, select Write.

  6. Click Save. This will open a modal displaying the generated token. Make sure to save it for future use.

Configure the Integration Webhook

  1. In the x-bp-config-ansible URL field, enter the URL of your Default Ansible Automation Platform account. To find the URL, go to the Ansible Automation Platform dashboard and copy the address before /#/home.

  2. Go to the template you want to run and get the template ID from the URL /templates/job_template/<TEMPLATE-ID>/details. Set this value as x-bp-config-defaultTemplateId.

  3. Enter the token you created in the previous section in the x-bp-config-ansibleApiToken field.

  4. Select Configure Webhook.

Note: When executing multiple Job Templates, there are two options available:

  • Create separate integrations for each job template with a x-bp-config-defaultTemplateId This approach allows you to assign a specific job template to each incident as a whole.

  • Set x-bp-config-automateIndividualAlerts to true and configure x-bp-config-alertTemplateIdTagname to select an alert tag. By doing this, each alert with a specific tag will trigger a corresponding job template based on that tag. If you have x-bp-config-defaultTemplateId set, the alerts will be sent to that job template ID instead.

Integrations_Webhook_Builder_Simple.jpg
Integrations_Webhook_Builder_Simple.jpg

Ansible with EDA Controller

If you are using an EDA Controller, select Ansible Automation Platform with EDA Controller when you install the integration.

Create an App Key

Create an app key in BigPanda.

Integration specific

You'll need a separate app key for each integrated system.

https://files.readme.io/9865f2f-Integrations_App_Key_Creation.jpg

App Key Configuration in BigPanda

Get an Ansible Automation Platform API Token

  1. Navigate to the Users section in Ansible Automation Platform.

  2. Select the user that needs a token.

  3. Under the Token section on the Users page, click Add. This action will open the Create user token page.

  4. In the Description field, add a descriptor to easily identify this token.

  5. In the Scope section, select Write.

  6. Click Save. This will open a modal displaying the generated token. Make sure to save it for future use.

Set up a Default EDA Webhook Rulebook

Note: Ensure that port 6000 is available in your EDA Controller instance.

  1. Log into your EDA Controller instance.

  2. Navigate to Projects and initiate a new project creation.

  3. Update the project name with a descriptive identifier.

  4. Update the SCM URL with the following URL: https://github.com/bigpandaio/bigpanda-ansible.

  5. Click Create project.

  6. Navigate to Views > Rulebook Activations and create a new rulebook activation.

  7. Choose the project created in the previous steps.

  8. From the Rulebook dropdown, select bigpanda-webhook.yml.

  9. Provide a descriptive name and select the appropriate decision environment.

  10. Click Create rulebook activation.

Configure the Integration Webhook

  1. In the webhook URL field, input the URL of your EDA controller host.

  2. Select Configure Webhook.

Note: Ensure that a rulebook is actively running to filter the events.

Integrations_Webhook_Builder_Simple.jpg
Integrations_Webhook_Builder_Simple.jpg