Подключение к кластеру

Подключиться к кластеру можно двумя способами:

По внутренней сети. Используйте этот способ, если подключаетесь к кластеру с ВМ в облаке MWS.
По внешней сети. Используйте этот способ, если подключаетесь к кластеру из-за пределов облака MWS.

Подключение по внутренней сети

Веб-консоль
MWS CLI
API

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Сохраните имя администратора из строки Администратор.
Перейдите на вкладку Доступы.
Определите, к какому объекту необходимо подключиться:
- Доступ к кластеру — к случайному активному узлу кластера.
- Доступ к шардам — к случайному активному узлу шарда.
- Доступ к узлам — к конкретному узлу в кластере.
Сохраните внутренний IPv4-адрес ресурса из соответствующего блока.

Примечание
При подключении по адресу кластера или шарда выбирается случайный активный узел. Каждое новое подключение может попасть на новый узел. Если узел недоступен, он выйдет из балансировки через одну минуту.
Убедитесь, что у вас есть ВМ в сервисе Compute, подключенная к одной сети с кластером. Если нет, создайте ее.
Подключитесь к ВМ по SSH.
Установите утилиту ClickHouse Client:
bash
```
1
sudo apt install clickhouse-client
```
Вы можете использовать любую другую утилиту для подключения.

Выполните команду:

1
clickhouse-client --host <внутренний IPv4-адрес ресурса> --port 9000 --user <имя администратора кластера> --password <пароль администратора кластера>

Здесь используется порт 9000, потому что подключение выполняется с помощью утилиты ClickHouse Client.

При успешном подключении будет выведено сообщение вида Connected to ClickHouse server version 25.1.8 revision 54475.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Получите информацию о кластере:
bash
```
1
mws mclickhouse cluster get <имя кластера>
```
Найдите в выводе команды внутренний IPv4-адрес ресурса, к которому будете подключаться. Нужный параметр зависит от того, к какому объекту вы подключаетесь:
- к кластеру — status:cluster:endpoints:address:ipAddress;
- к шарду — status:cluster:shards:endpoints:address:ipAddress;
- к конкретному узлу — status:cluster:shards:instances:endpoints:address:ipAddress.
Сохраните нужный IPv4-адрес.

Примечание
При подключении по адресу кластера или шарда выбирается случайный активный узел. Каждое новое подключение может попасть на новый узел. Если узел недоступен, он выйдет из балансировки через одну минуту.
Найдите и сохраните значение параметра spec:bootstrapAdmin:username. Это имя администратора кластера.
Убедитесь, что у вас есть ВМ в сервисе Compute, подключенная к одной сети с кластером. Если нет, создайте ее.
Подключитесь к ВМ по SSH.
Установите утилиту ClickHouse Client:
bash
```
1
sudo apt install clickhouse-client
```
Вы можете использовать любую другую утилиту для подключения.

Выполните команду:

1
clickhouse-client --host <внутренний IPv4-адрес ресурса> --port 9000 --user <имя администратора кластера> --password <пароль администратора кластера>

Здесь используется порт 9000, потому что подключение выполняется с помощью утилиты ClickHouse Client.

При успешном подключении будет выведено сообщение вида Connected to ClickHouse server version 25.1.8 revision 54475.

Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Получите информацию о кластере:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"

Найдите в ответе внутренний IPv4-адрес ресурса, к которому будете подключаться. Нужный параметр зависит от того, к какому объекту вы подключаетесь:
- к кластеру — status:cluster:endpoints:address:ipAddress;
- к шарду — status:cluster:shards:endpoints:address:ipAddress;
- к конкретному узлу — status:cluster:shards:instances:endpoints:address:ipAddress.
Сохраните нужный IPv4-адрес.

Примечание
При подключении по адресу кластера или шарда выбирается случайный активный узел. Каждое новое подключение может попасть на новый узел. Если узел недоступен, он выйдет из балансировки через одну минуту.
Найдите и сохраните значение параметра spec:bootstrapAdmin:username. Это имя администратора кластера.
Убедитесь, что у вас есть ВМ в сервисе Compute, подключенная к одной сети с кластером. Если нет, создайте ее.
Подключитесь к ВМ по SSH.
Установите утилиту ClickHouse Client:
bash
```
1
sudo apt install clickhouse-client
```
Вы можете использовать любую другую утилиту для подключения.

Выполните команду:

1
clickhouse-client --host <внутренний IPv4-адрес ресурса> --port 9000 --user <имя администратора кластера> --password <пароль администратора кластера>

Здесь используется порт 9000, потому что подключение выполняется с помощью утилиты ClickHouse Client.

При успешном подключении будет выведено сообщение вида Connected to ClickHouse server version 25.1.8 revision 54475.

Подключение по внешней сети

Веб-консоль
MWS CLI
API

Для сети, к которой подключен кластер, добавьте правило файрвола для входящего трафика:
- источник трафика — IP-адрес клиента;
- назначение трафика — внешний IP-адрес ресурса;
- протокол и порт — TCP:9000 или HTTP:8123 в зависимости от поддерживаемых клиентом протоколов.
В списке сервисов выберите Managed ClickHouse.
Нажмите на имя нужного кластера.
Сохраните имя администратора из строки Администратор.
Перейдите на вкладку Доступы.
Определите, к какому объекту необходимо подключиться:
- Доступ к кластеру — к случайному активному узлу кластера.
- Доступ к шардам — к случайному активному узлу шарда.
- Доступ к узлам — к конкретному узлу в кластере.
Сохраните внешний IPv4-адрес ресурса из соответствующего блока.

Примечание
При подключении по адресу кластера или шарда выбирается случайный активный узел. Каждое новое подключение может попасть на новый узел. Если узел недоступен, он выйдет из балансировки через одну минуту.
Установите утилиту ClickHouse Client:
bash
```
1
sudo apt install clickhouse-client
```
Вы можете использовать любую другую утилиту для подключения.

Выполните команду:

1
clickhouse-client --host <внешний IPv4-адрес ресурса> --port 9000 --user <имя администратора кластера> --password <пароль администратора кластера>

Здесь используется порт 9000, потому что подключение выполняется с помощью утилиты ClickHouse Client.

При успешном подключении будет выведено сообщение вида Connected to ClickHouse server version 25.1.8 revision 54475.

Для сети, к которой подключен кластер, добавьте правило файрвола для входящего трафика:
- источник трафика — IP-адрес клиента;
- назначение трафика — внешний IP-адрес ресурса;
- протокол и порт — TCP:9000 или HTTP:8123 в зависимости от поддерживаемых клиентом протоколов.
Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Получите информацию о кластере:
bash
```
1
mws mclickhouse cluster get <имя кластера>
```
Найдите в выводе команды внешний IPv4-адрес ресурса, к которому будете подключаться. Нужный параметр зависит от того, к какому объекту вы подключаетесь:
- к кластеру — status:cluster:endpoints:externalAddress:ipAddress;
- к шарду — status:cluster:shards:endpoints:externalAddress:ipAddress;
- к конкретному узлу — status:cluster:shards:instances:endpoints:externalAddress:ipAddress.
Сохраните нужный IPv4-адрес.

Примечание
При подключении по адресу кластера или шарда выбирается случайный активный узел. Каждое новое подключение может попасть на новый узел. Если узел недоступен, он выйдет из балансировки через одну минуту.
Найдите и сохраните значение параметра spec:bootstrapAdmin:username. Это имя администратора кластера.
Установите утилиту ClickHouse Client:
bash
```
1
sudo apt install clickhouse-client
```
Вы можете использовать любую другую утилиту для подключения.

Выполните команду:

1
clickhouse-client --host <внешний IPv4-адрес ресурса> --port 9000 --user <имя администратора кластера> --password <пароль администратора кластера>

Здесь используется порт 9000, потому что подключение выполняется с помощью утилиты ClickHouse Client.

При успешном подключении будет выведено сообщение вида Connected to ClickHouse server version 25.1.8 revision 54475.

Для сети, к которой подключен кластер, добавьте правило файрвола для входящего трафика:
- источник трафика — IP-адрес клиента;
- назначение трафика — внешний IP-адрес ресурса;
- протокол и порт — TCP:9000 или HTTP:8123 в зависимости от поддерживаемых клиентом протоколов.
Убедитесь, что у вас есть IAM-токен для авторизации запроса. Если нет, получите его.

Получите информацию о кластере:

1
curl -X GET https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>"

Найдите в ответе внешний IPv4-адрес ресурса, к которому будете подключаться. Нужный параметр зависит от того, к какому объекту вы подключаетесь:
- к кластеру — status:cluster:endpoints:externalAddress:ipAddress;
- к шарду — status:cluster:shards:endpoints:externalAddress:ipAddress;
- к конкретному узлу — status:cluster:shards:instances:endpoints:externalAddress:ipAddress.
Сохраните нужный IPv4-адрес.

Примечание
При подключении по адресу кластера или шарда выбирается случайный активный узел. Каждое новое подключение может попасть на новый узел. Если узел недоступен, он выйдет из балансировки через одну минуту.
Найдите и сохраните значение параметра spec:bootstrapAdmin:username. Это имя администратора кластера.
Установите утилиту ClickHouse Client:
bash
```
1
sudo apt install clickhouse-client
```
Вы можете использовать любую другую утилиту для подключения.

Выполните команду:

1
clickhouse-client --host <внешний IPv4-адрес ресурса> --port 9000 --user <имя администратора кластера> --password <пароль администратора кластера>

Здесь используется порт 9000, потому что подключение выполняется с помощью утилиты ClickHouse Client.

При успешном подключении будет выведено сообщение вида Connected to ClickHouse server version 25.1.8 revision 54475.