ClickHouse

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

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

Show properties

string

The unique identifier of the service

name

string

The name of the service

state

string

The current state of the service (e.g., RUNNING, STOPPED)

region

string

The cloud region where the service is deployed

cloudProvider

string

The cloud provider hosting the service (AWS, GCP, or Azure)

tier

string

The service tier

idleScaling

object

The idle scaling configuration

totalDiskSize

integer

The total disk size in GB

totalMemoryMB

integer

The total memory in MB

minTotalMemory

integer

The minimum total memory in MB

maxTotalMemory

integer

The maximum total memory in MB

created

string

The timestamp when the service was created

endpoints

object[]

The service endpoints and connection information

metadata

ClickHouse resource metadata

Show properties

clickhouse/id

string

The unique identifier of the service

clickhouse/name

string

The name of the service

clickhouse/state

string

The current state of the service (e.g., RUNNING, STOPPED)

clickhouse/region

string

The cloud region where the service is deployed (e.g., us-east-1)

clickhouse/cloud-provider

string

The cloud provider hosting the service (e.g., AWS, GCP, or AZURE)

clickhouse/tier

string

The service tier (e.g., development, production)

clickhouse/created

string

The timestamp when the service was created

clickhouse/connection-string

string

The primary connection string for the service (e.g., hostname:8443)

On this page

CLI ClickHouse Provider
Usage
Resource Schemas
Service

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

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

Show properties

string

The unique identifier of the service

name

string

The name of the service

state

string

The current state of the service (e.g., RUNNING, STOPPED)

region

string

The cloud region where the service is deployed

cloudProvider

string

The cloud provider hosting the service (AWS, GCP, or Azure)

tier

string

The service tier

idleScaling

object

The idle scaling configuration

totalDiskSize

integer

The total disk size in GB

totalMemoryMB

integer

The total memory in MB

minTotalMemory

integer

The minimum total memory in MB

maxTotalMemory

integer

The maximum total memory in MB

created

string

The timestamp when the service was created

endpoints

object[]

The service endpoints and connection information

metadata

ClickHouse resource metadata

Show properties

clickhouse/id

string

The unique identifier of the service

clickhouse/name

string

The name of the service

clickhouse/state

string

The current state of the service (e.g., RUNNING, STOPPED)

clickhouse/region

string

The cloud region where the service is deployed (e.g., us-east-1)

clickhouse/cloud-provider

string

The cloud provider hosting the service (e.g., AWS, GCP, or AZURE)

clickhouse/tier

string

The service tier (e.g., development, production)

clickhouse/created

string

The timestamp when the service was created

clickhouse/connection-string

string

The primary connection string for the service (e.g., hostname:8443)

On this page

CLI ClickHouse Provider
Usage
Resource Schemas
Service

CLI ClickHouse Provider

Usage

Resource Schemas

Service

API Documentation

API Reference

ClickHouse

CLI ClickHouse Provider

Usage

Resource Schemas

Service

​CLI ClickHouse Provider

​Usage

​Resource Schemas

​Service

API Documentation

API Reference

​CLI ClickHouse Provider

​Usage

​Resource Schemas

​Service

CLI ClickHouse Provider

Usage

Resource Schemas

Service

CLI ClickHouse Provider

Usage

Resource Schemas

Service