CI/CD for Monitoring as Code

Deploy your monitoring configuration automatically on every push. Preview changes in pull requests and gate deploys on validation.

Workflow pattern

The standard CI/CD pattern for monitoring as code:

PR opened → validate + plan → merge → deploy

On PR: Run devhelm validate and devhelm plan to catch errors and preview changes
On merge to main: Run devhelm deploy --yes to apply the configuration

Choose your tool

GitHub Actions

Official setup-devhelm action with caching, version pinning, and verification.

Generic CI

GitLab CI, Jenkins, CircleCI, Bitbucket — any system that runs npm.

Multi-environment

Deploy different configs to staging and production.

Terraform CI/CD

Terraform plan and apply in CI pipelines.

Key concepts

Validate → Plan → Deploy

Stage	Command	API calls	Writes
Validate	`devhelm validate devhelm.yml`	None	None
Plan	`devhelm plan -f devhelm.yml`	Read-only	None
Deploy	`devhelm deploy -f devhelm.yml --yes`	Read + write	Yes

Exit codes for gating

Use --detailed-exitcode to make deploy decisions in CI:

devhelm deploy -f devhelm.yml --dry-run --detailed-exitcode

Exit code	Meaning	CI action
`0`	No changes	Pass
`10`	Changes pending	Flag for review or auto-deploy
`4`	Validation error	Fail the build
`11`	API error	Fail the build
`1`	Other error	Fail the build

Deploy locking

The CLI acquires a lock before applying changes. Only one deploy runs at a time per organization. In CI, use --lock-timeout to queue behind other deploys:

devhelm deploy -f devhelm.yml --yes --lock-timeout 60

Secret management

Store DEVHELM_API_TOKEN and other sensitive values as CI secrets. Reference them in YAML with ${VAR} syntax:

alertChannels:
  - name: Slack Alerts
    config:
      channelType: slack
      webhookUrl: ${SLACK_WEBHOOK_URL}

Overview

YAML Format

Deploy Workflow

Terraform Provider

CI/CD Patterns

CI/CD for Monitoring as Code

Workflow pattern

Choose your tool

GitHub Actions

Generic CI

Multi-environment

Terraform CI/CD

Key concepts

Validate → Plan → Deploy

Exit codes for gating

Deploy locking

Secret management

Next steps

Deploy workflow

Drift and locking

​Workflow pattern

​Choose your tool

GitHub Actions

Generic CI

Multi-environment

Terraform CI/CD

​Key concepts

​Validate → Plan → Deploy

​Exit codes for gating

​Deploy locking

​Secret management

​Next steps

Deploy workflow

Drift and locking

Workflow pattern

Choose your tool

Key concepts

Validate → Plan → Deploy

Exit codes for gating

Deploy locking

Secret management

Next steps