CLI ClickHouse Provider
The ClickHouse scanner syncs ClickHouse Cloud instances into Ctrlplane, allowing
you to monitor, manage, and deploy to your ClickHouse infrastructure.
Usage
To sync in all ClickHouse instances, you’ll need:
- A ClickHouse Cloud API key with read access to your organization
- Your ClickHouse organization ID
You can create an API key in the ClickHouse Cloud
Console under “API Keys”.
To see all available options, run:
ctrlc sync clickhouse --help
Here is a basic example of how to sync in all ClickHouse instances:
ctrlc sync clickhouse \
--clickhouse-key <CLICKHOUSE_API_KEY> \
--organization-id <ORG_ID> \
--interval 5m
You can also set environment variables for the API key and organization ID:
export CLICKHOUSE_API_KEY=<your-api-key>
export CLICKHOUSE_ORGANIZATION_ID=<your-org-id>
ctrlc sync clickhouse
Resource Schemas
Service
When syncing instances from ClickHouse, each service will have the following
schema:
version
string
default:"clickhouse/v1"
The version of the schema
Name of the service, derived from the ClickHouse service name
The unique identifier of the service, in the format organizationID/serviceID
config
ClickHouse resource config
The unique identifier of the service
The current state of the service (e.g., RUNNING, STOPPED)
The cloud region where the service is deployed
The cloud provider hosting the service (AWS, GCP, or Azure)
The idle scaling configuration
The total disk size in GB
The minimum total memory in MB
The maximum total memory in MB
The timestamp when the service was created
The service endpoints and connection information
metadata
ClickHouse resource metadata
The unique identifier of the service
The current state of the service (e.g., RUNNING, STOPPED)
The cloud region where the service is deployed (e.g., us-east-1)
clickhouse/cloud-provider
The cloud provider hosting the service (e.g., AWS, GCP, or AZURE)
The service tier (e.g., development, production)
The timestamp when the service was created
clickhouse/connection-string
The primary connection string for the service (e.g., hostname:8443)
