Skip to main content

ClickHouse Cloud Integration

Connect ClickHouse Cloud to bring your ClickHouse Cloud usage costs into Cloud ex Machina, next to your cloud infrastructure costs.

DataClickHouse Cloud APIAPI key role
Usage cost per service and per dayusageCostOrg API reader
Organization members and service profilesOrganization APIOrg API reader
Services: tier, replicas, idle and scaling settingsService APIService API reader
Backup configuration and private endpointsService APIService API reader

This connection uses the ClickHouse Cloud control-plane API. It does not connect to your databases, and it cannot read your data.

Prerequisites​

  • Cloud ex Machina Admin access.
  • The Admin role in your ClickHouse Cloud organization. Only admins create API keys.

Step 1: Create an API key with read-only roles​

  1. Sign in to the ClickHouse Cloud console.
  2. In the left menu, click API Keys.
  3. Click New API Key and name it Cloud ex Machina.
  4. Give the key the roles Org API reader and Service API reader. Do not give it other roles. The Billing role can also change payment methods, so do not use it.
  5. Click Generate API Key.
  6. Copy the Key ID and the Key Secret. ClickHouse Cloud shows them only once.

Step 2: Add the connection in Cloud ex Machina​

  1. In the sidebar, click Integrations.
  2. Find ClickHouse and click Sign in. If the integration already has a connection, the button is Add connection.
  3. Fill in:
    • Key ID: the Key ID from Step 1.
    • Key Secret: the Key Secret from Step 1.
  4. Submit the form. Cloud ex Machina checks the key with ClickHouse Cloud and saves the connection.

Remove a connection​

  1. Click the connection row under the ClickHouse card.
  2. Click Disconnect.
  3. Delete the API key in ClickHouse Cloud.

Next Steps​