Google Cloud Build

Overview

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

Prerequisites

• Google Cloud Account: Access to Google Cloud Build for managing build configurations and webhook settings.
• 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 Google Cloud Build.

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 Google Cloud Build will be sent.

2. Debugging and Troubleshooting

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

To configure Google Cloud Build 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 triggers and webhook notifications within Google Cloud Build to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Triggers in Google Cloud Build

To generate the required JSON payloads, you first need to set up triggers within Google Cloud Build.

1. Log in to the Google Cloud Console:

• Access the Google Cloud Console using your account credentials.

1. Navigate to Cloud Build:

• In the Google Cloud Console, go to Cloud Build under the Tools section.

1. Create a New Trigger:

• Click on Create Trigger to create a new build trigger.
• Specify the source repository, branch, or tag that will trigger the build.

1. Configure the Build Steps:

• Define the build steps that should be executed when the trigger is activated.

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", "buildId", "projectId", "startTime", "finishTime", and others as shown in the example payloads.
• Example Payload Setup:

json

{
  "status": "$BUILD_STATUS",
  "buildId": "$BUILD_ID",
  "projectId": "$PROJECT_ID",
  "startTime": "$START_TIME",
  "finishTime": "$FINISH_TIME",
  "source": {
    "repoSource": {
      "repoName": "$REPO_NAME",
      "branchName": "$BRANCH_NAME"
    }
  }
}

• Placeholder Explanation:
• "$BUILD_STATUS": Replaces with the status of the build (e.g., SUCCESS, FAILURE).
• "$BUILD_ID": A unique identifier for the build.
• "$PROJECT_ID": The ID of the Google Cloud project.
• "$START_TIME": The time the build started.
• "$FINISH_TIME": The time the build finished.
• "$REPO_NAME": The name of the source repository.
• "$BRANCH_NAME": The branch name associated with the build.

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.

3.3 Finalizing and Testing

1. Save and Activate the Trigger:

• Once the trigger and webhook are correctly configured, save the trigger configuration and activate it.

1. Validate the Integration:

• Trigger the build manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve any issues with the build or webhook to ensure the resolved state payload is also correctly sent and processed.

3.4 Additional Considerations:

• Permissions: Ensure that the webhook has the necessary permissions to send events to the Callgoose SQIBS API endpoint.
• Security: Implement security measures such as HTTPS and API tokens to protect the data being transmitted between Google Cloud Build 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 Google Cloud Build triggers, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Google Cloud Build

• Build Triggered (status: "SUCCESS")

json

{
  "status": "SUCCESS",
  "buildId": "build-123",
  "projectId": "project-456",
  "startTime": "2024-08-05T12:00:00.000Z",
  "finishTime": "2024-08-05T12:30:00.000Z",
  "source": {
    "repoSource": {
      "repoName": "my-repo",
      "branchName": "main"
    }
  }
}

• Build Failed (status: "FAILURE")

json

{
  "status": "FAILURE",
  "buildId": "build-123",
  "projectId": "project-456",
  "startTime": "2024-08-05T12:00:00.000Z",
  "finishTime": "2024-08-05T12:30:00.000Z",
  "source": {
    "repoSource": {
      "repoName": "my-repo",
      "branchName": "main"
    }
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Google Cloud Build 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: [FAILURE, INTERNAL_ERROR]
• Map Incident With: "buildId"
• This corresponds to the unique buildId from the Google Cloud Build payload.
• Incident Title From: "source.repoSource.repoName"
• This will use the source repository 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.
• 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 failed due to an internal error".

Resolve Filter (For Resolving Incidents):

• Payload JSON Key: "status"
• Key Value Contains: [SUCCESS]
• Incident Mapped With: "buildId"
• This ensures the incident tied to the specific buildId is resolved when the build status returns to normal (e.g., "SUCCESS").

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 Google Cloud Build.

1. Test the Integration:

• Manually trigger a build in Google Cloud Build 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 build in Google Cloud Build and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Builds

1. Simulate a Build Trigger:

• Push code to the repository or manually trigger a build to cause an event in Google Cloud Build.
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Incidents

1. Acknowledge and Resolve the Incident:

• Once the build is successful or manually resolved in Google Cloud Build, 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.
• Google Cloud Build Permissions: Confirm that the webhook in Google Cloud Build has appropriate permissions to send events and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between Google Cloud Build 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 Google Cloud Build 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 Google Cloud Build matches the expected structure.

8. Conclusion

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

• Google Cloud Build 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 build events from Google Cloud Build.