Spacelift

Overview

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

Prerequisites

• Spacelift Account: Access to Spacelift 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 Spacelift.

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

2. Debugging and Troubleshooting

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

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

2.2 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 Spacelift to Send JSON Payloads

To configure Spacelift to generate the appropriate JSON payloads for Callgoose SQIBS, follow the steps below. These will guide you through setting up the necessary alerts and webhook notifications within Spacelift to ensure that the JSON payloads match the expected format.

3.1 Setting Up Alerts in Spacelift

• Log in to Spacelift:
• Access the Spacelift Console using your account credentials.
• Refer to Create Your Spacelift Account for more details on how to log in.
• Create a Stack
• From the homepage, go to the Stacks section.
• Click the Create Stack button.
• Enter the required details such as name, space, labels, and description, and then click on Continue.
• Provide the repository URL where your source code is stored and click on Continue.
• Select the vendor for your infrastructure (e.g., Terraform/OpenTofu) and click on Create & Continue.
• Fill out any remaining optional details and click on Confirm to finalize the stack creation.
• For more details refer Stack.

3.2 Set Up Webhook for JSON Payloads

• Navigate to Stack Settings:
• To configure a webhook for your stack, navigate to the settings of the created stack. Click on the three dots and select Settings.
• Go to Integrations:
• In the settings menu, click on Integrations and then select Webhooks.
• Create a New Webhook:
• Click on Create Webhook.
• In the Endpoint field, provide the Callgoose SQIBS endpoint URL.
• Finalize the URL format by following the instructions provided in the API endpoint documentation from Callgoose SQIBS.
• Save the Webhook:
• After filling in the required information, click on Create to complete the webhook setup.

3.3 Test and Validate Webhook Configuration:

• 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 Spacelift alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Spacelift

Alert Triggered (state: "FAILED")

json

{
  "account": "test2247",
  "state": "FAILED",
  "stateVersion": 5,
  "timestamp": 1727692501,
  "run": {
    "id": "****",
    "branch": "main",
    "commit": {
      "authorName": "****",
      "hash": "****",
      "message": "Remove db.sqlite3 from Git's tracking",
      "timestamp": 1716630685,
      "url": "https://github.com/****/****/commit/****"
    },
    "createdAt": 1727692501,
    "driftDetection": false,
    "triggeredBy": "****@rit.ac.in",
    "type": "TRACKED",
    "url": "https://test2247.app.spacelift.io/stack/test/run/****"
  },
  "stack": {
    "id": "test",
    "name": "Test",
    "description": "",
    "labels": [],
    "repository": "****/****",
    "url": "https://test2247.app.spacelift.io/stack/test",
    "vcs": "GIT"
  },
  "workerPool": {
    "public": true,
    "labels": [],
    "id": "",
    "name": ""
  }
}

Alert Resolved (state: "FINISHED")

json

{
  "account": "test2247",
  "state": "FINISHED",
  "stateVersion": 5,
  "timestamp": 1727692561,
  "run": {
    "id": "****",
    "branch": "main",
    "commit": {
      "authorName": "****",
      "hash": "****",
      "message": "Remove db.sqlite3 from Git's tracking",
      "timestamp": 1716630685,
      "url": "https://github.com/****/****/commit/****"
    },
    "createdAt": 1727692561,
    "delta": {
      "added": 0,
      "changed": 0,
      "deleted": 0,
      "resources": 0
    },
    "driftDetection": false,
    "triggeredBy": "****@rit.ac.in",
    "type": "TRACKED",
    "url": "https://test2247.app.spacelift.io/stack/test/run/****"
  },
  "stack": {
    "id": "test",
    "name": "Test",
    "description": "",
    "labels": [],
    "repository": "****/****",
    "url": "https://test2247.app.spacelift.io/stack/test",
    "vcs": "GIT"
  },
  "workerPool": {
    "public": true,
    "labels": [],
    "id": "",
    "name": ""
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Spacelift 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: [QUEUED, READY, PREPARING, INITIALIZING, FAILED]
• Map Incident With: "run"."commit"."hash"
• This corresponds to the unique commit hash from the Spacelift payload.
• Incident Title From: “account"
• This will use the account 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 "run"."commit"."message" key in the Incident Description From field, the incident description will be the value of the "run"."commit"."message" key. In the example JSON payload provided earlier, this would result in a description like "Remove db.sqlite3 from Git's tracking".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "state"
• Key Value Contains: [FINISHED]
• Incident Mapped With: "run"."commit"."hash"
• This ensures the incident tied to the specific "run"."commit"."hash" is resolved when the alert status 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 Spacelift.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Pipeline Failure:
• Trigger a condition in Spacelift that causes a pipeline to fail (e.g., an error in one of the stages).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in Spacelift (e.g., the pipeline completes successfully after the error is fixed), 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.
• Spacelift Permissions: Confirm that the webhook in Spacelift has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in Spacelift 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 Spacelift matches the expected structure.

8. Conclusion

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

• Spacelift 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 Spacelift.