Перейти к основному содержанию
В этом примере вы узнаете, как настроить простой кластер ClickHouse, использующий репликацию и масштабирование. Он состоит из двух сегментов и двух реплик, а также 3-узлового кластера ClickHouse Keeper для управления координацией и поддержания кворума в кластере.
Архитектура кластера, который вы будете настраивать, показана ниже:
Хотя ClickHouse Server и ClickHouse Keeper можно запускать вместе на одном сервере, мы настоятельно рекомендуем использовать выделенные хосты для ClickHouse Keeper в производственных средах — именно этот подход мы и продемонстрируем в данном примере.Серверы Keeper могут быть менее мощными, и 4 ГБ оперативной памяти обычно достаточно для каждого сервера Keeper до тех пор, пока ваши серверы ClickHouse не станут достаточно крупными.

Предварительные требования

1

Настройка структуры каталогов и тестовой среды

Файлы с примерамиСледующие шаги помогут вам с нуля настроить кластер. Если вы хотите пропустить их и сразу перейти к запуску кластера, файлы с примерами можно взять из репозитория examples каталог «docker-compose-recipes».
В этом руководстве вы будете использовать Docker compose для настройки кластера ClickHouse. Данную конфигурацию можно адаптировать для работы на отдельных локальных машинах, виртуальных машинах или облачных инстансах.Выполните следующие команды для создания структуры каталогов для данного примера:
Добавьте следующий файл docker-compose.yml в каталог clickhouse-cluster:
docker-compose.yml
Создайте следующие подкаталоги и файлы:
  • Каталог config.d содержит файл конфигурации сервера ClickHouse config.xml, в котором задаётся пользовательская конфигурация для каждого узла ClickHouse. Эта конфигурация объединяется с файлом конфигурации ClickHouse config.xml по умолчанию, который входит в состав каждой установки ClickHouse.
  • Каталог users.d содержит файл пользовательской конфигурации users.xml, в котором задаётся пользовательская конфигурация для пользователей. Эта конфигурация объединяется с файлом конфигурации ClickHouse users.xml по умолчанию, который входит в состав каждой установки ClickHouse.
Пользовательские каталоги конфигурацииРекомендуется использовать каталоги config.d и users.d при создании собственной конфигурации, а не изменять напрямую конфигурацию по умолчанию в /etc/clickhouse-server/config.xml и etc/clickhouse-server/users.xml.Строка
обеспечивает, что разделы конфигурации, определённые в каталогах config.d и users.d, переопределяют разделы конфигурации по умолчанию, заданные в стандартных файлах config.xml и users.xml.
2

Настройка узлов ClickHouse

Настройка сервера

Теперь измените каждый пустой файл конфигурации config.xml, расположенный по пути fs/volumes/clickhouse-{}/etc/clickhouse-server/config.d. Выделенные ниже строки необходимо изменить так, чтобы они соответствовали конкретному узлу:
Каждый раздел приведённого выше конфигурационного файла подробно описан ниже.

Сеть и логирование

Возможность внешних подключений через сетевой интерфейс включается при активации настройки listen host. Это гарантирует, что хост сервера ClickHouse доступен с других хостов:
Порт HTTP API установлен на 8123:
TCP-порт для взаимодействия по собственному протоколу ClickHouse между clickhouse-client и другими инструментами ClickHouse, а также между clickhouse-server и другими clickhouse-servers, установлен в 9000:
Конфигурация логирования задаётся в блоке <logger>. Приведённая ниже конфигурация создаёт отладочный лог с ротацией по достижении 1000 МБ, выполняемой трижды:
Дополнительные сведения о конфигурации логирования см. в комментариях в стандартном файле конфигурации ClickHouse.

Конфигурация кластера

Конфигурация кластера задаётся в блоке <remote_servers>. Здесь определяется имя кластера cluster_2S_2R.Блок <cluster_2S_2R></cluster_2S_2R> определяет структуру кластера с помощью настроек <shard></shard> и <replica></replica> и служит шаблоном для запросов distributed DDL — запросов, выполняемых по всему кластеру с использованием предложения ON CLUSTER. По умолчанию запросы distributed DDL разрешены, однако их можно отключить с помощью настройки allow_distributed_ddl_queries.internal_replication установлен в true, чтобы данные записывались только в одну из реплик.
Раздел <cluster_2S_2R></cluster_2S_2R> определяет структуру кластера и служит шаблоном для распределённых DDL-запросов — запросов, выполняемых по всему кластеру с помощью предложения ON CLUSTER.

Конфигурация Keeper

Раздел <ZooKeeper> сообщает ClickHouse, где запущен ClickHouse Keeper (или ZooKeeper). Поскольку мы используем кластер ClickHouse Keeper, необходимо указать каждый узел <node> кластера, задав его hostname и номер порта с помощью тегов <host> и <port> соответственно.Настройка ClickHouse Keeper рассматривается на следующем шаге руководства.
Хотя ClickHouse Keeper можно запускать на том же сервере, что и ClickHouse Server, для производственных сред мы настоятельно рекомендуем запускать ClickHouse Keeper на выделенных узлах.

Настройка макросов

Кроме того, раздел <macros> используется для определения подстановок параметров для реплицированных таблиц. Они перечислены в system.macros и позволяют использовать подстановки вида {shard} и {replica} в запросах.

Конфигурация пользователя

Теперь внесите следующие изменения в каждый пустой файл конфигурации users.xml, расположенный по пути fs/volumes/clickhouse-{}/etc/clickhouse-server/users.d:
/users.d/users.xml
В этом примере пользователь по умолчанию настроен без пароля для простоты. На практике такой подход не рекомендуется.
В этом примере файл users.xml одинаков на всех узлах кластера.
3

Настройка ClickHouse Keeper

Далее вы настроите ClickHouse Keeper, который используется для координации работы.

Настройка Keeper

Чтобы репликация работала, необходимо развернуть и настроить кластер ClickHouse Keeper. ClickHouse Keeper обеспечивает систему координации для репликации данных, выступая в качестве замены ZooKeeper, который также можно использовать. Однако рекомендуется использовать ClickHouse Keeper, так как он обеспечивает более строгие гарантии и надежность, а также потребляет меньше ресурсов, чем ZooKeeper. Для Высокой доступности и сохранения кворума рекомендуется запускать как минимум три узла ClickHouse Keeper.
ClickHouse Keeper может работать на любом узле кластера вместе с ClickHouse, однако рекомендуется запускать его на выделенном узле, что позволяет масштабировать кластер ClickHouse Keeper и управлять им независимо от кластера базы данных.
Создайте файлы keeper_config.xml для каждого узла ClickHouse Keeper, выполнив следующую команду из корневой папки примера:
Измените пустые файлы конфигурации, созданные в каждом каталоге узла fs/volumes/clickhouse-keeper-{}/etc/clickhouse-keeper. Выделенные ниже строки нужно изменить для каждого узла:
/clickhouse-keeper/keeper_config.xml
Каждый файл конфигурации должен содержать следующую уникальную конфигурацию (показана ниже). Используемый server_id должен быть уникальным для соответствующего узла ClickHouse Keeper в кластере и совпадать с <id> сервера, заданным в разделе <raft_configuration>. tcp_port — порт, используемый клиентами ClickHouse Keeper.
Следующий раздел используется для настройки серверов, которые участвуют в кворуме алгоритма консенсуса Raft:
ClickHouse Cloud упрощает администрированиеClickHouse Cloud снимает операционную нагрузку, связанную с управлением сегментами и репликами. Платформа автоматически обеспечивает высокую доступность, репликацию и масштабирование. Вычислительные ресурсы и хранилище разделены и масштабируются по мере необходимости без ручной настройки и постоянного обслуживания.Подробнее
4

Проверка настройки

Убедитесь, что на вашей машине запущен Docker. Запустите кластер командой docker-compose up из корня каталога cluster_2S_2R:
Вы должны увидеть, как Docker начинает загружать образы ClickHouse и Keeper, а затем запускать контейнеры:
Чтобы проверить, что кластер запущен, подключитесь к любому из узлов и выполните следующий запрос. Ниже показана команда для подключения к первому узлу:
Если всё прошло успешно, вы увидите приглашение клиента ClickHouse:
Выполните следующий запрос, чтобы проверить, какие топологии кластеров определены для каких хостов:
Query
Response
Выполните следующий запрос, чтобы проверить состояние кластера ClickHouse Keeper:
Query
Response
Команда mntr также часто используется, чтобы убедиться, что ClickHouse Keeper запущен, и получить информацию о состоянии и ролях трёх узлов Keeper. В конфигурации, используемой в этом примере, вместе работают три узла. Они выберут leader, а остальные узлы будут followers.Команда mntr предоставляет информацию о производительности, а также о том, является ли конкретный узел follower или leader.
Возможно, вам потребуется установить netcat, чтобы отправить команду mntr в Keeper. Информацию о загрузке см. на странице nmap.org.
Выполните приведённую ниже команду в оболочке на clickhouse-keeper-01, clickhouse-keeper-02 и clickhouse-keeper-03, чтобы проверить состояние каждого узла Keeper. Команда для clickhouse-keeper-01 показана ниже:
Ниже приведён пример ответа от узла-реплики:
Response
Ниже приведён пример ответа от узла-лидера:
Response
Итак, вы успешно настроили кластер ClickHouse с двумя сегментами и двумя репликами. На следующем шаге вы создадите в кластере таблицу.
5

Создайте базу данных

Теперь, когда вы убедились, что cluster настроен правильно и работает, вам предстоит заново создать ту же таблицу, что использовалась в руководстве по примеру набора данных UK property prices. Она состоит примерно из 30 миллионов строк с ценами сделок с недвижимым имуществом в Англии и Уэльсе с 1995 года.Подключитесь к клиенту каждого хоста, выполнив по одной из следующих команд в отдельных вкладках или окнах терминала:
Вы можете выполнить приведённый ниже запрос в clickhouse-client на каждом узле, чтобы убедиться, что, кроме баз данных по умолчанию, другие базы данных ещё не созданы:
Query
Response
В клиенте clickhouse-01 выполните следующий распределённый DDL-запрос, используя предложение ON CLUSTER, чтобы создать новую базу данных uk:
Вы можете снова выполнить тот же запрос, что и раньше, из клиента на каждом узле, чтобы убедиться, что база данных была создана во всём кластере, хотя запрос выполнялся только с clickhouse-01:
6

Создайте таблицу в кластере

Теперь, когда база данных создана, создайте таблицу с репликацией.Выполните следующий запрос с любого клиентского хоста:
Обратите внимание, что он идентичен запросу, использованному в исходном операторе CREATE в руководстве по примеру набора данных о ценах на недвижимость в Великобритании, за исключением предложения ON CLUSTER и использования движка ReplicatedMergeTree.Предложение ON CLUSTER предназначено для распределённого выполнения DDL-запросов (языка определения данных), таких как CREATE, DROP, ALTER и RENAME, и гарантирует, что эти изменения схемы будут применены ко всем узлам кластера.Движок ReplicatedMergeTree работает так же, как обычный движок таблицы MergeTree, но при этом также реплицирует данные. Для него нужно указать два параметра:
  • zoo_path: Путь в Keeper/ZooKeeper к метаданным таблицы.
  • replica_name: Имя реплики таблицы.

Параметр zoo_path можно задать произвольно, однако рекомендуется использовать префикс
где:
  • {database} и {table} будут подставлены автоматически.
  • {shard} и {replica} — это макросы, которые были определены ранее в файле config.xml на каждом узле ClickHouse.
Вы можете выполнить приведённый ниже запрос из клиента на каждом узле, чтобы убедиться, что таблица создана во всём кластере:
Query
Response
7

Вставка данных в distributed таблицу

Чтобы вставить данные в таблицу, ON CLUSTER использовать нельзя, так как это предложение не применяется к DML-запросам (языку манипулирования данными), таким как INSERT, UPDATE и DELETE. Для вставки данных необходимо использовать движок таблицы Distributed. Как вы узнали из руководства по настройке кластера с 2 сегментами и 1 репликой, distributed таблицы — это таблицы, которые имеют доступ к сегментам, расположенным на разных хостах, и определяются с помощью движка таблицы Distributed. Distributed таблица выступает интерфейсом для всех сегментов в кластере.С любого из клиентских хостов выполните следующий запрос, чтобы создать distributed таблицу на основе существующей реплицируемой таблицы, которую мы создали на предыдущем шаге:
Теперь на каждом хосте в базе данных uk будут отображаться следующие таблицы:
Данные можно вставить в таблицу uk_price_paid_distributed с любого из клиентских хостов, выполнив следующий запрос:
Выполните следующий запрос, чтобы убедиться, что вставленные данные равномерно распределились по узлам нашего кластера:

Заключение

Преимущество этой топологии кластера с 2 сегментами и 2 репликами в том, что она обеспечивает и масштабируемость, и отказоустойчивость. Данные распределяются по отдельным хостам, что снижает требования к хранилищу и операциям ввода-вывода на каждом узле, а запросы обрабатываются параллельно в обоих сегментах, повышая производительность и эффективность использования памяти. Что особенно важно, кластер может пережить потерю одного узла и продолжать обслуживать запросы без перерыва, поскольку для каждого сегмента на другом узле доступна резервная реплика. Основной недостаток этой топологии кластера — повышенные требования к хранилищу: по сравнению с конфигурацией без реплик ей требуется вдвое больше места, поскольку каждый сегмент дублируется. Кроме того, хотя кластер может пережить отказ одного узла, одновременная потеря двух узлов может сделать его неработоспособным — в зависимости от того, какие именно узлы выйдут из строя и как распределены сегменты. Эта топология представляет собой компромисс между доступностью и стоимостью, поэтому хорошо подходит для производственных сред, где требуется определенный уровень отказоустойчивости, но без затрат, связанных с более высокими коэффициентами репликации. Чтобы узнать, как ClickHouse Cloud обрабатывает запросы, обеспечивая одновременно масштабируемость и отказоустойчивость, см. раздел “Параллельные реплики”.
Последнее изменение 25 июня 2026 г.