AWS CodePipeline

Overview

This document provides a detailed guide to integrating AWS CodePipeline 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 alerts triggered in AWS CodePipeline. The guide includes steps for setting up alerts in AWS CodePipeline, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• AWS Account: Access to AWS CodePipeline for creating alerts and managing notifications.
• 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 AWS CodePipeline.

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 AWS CodePipeline will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with AWS CodePipeline 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 AWS CodePipeline to Send JSON Payloads

To configure AWS CodePipeline 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 alerts and webhook notifications within AWS CodePipeline to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Alerts in AWS CodePipeline

To generate the required JSON payloads, you first need to set up alerts within AWS CodePipeline.

• Log in to the AWS Management Console:
• Access the AWS platform using your account credentials.
• Navigate to CodePipeline:
• Go to the AWS CodePipeline service in your AWS account.
• Create or Select a Pipeline:
• Choose the pipeline you want to monitor or create a new one.
• Configure Notifications:
• In the pipeline settings, add a notification rule to trigger when specific events occur (e.g., pipeline execution starts, fails, or completes).
• Choose the event types that should trigger a notification.

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 notification rule, set the webhook URL provided by Callgoose SQIBS.
• Customize Payload Format:
• Ensure that the payload includes key fields like status, pipeline, stage, action, and executionId.
• Example Payload Setup:

json

{
  "detail": {
    "pipeline": "my-pipeline",
    "execution-id": "1234567890",
    "state": "FAILED",
    "action": {
      "actionTypeId": {
        "category": "Build",
        "owner": "AWS",
        "provider": "CodeBuild",
        "version": "1"
      },
      "name": "Build"
    },
    "stage": "Build",
    "region": "us-west-2"
  }
}

• 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 Notification:
• Once the notification rule and webhook are correctly configured, save the configuration and activate it.
• Validate the Integration:
• Trigger the pipeline manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Check if the incident is created and resolved as expected.

3.4 Additional Considerations

• Permissions: Ensure that the webhook has the necessary permissions to send alerts to the Callgoose SQIBS API endpoint.
• Security: Implement security measures such as HTTPS and API tokens to protect the data being transmitted between AWS CodePipeline and Callgoose SQIBS.
• Logging and Debugging: Use the debugging and logging features in Callgoose SQIBS to monitor incoming payloads and troubleshoot any issues with the integration.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the AWS CodePipeline alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from AWS CodePipeline

Alert Triggered (state: "FAILED")

json

{
  "detail": {
    "pipeline": "my-pipeline",
    "execution-id": "1234567890",
    "state": "FAILED",
    "action": {
      "actionTypeId": {
        "category": "Build",
        "owner": "AWS",
        "provider": "CodeBuild",
        "version": "1"
      },
      "name": "Build"
    },
    "stage": "Build",
    "region": "us-west-2"
  }
}

Alert Resolved (state: "SUCCEEDED")

json

{
  "detail": {
    "pipeline": "my-pipeline",
    "execution-id": "1234567890",
    "state": "SUCCEEDED",
    "action": {
      "actionTypeId": {
        "category": "Build",
        "owner": "AWS",
        "provider": "CodeBuild",
        "version": "1"
      },
      "name": "Build"
    },
    "stage": "Build",
    "region": "us-west-2"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an AWS CodePipeline 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: "detail.state"
• Key Value Contains: [FAILED, CANCELED]
• Map Incident With: "detail.execution-id"
• This corresponds to the unique execution ID from the AWS CodePipeline payload.
• Incident Title From: "detail.pipeline"
• This will use the pipeline name 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: "detail.state"
• Key Value Contains: [SUCCEEDED]
• Incident Mapped With: "detail.execution-id"
• This ensures the incident tied to the specific execution ID is resolved when the alert 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 AWS CodePipeline.
• Test the Integration:
• Manually trigger a pipeline in AWS CodePipeline 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 pipeline execution in AWS CodePipeline and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Pipeline Execution Failure:
• Cause a failure in your AWS CodePipeline (e.g., by introducing a build error) to trigger the alert.
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Resolve the Pipeline Execution:
• Fix the issue in AWS CodePipeline and allow the pipeline to complete successfully.
• 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.
• AWS Permissions: Confirm that the webhook in AWS CodePipeline has appropriate permissions to send alerts and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between AWS CodePipeline 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 AWS CodePipeline 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 AWS CodePipeline matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate AWS CodePipeline with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from AWS CodePipeline 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 AWS CodePipeline and Callgoose SQIBS:

• AWS CodePipeline
• 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 alerts from AWS CodePipeline.