Set up ClickHouse connector

Capabilities

Resource	Sync	Provision
Account
Invitation
Organization
Role

Additional functionality: Supports automatic account provisioning Notes:

Roles sync from the ClickHouse Cloud Role Management API and cover both built-in system roles and custom roles created in the ClickHouse console.
Invitations sync as pending accounts. An invited person becomes a member after accepting the invitation.
The connector governs the ClickHouse Cloud organization, not database-level users and roles. SQL users and SQL RBAC are outside its scope.

Understanding roles and account provisioning in ClickHouse Cloud

ClickHouse Cloud assigns each organization member a set of roles rather than a single role. The connector reads that set live, so ten built-in system roles — Admin, Billing, Member, Organization API Reader, Service Admin, Service API Admin, Service API Reader, Service Reader, Basic Service API Reader, and Basic Service Reader — sync alongside every custom role an administrator creates in the ClickHouse console. Two profile fields carry role information on a synced account:

assigned_roles lists the roles the member currently holds. Build access rules on this field.
role is deprecated by ClickHouse. On an organization that has migrated to custom roles, ClickHouse freezes this field at its pre-migration value, so it can name a role the member does not hold. Do not build access rules on it.

To provision an account, the connector sends a ClickHouse invitation instead of creating a user directly. Account provisioning takes three fields:

Field	Required	What to enter
Email address	Yes	The email address to invite. ClickHouse stores it in lowercase.
Organization ID	Yes	The UUID of the ClickHouse organization to invite the person to.
Role IDs	No	A comma-separated list of ClickHouse role UUIDs to assign on acceptance. Leave it empty to assign the Member role, which grants organization read access only.

Role UUIDs come from GET /v1/organizations/{organizationId}/roles in the ClickHouse Cloud API. The connector does not accept role names.

Gather ClickHouse configuration information

Configuring the connector requires you to pass in information from ClickHouse. Gather these configuration details before you move on. Here’s the information you’ll need:

API Key ID
API Key Secret

See the ClickHouse docs for information on how to acquire credentials: View the documentation

Configure the ClickHouse connector

To complete this task, you’ll need:

The Connector Administrator or Super Administrator role in C1
Access to the set of ClickHouse configuration information gathered by following the instructions above

Cloud-hosted
Self-hosted

Follow these instructions to use a built-in, no-code connector hosted by C1.

In C1, navigate to Integrations > Connectors and click Add connector.

Search for ClickHouse and click Add.

Choose how to set up the new ClickHouse connector:

Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with C1)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app

Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.

Click Next.

Find the Settings area of the page and click Edit.

Enter the configuration information from the previous section.

The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

Done. Your ClickHouse connector is now pulling access data into C1.

Follow these instructions to use the ClickHouse connector, hosted and run in your own environment.When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

Resources

Contact C1’s support team to download the latest version of the connector.

Step 1: Set up a new ClickHouse connector

In C1, navigate to Integrations > Connectors > Add connector.

Search for Baton and click Add.

Choose how to set up the new ClickHouse connector:

Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with C1)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app

Click Next.

In the Settings area of the page, click Edit.

Click Rotate to generate a new Client ID and Secret.Carefully copy and save these credentials. We’ll use them in Step 2.

Step 2: Create Kubernetes configuration files

Create two Kubernetes manifest files for your ClickHouse connector deployment:

Secrets configuration

# baton-clickhouse-cloud-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-clickhouse-cloud-secrets
type: Opaque
stringData:
  # C1 credentials
  BATON_CLIENT_ID: <C1 client ID>
  BATON_CLIENT_SECRET: <C1 client secret>

  # ClickHouse config
  BATON_CLICKHOUSE_CLOUD_API_KEY_ID: <ClickHouse Cloud API Key ID used as the username for basic authentication>
  BATON_CLICKHOUSE_CLOUD_API_KEY_SECRET: <ClickHouse Cloud API Key Secret used as the password for basic authentication>

  # Optional: include if you want C1 to provision access using this connector
  BATON_PROVISIONING: true

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-clickhouse-cloud.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-clickhouse-cloud
  labels:
    app: baton-clickhouse-cloud
spec:
  selector:
    matchLabels:
      app: baton-clickhouse-cloud
  template:
    metadata:
      labels:
        app: baton-clickhouse-cloud
        baton: true
        baton-app: clickhouse-cloud
    spec:
      containers:
      - name: baton-clickhouse-cloud
        image: public.ecr.aws/conductorone/baton-clickhouse-cloud:latest
        imagePullPolicy: IfNotPresent
        env:
        - name: BATON_HOST_ID
          value: baton-clickhouse-cloud
        envFrom:
        - secretRef:
            name: baton-clickhouse-cloud-secrets

Step 3: Deploy the connector

Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

Check that the connector data uploaded correctly. In C1, click Apps. On the Managed apps tab, locate and click the name of the application you added the ClickHouse connector to. ClickHouse data should be found on the Entitlements and Accounts tabs.

Done. Your ClickHouse connector is now pulling access data into C1.

Welcome

Manage connectors

Deploy connectors

Upload connector data

Configurable connectors

Pre-built connectors

Set up ClickHouse connector

Capabilities

Understanding roles and account provisioning in ClickHouse Cloud

Gather ClickHouse configuration information

Configure the ClickHouse connector

Resources

Step 1: Set up a new ClickHouse connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector

​Capabilities

​Understanding roles and account provisioning in ClickHouse Cloud

​Gather ClickHouse configuration information

​Configure the ClickHouse connector

​Resources

​Step 1: Set up a new ClickHouse connector

​Step 2: Create Kubernetes configuration files

​Secrets configuration

​Deployment configuration

​Step 3: Deploy the connector

Capabilities

Understanding roles and account provisioning in ClickHouse Cloud

Gather ClickHouse configuration information

Configure the ClickHouse connector

Resources

Step 1: Set up a new ClickHouse connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector