Компонуемые протоколы

Обзор

Составные протоколы позволяют более гибко настраивать TCP‑доступ к серверу ClickHouse. Эта конфигурация может использоваться параллельно с традиционной конфигурацией или полностью её заменять.

Настройка компонуемых протоколов

Компонуемые протоколы настраиваются в конфигурационном XML-файле. Раздел протоколов обозначается тегами protocols в XML-файле конфигурации:

<protocols>

</protocols>

Настройка уровней протокола

Вы можете задавать уровни протокола с помощью базовых модулей. Например, чтобы задать уровень HTTP, вы можете добавить новый базовый модуль в раздел protocols:

<protocols>

  <!-- plain_http module -->
  <plain_http>
    <type>http</type>
  </plain_http>

</protocols>

Модули можно настраивать по следующим параметрам:

• plain_http - имя, на которое может ссылаться другой слой
• type - обозначает обработчик протокола, который будет создан для обработки данных. Поддерживаются следующие предопределённые обработчики протоколов:
  • tcp - собственный обработчик протокола ClickHouse
  • http - HTTP-обработчик протокола ClickHouse
  • tls - слой шифрования TLS
  • proxy1 - слой PROXYv1
  • mysql - обработчик протокола совместимости с MySQL
  • postgres - обработчик протокола совместимости с PostgreSQL
  • prometheus - обработчик протокола Prometheus
  • interserver - межсерверный обработчик ClickHouse

Примечание

Обработчик протокола gRPC не реализован для Composable protocols.

Настройка конечных точек

Конечные точки (прослушивающие порты) задаются с помощью тегов <port> и необязательного <host>. Например, чтобы настроить конечную точку на ранее добавленном HTTP-слое, мы можем изменить нашу конфигурацию следующим образом:

<protocols>

  <plain_http>

    <type>http</type>
    <!-- endpoint -->
    <host>127.0.0.1</host>
    <port>8123</port>

  </plain_http>

</protocols>

Если тег <host> опущен, используется <listen_host> из корневой конфигурации.

Настройка последовательностей слоёв

Последовательности слоёв задаются с помощью тега <impl>, ссылающегося на другой модуль. Например, чтобы настроить слой TLS поверх нашего модуля plain_http, мы могли бы дополнительно изменить конфигурацию следующим образом:

<protocols>

  <!-- модуль http -->
  <plain_http>
    <type>http</type>
  </plain_http>

  <!-- модуль https, настроенный как TLS-слой поверх модуля plain_http -->
  <https>
    <type>tls</type>
    <impl>plain_http</impl>
    <host>127.0.0.1</host>
    <port>8443</port>
  </https>

</protocols>

Привязка конечных точек к слоям

Конечные точки можно привязывать к любому слою. Например, мы можем определить конечные точки для HTTP (порт 8123) и HTTPS (порт 8443):

<protocols>

  <plain_http>
    <type>http</type>
    <host>127.0.0.1</host>
    <port>8123</port>
  </plain_http>

  <https>
    <type>tls</type>
    <impl>plain_http</impl>
    <host>127.0.0.1</host>
    <port>8443</port>
  </https>

</protocols>

Определение дополнительных конечных точек

Дополнительные конечные точки можно задать, ссылаясь на любой модуль и опуская тег <type>. Например, мы можем задать конечную точку another_http для модуля plain_http следующим образом:

<protocols>

  <plain_http>
    <type>http</type>
    <host>127.0.0.1</host>
    <port>8123</port>
  </plain_http>

  <https>
    <type>tls</type>
    <impl>plain_http</impl>
    <host>127.0.0.1</host>
    <port>8443</port>
  </https>

  <another_http>
    <impl>plain_http</impl>
    <host>127.0.0.1</host>
    <port>8223</port>
  </another_http>

</protocols>

Указание дополнительных параметров слоя

Некоторые модули могут иметь дополнительные параметры слоя. Например, слой TLS позволяет задать закрытый ключ (privateKeyFile) и файлы сертификатов (certificateFile) следующим образом:

<protocols>

  <plain_http>
    <type>http</type>
    <host>127.0.0.1</host>
    <port>8123</port>
  </plain_http>

  <https>
    <type>tls</type>
    <impl>plain_http</impl>
    <host>127.0.0.1</host>
    <port>8443</port>
    <privateKeyFile>another_server.key</privateKeyFile>
    <certificateFile>another_server.crt</certificateFile>
  </https>

</protocols>