​
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:

  1. A ClickHouse Cloud API key with read access to your organization
  2. 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

​
kind
string
default:"Service"

The type of resource

​
name
string

Name of the service, derived from the ClickHouse service name

​
identifier
string

The unique identifier of the service, in the format organizationID/serviceID

​
config
ClickHouse resource config
​
metadata
ClickHouse resource metadata