connector-spacelift

command module
v0.0.0-...-7310240 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 30, 2022 License: MIT Imports: 5 Imported by: 0

README

Spacelift Connector

The Spacelift connector allows for the ingestion of Audit Trail events from Spacelift. To setup the connector, use the following guide and ensure that the URL used for the ingestion ends with /integrations/spacelift/audit.

Endpoints

Url Methods Description
/ingest POST Captures a given event into the system (assuming it passes validation and ingestion policies)
/_system/health GET The liveness health check endpoint
/_system/health/ready GET The readiness health check endpoint

Configuration

The Spacelift connector looks the following configuration objects within a Kubernetes cluster:

  • ConfigMaps:
    • connector-spacelift-cm
  • Secrets:
    • connector-spacelift-secret
    • ingestion-secret
ConfigMap - connector-spacelift-cm
Key Description
ingestion.uri The path of the ingestion API, including the /ingest suffix. Default: http://keas-ingestion.keas.svc.cluster.local/ingest
log.level The log level that should be written to the console. Default: debug
server.port The port to listen on. It can be useful to change this for local development. Default: 5000
Secret - connector-spacelift-secret

This secret is required. If the secret does not exist, the readiness checks will fail.

Key Description
spacelift.webhook.token The secret used to validate that the incoming requests are indeed coming from Spacelift. This must match what's you set on the Spacelift UI
Secret - ingestion-secret

This secret is required. If the secret does not exist, the readiness checks will fail. This secret is often setup by the Ingestion API.

Key Description
ingestion.auth.token The API Key that's used for authentication against the ingestion API

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
handlers
services

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL