ClickHouse Overview

clickhouse_ansible is the ClickHouse automation subdirectory in the dbbot repository. It targets MySQL downstream OLAP scenarios and provides the core playbooks and documentation required for cluster deployment, backup, restore, and daily operations.

1. Scope of application

Applicable to the following scenarios:

  • Use ClickHouse to serve MySQL downstream analytics, reports or detailed query scenarios.
  • Requires unified delivery of ClickHouse clusters via Ansible.
  • Standardized backup and restore procedures need to be established for ClickHouse.

The default documentation example uses a 3 shard 2 replica topology, but the Playbook is not designed to be limited to this topology.

2. Location in the repository

Typical path:

/usr/local/dbbot/clickhouse_ansible

Core directories related to ClickHouse include:

  • inventory/: Host list for deployment, backup, restore, and other scenarios.
  • playbooks/: Entry Playbook and variable files.
  • roles/: System initialization, ZooKeeper / Keeper, ClickHouse deployment roles.
  • downloads/: ClickHouse and ZooKeeper installation packages.
  • artifacts/manifests/: Backup and restore running products.

3. Suggested reading order

  1. Cluster deployment
  2. Backup
  3. Restore
  4. Variables and Parameters
  5. Operations and Troubleshooting
  6. Directory structure and configuration
  7. Deployment, Backup, and Restore Specification
  • The control node has installed the full dbbot release package.
  • The portable Ansible distribution has been registered.
  • The target node meets x86_64 and SSE4.2 requirements.
  • ClickHouse node, ZooKeeper / Keeper node network interoperability.

5. Relationship with other capabilities of the main site

  • mysql_ansible for MySQL core OLTP delivery.
  • clickhouse_ansible for MySQL downstream OLAP scenarios.
  • monitoring_prometheus_ansible is used to provide monitoring capabilities for the above components.

All three live in the same dbbot repository and share the same release cadence.