Announcing support for ClickStack in the ClickHouse Terraform provider

Summary

The ClickHouse Terraform provider now supports managing ClickStack resources for both self-hosted deployments and ClickHouse Cloud. Dashboards, alerts, sources, saved searches, connections, and webhooks can be kept in version control, reviewed, and applied with the standard terraform plan and terraform apply workflow, helping keep configurations aligned across environments. ClickStack is implemented as a dedicated service module in the existing ClickHouse/clickhouse provider, using Cloud organization credentials plus a service ID for Managed ClickStack, or an endpoint and personal API access key for self-hosted deployments. The work also extends the API contract with named schemas, consistent integer fields, structured validation errors, and dashboard JSON validation during planning when the validation endpoint is available. Support is beta from provider version 3.25, with import and generated-configuration workflows for existing resources; if validation is unavailable, planning warns and validation is deferred to apply.

Takeaways

1. 1

   ClickStack resources are available in the regular ClickHouse Terraform provider, including dashboards, alerts, sources, saved searches, connections, and webhooks.

2. 2

   Managed ClickStack uses ClickHouse Cloud credentials and a service ID, while self-hosted ClickStack uses CLICKSTACK_ENDPOINT and a personal CLICKSTACK_API_KEY; the credential configurations should not share one unaliased provider block.

3. 3

   Existing dashboards can be imported, and Terraform 1.5 or later can generate configuration from import blocks or bulk-exported resources.