clickhouse-cloud
ClickHouse Cloud with chv
Step-by-step guides for managing ClickHouse Cloud services using the chv CLI. Covers Cloud API credentials, service creation and lifecycle management, sizing and scaling, security configuration, and backup management.
Official docs: ClickHouse Cloud
For local development (installing chv, running ClickHouse locally, migrating to cloud): See the
clickhouse-local-developmentskill.
IMPORTANT: How to Apply This Skill
Before answering ClickHouse Cloud questions, follow this priority order:
- Check for applicable guides in the
guides/directory - If a guide exists: Follow it and cite it in your response using "Per
guide-name..." - If no guide exists: Use the LLM's ClickHouse Cloud knowledge or search documentation
- If uncertain: Use web search for current best practices
- Always cite your source: guide name, "general ClickHouse Cloud guidance", or URL
Why guides take priority: The chv CLI is a prototype tool with specific command syntax. The guides encode the exact flags and workflows that have been verified against the CLI.
Workflow Procedures
For Creating a Cloud Service
Read these guide files in order:
guides/setup-auth.md— Configure Cloud API credentialsguides/sizing-provider-region.md— Choose provider and regionguides/sizing-replicas.md— Choose replica count and memoryguides/sizing-idle.md— Configure idle scalingguides/service-create.md— Create the serviceguides/security-ip-allowlist.md— Configure IP access (if needed)guides/security-encryption.md— Configure encryption (if needed)
For Managing Existing Services
Read the relevant guide:
guides/service-inspect.md— List and inspect servicesguides/service-manage.md— Start, stop, or delete services
For Backup and Restore
Read these guide files in order:
guides/backup-manage.md— List and inspect backupsguides/backup-restore.md— Restore from a backup
For Local Development or Migration
See the clickhouse-local-development skill for installing chv, running ClickHouse locally, and migrating data to cloud.
Guide Categories
| # | Section | Prefix | Guides | Description |
|---|---|---|---|---|
| 1 | Setup | setup- |
1 | Configure Cloud API credentials |
| 2 | Service Management | service- |
3 | Create, manage lifecycle, inspect services |
| 3 | Sizing & Scaling | sizing- |
3 | Replicas, idle scaling, provider/region |
| 4 | Security | security- |
2 | IP allowlists, encryption |
| 5 | Backups | backup- |
2 | List backups, restore from backup |
Quick Reference
Setup
setup-auth— Configure ClickHouse Cloud API credentials
Service Management
service-create— Create a Cloud service with all optionsservice-manage— Start, stop, and delete servicesservice-inspect— List and inspect services
Sizing & Scaling
sizing-replicas— Configure replica count and memorysizing-idle— Idle scaling and timeout configurationsizing-provider-region— Choose cloud provider and region
Security
security-ip-allowlist— Configure IP access rulessecurity-encryption— Disk encryption and compliance options
Backups
backup-manage— List and inspect backupsbackup-restore— Restore a service from backup
When to Apply
This skill activates when you encounter:
- Configuring ClickHouse Cloud API credentials
- Creating ClickHouse Cloud services
- Choosing cloud provider, region, or sizing
- Starting, stopping, or deleting Cloud services
- Listing or inspecting Cloud services
- Configuring IP allowlists or encryption
- Managing or restoring from backups
- Questions about
chv cloudcommands
Related Skills
clickhouse-local-development— For installing chv, local ClickHouse development, and migrating to cloudclickhouse-best-practices— For ClickHouse schema design, query optimization, and data ingestion best practices
Full Compiled Document
For the complete guide with all content expanded inline: AGENTS.md
Use AGENTS.md when you need to reference multiple guides quickly without reading individual files.