CloudBees CodeShip

Overview

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

Prerequisites

• CloudBees CodeShip Account: Access to CloudBees CodeShip for setting up notifications and managing builds.
• 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 CloudBees CodeShip.

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.

1. Generate an API Token:

• Follow the guide on How to Create API Token in Callgoose SQIBS.

1. Find the API Endpoint:

• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from CloudBees CodeShip will be sent.

2. Debugging and Troubleshooting

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

To configure CloudBees CodeShip 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 notifications within CloudBees CodeShip to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Notifications in CloudBees CodeShip

To generate the required JSON payloads, you first need to set up notifications within CloudBees CodeShip.

1. Log in to the CloudBees CodeShip Console:

• Access the CloudBees CodeShip platform using your account credentials.

1. Navigate to the Notification Settings:

• In the CloudBees CodeShip console, go to your project and select Notification Settings.

1. Create a New Notification:

• Click on Add Notification to create a new notification.
• Specify Conditions: Define the conditions that will trigger the notification, such as build success, failure, or deployment events.

1. 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:

1. Add Webhook URL:

• In the Webhook URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.

1. Customize Payload Format:

• Ensure that the payload includes key fields like "status", "event", "severity", "description", "timestamp", and others as shown in the example payloads.

1. Example Payload Setup:

json

{
  "event": {
    "id": "$EVENT_ID",
    "status": "$STATUS",
    "severity": "$SEVERITY",
    "description": "$DESCRIPTION",
    "build_url": "$BUILD_URL",
    "timestamp": "$TIMESTAMP"
  }
}

1. Placeholder Explanation:

• "$STATUS": Replaces with the status of the build (e.g., success, failure).
• "$EVENT_ID": A unique identifier for the event.
• "$SEVERITY": The level of urgency.
• "$DESCRIPTION": A descriptive message of the event.
• "$BUILD_URL": The URL of the build in CodeShip.
• "$TIMESTAMP": The time the event occurred.

1. 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.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from CloudBees CodeShip

Alert Triggered (status: "failed")

json

{
  "event": {
    "id": "build123",
    "status": "failed",
    "severity": "high",
    "description": "Build #123 failed",
    "build_url": "https://codeship.com/projects/123/builds/123",
    "timestamp": "2024-08-05T12:00:00.000Z"
  }
}

Alert Resolved (status: "passed")

json

{
  "event": {
    "id": "build123",
    "status": "passed",
    "severity": "low",
    "description": "Build #123 passed",
    "build_url": "https://codeship.com/projects/123/builds/123",
    "timestamp": "2024-08-05T12:30:00.000Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a CloudBees CodeShip 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: "status"
• Key Value Contains: [failed, error]
• Map Incident With: "event.id"
• This corresponds to the unique event.id from the CloudBees CodeShip payload.
• Incident Title From: "event.description"
• This will use the event description 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.
• Example: If you use the "description" key in the Incident Description From field, the incident description will be the value of the "description" key. In the example JSON payload provided earlier, this would result in a description like "Build #123 failed".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [passed]
• Incident Mapped With: "event.id"
• This ensures the incident tied to the specific event.id is resolved when the alert status returns to normal.

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

4.3 Finalizing Setup

1. 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 CloudBees CodeShip.

1. Test the Integration:

• Manually trigger an alert in CloudBees CodeShip 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 alert in CloudBees CodeShip and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Alerts

1. Simulate a Build Failure:

• Trigger a build failure in CloudBees CodeShip to cause an alert (e.g., introduce an error in the code that will fail the build process).
• Verify that an incident is created in Callgoose SQIBS with the correct information based on the JSON payload received.

5.2 Resolving Alerts

1. Fix the Build Issue:

• Correct the issue that caused the build failure in CloudBees CodeShip and trigger a successful build.
• Verify that the incident in Callgoose SQIBS is automatically marked as resolved when the build passes.

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.
• CloudBees CodeShip Permissions: Confirm that the webhook in CloudBees CodeShip has appropriate permissions to send alerts and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between CloudBees CodeShip 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 CloudBees CodeShip 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 CloudBees CodeShip matches the expected structure.

8. Conclusion

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

• CloudBees CodeShip 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 alerts from CloudBees CodeShip.