BigPanda Ansible Collection
After following the installation steps, you can deploy our certified integration to the Ansible Automation Tower and event-driven automation.
Use and develop the BigPanda Ansible collection
To use and develop with the BigPanda Ansible Collection, follow these steps:
Run the following commands to build and install the collection in the ./collections folder. You will need to perform this step whenever you make changes:
``` ansible-galaxy collection build --force ansible-galaxy collection install bigpanda-incident-<VERSION>.tar.gz -p ./collections -f ```
Run the Ansible playbook for testing. Replace the placeholders with your specific information:
``` ansible-playbook ./bigpanda_test.yml --extra-vars='{"environment_id": "YOUR-ENV-ID","api_token": "YOUR-API-TOKEN", "incident_id":"YOUR-INCIDENT-ID", "tag_id": "test", "tag_value": "success"}' ```
Running in an instance
To run in an instance, you'll need to create a decision environment for Event-Driven Automation (EDA) and/or an execution environment for Ansible Automation Platform (AAP). Follow these guides:
These guides will help you set up the necessary environments for BigPanda Ansible Collection.
Responding to BigPanda Events
BigPanda sends a variety of event types depending on what happens within a BigPanda incident. We recommend configuring Ansible playbooks to trigger based on the most recent event_type included in the array of events. For more information, see the webhook data schema.
``` incident#become-flapping incident#reopen incident#closed incident#updated incident#new incident#commented incident#snoozed incident-tag#upserted incident#ticket-sync ```
Share update delay
By default, the incident#ticket-sync event sends incident updates every 2.5 minutes to prevent spamming target systems with updates. To lower this, contact BigPanda Support and request a lower share update delay setting (typically 5 or 10 seconds is advised). This event type will be deprecated with the rollout of BigPanda's Delayed Autoshare feature.
Action Modules
The BigPanda Ansible Collection provides various action modules to interact with the BigPanda resource management system. These modules allow you to perform operations such as resolving incidents, resolving alerts, adding comments to incidents, and updating incident tags.
To use these action modules, include them in your Ansible playbook and provide the required parameters for the specific function you want to execute.
Resolve an Incident
Use the bigpanda.incident.resolve action module to resolve an incident by providing the incident ID and a resolution message.
Parameters:
incident_id(required): The ID of the incident to resolve.resolution_comment: The resolution message for the incident.api_token(required): The API token for authentication.
``` Example
- name: Resolve Incident
bigpanda.incident.resolve:
incident_id: <incident_id>
resolution_comment: <resolution_comment>
api_token: <api_token>
```Resolve Alerts
The bigpanda.incident.resolveAlerts module allows you to resolve an alert by providing the alert ID and resolution message.
Parameters:
alert_ids(required): The ID of the alert to resolve.resolution: The resolution message for the alert.api_token(required): The API token for authentication.
``` Example
- name: Resolve Alert
bigpanda.incident.resolveAlert:
alert_ids: <alert_id>
resolution: <resolution>
api_token: <api_token>
```Add a Comment to an Incident
You can add a comment to an incident using the bigpanda.incident.comment module. Provide the incident ID and the comment text.
Parameters:
incident_id(required): The ID of the incident to add a comment to.comment(required): The text of the comment.api_token(required): The API token for authentication.
``` Example
- name: Add Comment to Incident
bigpanda.incident.comment:
incident_id: <incident_id>
comment: <comment>
api_token: <api_token>
```
Update Incident Tag
Use the bigpanda.incident.updateIncidentTag module to update an incident tag. Provide the tag ID, tag value, incident ID, and API token.
Parameters:
tag_id(required): The ID of the tag to update.tag_value(required): The new value for the tag.incident_id(required): The ID of the incident to update.api_token(required): The API token for authentication.
``` Example
- name: Update Incident Tag
bigpanda.incident.updateIncidentTag:
tag_id: <tag_id>
tag_value: <tag_value>
incident_id: <incident_id>
api_token: <api_token>
```Uninstall the Integration
Deleting an integration requires that you remove the integration in both the integrated system and BigPanda. We recommend that you first uninstall the integration on the integrated system to prevent traffic from being sent and rejected by BigPanda, since the app_key will not exist once you delete the integration in BigPanda.
Caution during replacement
When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.
Stop Sending Data from BigPanda
In BigPanda, disable any settings that send data to the integrated system. This includes modifying or removing AutoShare rules or Environments that are tied to the integration.
Delete the Integration in BigPanda
Take the following steps to delete the integration from BigPanda:
In BigPanda, navigate to the Integrations tab and select the desired integration from the list.
In the integration details on the right of the page, click the trash icon, then confirm you want to delete the integration. The integration will be removed immediately.
️Data removal
This procedure does not remove any data from BigPanda or the integrated system. As needed, remove data from each system before deleting the integration.
Caution during replacement
When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.
Stop Sending Data from BigPanda
In BigPanda, disable any settings that send data to the integrated system. This includes modifying or removing AutoShare rules or Environments that are tied to the integration.
Delete the Integration in BigPanda
Take the following steps to delete the integration from BigPanda:
In BigPanda, navigate to the Integrations tab and select the desired integration from the list.
In the integration details on the right of the page, click the trash icon, then confirm you want to delete the integration. The integration will be removed immediately.