Bitbucket pipelines

Overview

This document provides a detailed guide to integrating Bitbucket Pipelines with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, Event-Driven Automation, and other automation purposes. The integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on events triggered in Bitbucket Pipelines. The guide includes steps for setting up events in Bitbucket Pipelines, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• Bitbucket Account: Access to Bitbucket Pipelines for configuring webhooks and managing pipelines.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from Bitbucket Pipelines.

1. Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

• Generate an API Token:
• Follow the guide on How to Create API Token in Callgoose SQIBS.
• Find the API Endpoint:
• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from Bitbucket Pipelines will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with Bitbucket Pipelines notifications for troubleshooting purposes.

• Enable Debugging:
• You can update the debug value when adding or updating an API token.
• When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
• When API tracking is turned off, no logs are saved in the API log.
• Using API Log for Troubleshooting:
• The API log provides detailed information on all API calls made to Callgoose SQIBS.
• You can check the JSON values in each API log entry for troubleshooting purposes.
• Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
• Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3. Configuring Bitbucket Pipelines to Send JSON Payloads

To configure Bitbucket Pipelines to generate the JSON payloads similar to the examples provided, follow the steps outlined below. These steps will guide you through setting up the necessary events and webhook notifications within Bitbucket Pipelines to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Events in Bitbucket Pipelines

To generate the required JSON payloads, you first need to set up events within Bitbucket Pipelines.

• Log in to the Bitbucket Console:
• Access the Bitbucket platform using your account credentials.
• Navigate to the Repository Settings:
• In the Bitbucket console, go to the repository where you want to configure the pipeline events.
• Create a New Pipeline:
• Set up a new pipeline or configure an existing one to trigger events.
• Configure the Notification Method:
• Choose Webhook as the notification method to send data to a webhook.
• Webhook URL: Enter the webhook URL provided by Callgoose SQIBS.

3.2 Configuring the Webhook Notification

To ensure that the JSON payload sent matches the examples provided, follow these steps when configuring the webhook:

• Add Webhook URL:
• In the Webhook URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.
• Customize Payload Format:
• Ensure that the payload includes key fields like "state", "build_number", "commit_message", "pipeline_id", and others as shown in the example payloads.
• Example Payload Setup:

json

{
  "pipeline": {
    "id": "$PIPELINE_ID",
    "state": "$STATE",
    "build_number": "$BUILD_NUMBER",
    "commit_message": "$COMMIT_MESSAGE",
    "timestamp": "$TIMESTAMP"
  }
}

• Placeholder Explanation:
• "$STATE": Replaces with the state of the pipeline (e.g., SUCCESSFUL, FAILED).
• "$PIPELINE_ID": A unique identifier for the pipeline.
• "$BUILD_NUMBER": The build number of the pipeline run.
• "$COMMIT_MESSAGE": The commit message associated with the pipeline run.
• "$TIMESTAMP": The time the pipeline event occurred.
• Test the Webhook Configuration:
• Before activating the webhook, perform a test to ensure that the JSON payload is correctly formatted and is being sent to the Callgoose SQIBS API endpoint as expected.
• Review the payload in Callgoose SQIBS to confirm that it matches the expected structure.

3.3 Finalizing and Testing

• Save and Activate the Event:
• Once the event and webhook are correctly configured, save the event configuration and activate it.
• Validate the Integration:
• Trigger the event condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve the event to ensure the resolved state payload is also correctly sent and processed.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the Bitbucket Pipelines events, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Bitbucket Pipelines

Event Triggered (state: "FAILED"):

json

{
  "pipeline": {
    "id": "pipeline123",
    "state": "FAILED",
    "build_number": "42",
    "commit_message": "Fix issue with deployment",
    "timestamp": "2024-08-05T12:00:00.000Z"
  }
}

Event Resolved (state: "SUCCESSFUL"):

json

{
  "pipeline": {
    "id": "pipeline123",
    "state": "SUCCESSFUL",
    "build_number": "43",
    "commit_message": "Issue resolved",
    "timestamp": "2024-08-05T12:30:00.000Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Bitbucket Pipelines integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: "state"
• Key Value Contains: [FAILED]
• Map Incident With: "pipeline.id"
• This corresponds to the unique pipeline.id from the Bitbucket Pipelines payload.
• Incident Title From: "pipeline.commit_message"
• This will use the commit message as the incident title in Callgoose SQIBS.
• Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "state"
• Key Value Contains: [SUCCESSFUL]
• Incident Mapped With: "pipeline.id"
• This ensures the incident tied to the specific pipeline.id is resolved when the event state returns to normal.

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

• Save the API Filters:
• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by Bitbucket Pipelines.
• Test the Integration:
• Manually trigger an event in Bitbucket Pipelines to test if incidents are created in Callgoose SQIBS.
• Verify that the incident appears in Callgoose SQIBS with the correct title, description, and mapped values.
• Resolve the event in Bitbucket Pipelines and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Events

• Simulate a Pipeline Event:
• Trigger a condition in Bitbucket Pipelines that causes an event (e.g., a failed build or deployment).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Events

• Acknowledge and Resolve the Event:
• Once the issue is resolved in Bitbucket Pipelines (e.g., a successful build or deployment after a failure), verify that the incident in Callgoose SQIBS is automatically marked as resolved.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured and that the API token is securely stored and used.
• Bitbucket Pipelines Permissions: Confirm that the webhook in Bitbucket Pipelines has appropriate permissions to send events and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between Bitbucket Pipelines and Callgoose SQIBS is encrypted, especially if sensitive information is involved.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in Bitbucket Pipelines is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by Bitbucket Pipelines matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate Bitbucket Pipelines with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that events from Bitbucket Pipelines are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the issues are resolved.

For further customization or advanced use cases, refer to the official documentation for both Bitbucket Pipelines and Callgoose SQIBS:

• Bitbucket Pipelines Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API

This documentation will guide you through the integration process, ensuring that your incidents are managed effectively within Callgoose SQIBS based on real-time events from Bitbucket Pipelines.