Создание кластера

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

В веб-консоли выберите нужный проект.
В списке сервисов выберите Managed ClickHouse и нажмите кнопку Создать.
(опционально) Измените автоматически сгенерированное имя кластера. Позже это имя (name) и созданный из него идентификатор (ID) нельзя изменить, меняется только отображаемое имя (display name) кластера.

Выберите тип кластера: Standalone или Multi-Node.

Standalone
Multi-Node

Укажите зону доступности, где будет размещен кластер.
Укажите версию ClickHouse: 25.3.
Выберите тип ВМ для конфигурации узла.
Укажите размер диска. Его нельзя уменьшить после создания кластера.

(опционально) Укажите максимальное количество операций ввода-вывода в секунду. Допустимо значение от 1 000 до 10 000, кратное 100. Если значение не задано, применится значение по умолчанию.

Размер диска	Значение IOPS
10–32 ГБ	1 000
33–64 ГБ	2 000
65–96 ГБ	3 000
97–128 ГБ	4 000
129–160 ГБ	5 000
161–192 ГБ	6 000
193–224 ГБ	7 000
225–256 ГБ	8 000
257–288 ГБ	9 000
289 ГБ — максимальный	10 000

(опционально) Добавьте описание для кластера.
Нажмите кнопку Далее.
Задайте сетевые настройки кластера:
1. Выберите сеть для размещения кластера или создайте новую сеть.
2. Выберите подсеть для размещения узлов или создайте новую подсеть.
3. Выберите тип внутреннего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.
  
  При необходимости зарезервируйте внутренний IP-адрес.
4. Если вы планируете подключаться к кластеру из внешней сети, выберите тип внешнего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.
  
  При необходимости зарезервируйте внешний IP-адрес.
Нажмите кнопку Далее.
Введите имя администратора кластера.
Введите пароль администратора вручную или сгенерируйте его.
(опционально) Укажите окно для запуска ежедневного автоматического резервного копирования. Значение по умолчанию: 0:00–01:00 UTC.
(опционально) Укажите срок хранения резервных копий. По истечении этого срока резервная копия удалится. Значение по умолчанию — 7 дней, максимальное значение — 30 дней.
(опционально) Укажите день и промежуток времени для сервисного окна. Значения по умолчанию: воскресенье и 0:00–01:00 UTC.
Нажмите кнопку Далее.
Проверьте заданные настройки и нажмите кнопку Создать.

Укажите версию ClickHouse: 25.3.
Выберите количество шардов и количество узлов в каждом шарде.

Задайте настройки конфигурации для каждого шарда, нажав для него на значок редактирования:

Укажите имя шарда.
(опционально) Укажите вес шарда.
Выберите тип ВМ для конфигурации узлов шарда.
Укажите размер диска. Его нельзя уменьшить после создания кластера.

Размер диска	Значение IOPS
10–32 ГБ	1 000
33–64 ГБ	2 000
65–96 ГБ	3 000
97–128 ГБ	4 000
129–160 ГБ	5 000
161–192 ГБ	6 000
193–224 ГБ	7 000
225–256 ГБ	8 000
257–288 ГБ	9 000
289 ГБ — максимальный	10 000

Нажмите кнопку Сохранить.

Выберите тип ВМ для конфигурации узлов ClickHouse Keeper.
(опционально) Добавьте описание для кластера.
Нажмите кнопку Далее.
Выберите тип настроек кластера: Автоматические или Гибкие, и задайте сетевые настройки.
- Автоматические
- Гибкие
Выберите сеть для размещения кластера или создайте новую сеть.

Выберите подсеть для размещения кластера или создайте новую подсеть.

Включите опцию Подключение к кластеру, если планируете подключаться к кластеру целиком. Кластеру будет автоматически назначен внутренний IP-адрес.

Включите опцию Назначить временный внешний IP-адрес, если планируете подключаться к кластеру из внешней сети. Кластеру будет автоматически назначен внешний IP-адрес.

Включите опцию Подключение к узлам, если планируете подключаться к узлам кластера по отдельности. Каждому узлу будет автоматически назначен внутренний IP-адрес.

Включите опцию Назначить временный внешний IP-адрес, если планируете подключаться к узлам из внешней сети. Каждому узлу будет автоматически назначен внешний IP-адрес.

Включите опцию Подключение к шардам, если планируете подключаться к шардам кластера по отдельности. Каждому шарду будет автоматически назначен внутренний IP-адрес.

Выберите опцию Назначить временный внешний IP-адрес, если планируете подключаться к шардам из внешней сети. Каждому шарду будет автоматически назначен внешний IP-адрес.
Выберите сеть для размещения кластера или создайте новую сеть.

Включите опцию Подключение к кластеру, если планируете подключаться к кластеру целиком, и настройте доступ:

Выберите подсеть для размещения кластера или создайте новую подсеть.

Выберите тип внутреннего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.

При необходимости зарезервируйте внутренний IP-адрес.

Если вы планируете подключаться к кластеру из внешней сети, выберите тип внешнего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.

При необходимости зарезервируйте внешний IP-адрес.

Включите опцию Подключение к узлам, если планируете подключаться к узлам кластера по отдельности, и настройте доступ:

Выберите тип внутреннего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.

При необходимости зарезервируйте внутренний IP-адрес.

Если вы планируете подключаться к узлам из внешней сети, выберите тип внешнего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.

При необходимости зарезервируйте внешний IP-адрес.

Выберите подсеть для размещения каждого узла или создайте новые подсети.

Включите опцию Подключение к шардам, если планируете подключаться к шардам кластера по отдельности, и настройте доступ:

Выберите тип внутреннего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.

При необходимости зарезервируйте внутренний IP-адрес.

Если вы планируете подключаться к шардам из внешней сети, выберите тип внешнего IP-адреса: временный, который выбирается автоматически из диапазона подсети, или зарезервированный.

При необходимости зарезервируйте внешний IP-адрес.

Выберите подсеть для размещения каждого шарда или создайте новые подсети.
Нажмите кнопку Далее.
Введите имя администратора кластера.
Введите пароль администратора вручную или сгенерируйте его.
(опционально) Укажите окно для запуска ежедневного автоматического резервного копирования. Значение по умолчанию: 0:00–01:00 UTC.
(опционально) Укажите срок хранения резервных копий. По истечении этого срока резервная копия удалится. Значение по умолчанию — 7 дней, максимальное значение — 30 дней.
(опционально) Укажите день и промежуток времени для сервисного окна. Значения по умолчанию: воскресенье и 0:00–01:00 UTC.
Нажмите кнопку Далее.
Проверьте заданные настройки и нажмите кнопку Создать.

Если у вас нет утилиты MWS CLI:
1. Установите утилиту.
2. Инициализируйте профиль.
Убедитесь, что у вас есть сеть и подсеть, где будет размещен основной узел кластера. Если их нет, создайте сеть и подсеть.

Для каждого кластера нужно выделить отдельную подсеть.

В подсети standalone-кластера должно быть как минимум два свободных IP-адреса — для кластера и для узла. В подсети multi-node-кластера должно быть как минимум по одному свободному IP-адресу для кластера, для каждого шарда и для каждого узла.
Определите тип ВМ для конфигурации узлов.

У ВМ, которые выступают в качестве узлов с данными, должно быть не менее четырех ядер vCPU.
Если вы хотите создать multi-node-кластер, определите, как узлы будут распределены между шардами.

В зависимости от типа кластера выполните подходящую команду.

Standalone-кластер описывается как кластер из одного шарда, включающего в себя один узел.

1
mws mclickhouse cluster create <имя кластера> \
2
  --active \
3
  --version "25.3" \
4
  --shards '
5
    name: <имя шарда — sh>
6
    resources:
7
      vmType: <тип ВМ — например, vmTypes/gen-4-8>
8
      disk:
9
        size: <размер диска в гигабайтах — например, 20GB>
10
        type: <тип диска — NETWORK_STANDARD_SSD>
11
        iops: <количество iops — например, 1000>
12
    weight: 1
13
    instances:
14
      - zone: <зона доступности — ru-central1-a или ru-central1-b>
15
          count: <количество узлов — 1>
16
          endpoints:
17
            - address:
18
                spec:
19
                  subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
20
            - externalAddress:
21
              ref: projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>  // При назначении зарезервированного IP
22
              spec: {}  // При назначении временного IP
23
  ' \
24
  --bootstrap-admin-username <имя администратора кластера> \
25
  --bootstrap-admin-password <пароль администратора кластера> \
26
  --maintenance-window-weekly-days <день для сервисного окна — например, MONDAY> \
27
  --maintenance-window-weekly-hour <время начала сервисного окна — от 0 до 23> \
28
  --backup-hour <время начала резервного копирования> \
29
  --backup-retain-period-days <срок хранения резервных копий в днях>

Описанный в примере multi-node-кластер состоит из двух шардов, каждый из которых включает в себя два узла.

1
mws mclickhouse cluster create <имя кластера> \
2
  --active \
3
  --version "25.3" \
4
  --shards '
5
    name: <имя шарда — sh1>
6
    resources:
7
      vmType: <тип ВМ — например, vmTypes/gen-4-8>
8
      disk:
9
        size: <размер диска в гигабайтах — например, 20GB>
10
        type: <тип диска — NETWORK_STANDARD_SSD>
11
        iops: <количество iops — например, 1000>
12
    weight: 1
13
    instances:
14
      - zone: ru-central1-a
15
        count: <количество узлов в зоне доступности ru-central1-a — 1>
16
        endpoints:
17
          - address:
18
              spec:
19
                subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
20
          - externalAddress:
21
              ref: projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>  // При назначении зарезервированного IP
22
              spec: {}  // При назначении временного IP
23
      - zone: ru-central1-b
24
        count: <количество узлов в зоне доступности ru-central1-b — 1>
25
        endpoints:
26
          - address:
27
              spec:
28
                subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
29
  ' \
30
  --shards '
31
    name: <имя шарда — sh2>
32
    resources:
33
      vmType: <тип ВМ — например, vmTypes/gen-4-8>
34
      disk:
35
        size: <размер диска в гигабайтах — например, 20GB>
36
        type: <тип диска — NETWORK_STANDARD_SSD>
37
        iops: <количество iops — например, 1000>
38
    weight: 1
39
    instances:
40
      - zone: ru-central1-a
41
        count: <количество узлов в зоне доступности ru-central1-a — 1>
42
        endpoints:
43
          - address:
44
              spec:
45
                subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
46
          - externalAddress:
47
              ref: projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>  // При назначении зарезервированного IP
48
              spec: {}  // При назначении временного IP
49
      - zone: ru-central1-b
50
        count: <количество узлов в зоне доступности ru-central1-b — 1>
51
        endpoints:
52
          - address:
53
              spec:
54
                subnet: projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>
55
          - externalAddress:
56
              ref: projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>  // При назначении зарезервированного IP
57
              spec: {}  // При назначении временного IP
58
  ' \
59
  --coordinator-resources-vm-type <тип ВМ — например, vmTypes/gen-2-8> \
60
  --coordinator-resources-disk-type <тип диска — NETWORK_STANDARD_SSD> \
61
  --coordinator-resources-disk-size <размер диска в гигабайтах — например, 20GB> \
62
  --coordinator-instances '
63
    count: <количество узлов ClickHouse Keeper в зоне доступности ru-central1-a — 1>
64
    zone: ru-central1-a
65
  ' \
66
  --coordinator-instances '
67
    count: <количество узлов ClickHouse Keeper в зоне доступности ru-central1-b — 2>
68
    zone: ru-central1-b
69
  ' \
70
  --bootstrap-admin-username <имя администратора кластера> \
71
  --bootstrap-admin-password <пароль администратора кластера> \
72
  --maintenance-window-weekly-days <день для сервисного окна — например, MONDAY> \
73
  --maintenance-window-weekly-hour <время начала сервисного окна — от 0 до 23> \
74
  --backup-hour <время начала резервного копирования> \
75
  --backup-retain-period-days <срок хранения резервных копий в днях>

Допустимое значение IOPS: от 1 000 до 10 000, кратное 100. Если значение не задано, применится значение по умолчанию.

Размер диска	Значение IOPS
10–32 ГБ	1 000
33–64 ГБ	2 000
65–96 ГБ	3 000
97–128 ГБ	4 000
129–160 ГБ	5 000
161–192 ГБ	6 000
193–224 ГБ	7 000
225–256 ГБ	8 000
257–288 ГБ	9 000
289 ГБ — максимальный	10 000

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

Для каждого кластера нужно выделить отдельную подсеть.

В подсети standalone-кластера должно быть как минимум два свободных IP-адреса — для кластера и для узла. В подсети multi-node-кластера должно быть как минимум по одному свободному IP-адресу для кластера, для каждого шарда и для каждого узла.
Определите тип ВМ для конфигурации узлов.

У ВМ, которые выступают в качестве узлов с данными, должно быть не менее четырех ядер vCPU.
Если вы хотите создать multi-node-кластер, определите, как узлы будут распределены между шардами.

Опишите характеристики кластера в виде JSON-объекта и сохраните его в отдельном файле.

Standalone-кластер описывается как кластер из одного шарда, включающего в себя один узел.

1
{
2
  "metadata": {
3
    "displayName": "<отображаемое имя кластера>"
4
  },
5
  "spec": {
6
    "active": <состояние кластера: true — запущен, false — остановлен>,
7
    "version": "25.3",
8
    "shards": [
9
      {
10
        "name": "имя шарда — sh",
11
        "resources": {
12
          "vmType": "<тип ВМ — например, vmTypes/gen-4-8>",
13
          "disk": {
14
            "size": "<размер диска в гигабайтах — например, 20GB>",
15
            "type": "<тип диска — NETWORK_STANDARD_SSD>",
16
            "iops": <количество iops — например, 1000>
17
          }
18
        },
19
        "weight": 1,
20
        "instances": [
21
          {
22
            "zone": "<зона доступности — ru-central1-a или ru-central1-b>",
23
            "count": 1,
24
            "endpoints": [
25
              {
26
                "address": {
27
                  "spec": {
28
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
29
                  }
30
                },
31
                "externalAddress": {
32
                  "spec": {},  # При назначении временного IP
33
                  "ref": "projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>"  # При назначении зарезервированного IP
34
                }
35
              }
36
            ]
37
          }
38
        ]
39
      }
40
    ],
41
    "bootstrapAdmin": {
42
      "username": "<имя администратора кластера>",
43
      "password": "<пароль администратора кластера>"
44
    },
45
    "maintenanceWindow": {
46
      "weekly": {
47
        "days": [
48
          "<день для сервисного окна — например, MONDAY>"
49
        ],
50
        "hour": "<время начала сервисного окна — от 0 до 23>"
51
      }
52
    },
53
    "backup": {
54
      "hour": <время начала резервного копирования>,
55
      "retainPeriodDays": <срок хранения резервных копий в днях>
56
    }
57
  }
58
}

Описанный в примере multi-node-кластер состоит из двух шардов, каждый из которых включает в себя два узла с данными.

1
{
2
  "metadata": {
3
    "displayName": "<отображаемое имя кластера>"
4
  },
5
  "spec": {
6
    "active": <состояние кластера: true — запущен, false — остановлен>,
7
    "version": "25.3",
8
    "shards": [
9
      {
10
        "name": "<имя шарда — sh1>",
11
        "resources": {
12
          "vmType": "<тип ВМ — например, vmTypes/gen-4-8>",
13
          "disk": {
14
            "size": "<размер диска в гигабайтах — например, 20GB>",
15
            "type": "<тип диска — NETWORK_STANDARD_SSD>",
16
            "iops": <количество iops — например, 1000>
17
          }
18
        },
19
        "weight": 1,
20
        "instances": [
21
          {
22
            "zone": "ru-central1-a",
23
            "count": <количество узлов в зоне доступности ru-central1-a — 1>,
24
            "endpoints": [
25
              {
26
                "address": {
27
                  "spec": {
28
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
29
                  },
30
                  "externalAddress": {
31
                    "spec": {},  # При назначении временного IP
32
                    "ref": "projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>"  # При назначении зарезервированного IP
33
                  }
34
                }
35
              }
36
            ]
37
          },
38
          {
39
            "zone": "ru-central1-b",
40
            "count": <количество узлов в зоне доступности ru-central1-b — 1>,
41
            "endpoints": [
42
              {
43
                "address": {
44
                  "spec": {
45
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
46
                  },
47
                  "externalAddress": {
48
                    "spec": {},  # При назначении временного IP
49
                    "ref": "projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>"  # При назначении зарезервированного IP
50
                  }
51
                }
52
              }
53
            ]
54
          }
55
        ]
56
      },
57
      {
58
        "name": "<имя шарда — sh2>",
59
        "resources": {
60
          "vmType": "<тип ВМ — например, vmTypes/gen-4-8>",
61
          "disk": {
62
            "size": "<размер диска в гигабайтах — например, 20GB>",
63
            "type": "<тип диска — NETWORK_STANDARD_SSD>",
64
            "iops": <количество iops — например, 1000>
65
          }
66
        },
67
        "weight": 1,
68
        "instances": [
69
          {
70
            "zone": "ru-central1-a",
71
            "count": <количество узлов в зоне доступности ru-central1-a — 1>,
72
            "endpoints": [
73
              {
74
                "address": {
75
                  "spec": {
76
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
77
                  }
78
                },
79
                "externalAddress": {
80
                  "spec": {},  # При назначении временного IP
81
                  "ref": "projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>"  # При назначении зарезервированного IP
82
                }
83
              }
84
            ]
85
          },
86
          {
87
            "zone": "ru-central1-b",
88
            "count": <количество узлов в зоне доступности ru-central1-b — 1>,
89
            "endpoints": [
90
              {
91
                "address": {
92
                  "spec": {
93
                    "subnet": "projects/<имя проекта>/networks/<имя сети>/subnets/<имя подсети>"
94
                  }
95
                },
96
                "externalAddress": {
97
                  "spec": {},  # При назначении временного IP
98
                  "ref": "projects/<имя проекта>/externalAddresses/<имя зарезервированного IP-адреса>"  # При назначении зарезервированного IP
99
                }
100
              }
101
            ]
102
          }
103
        ]
104
      }
105
    ],
106
    "coordinator": {
107
      "resources": {
108
        "vmType": "<тип ВМ — например, vmTypes/gen-2-8>",
109
        "disk": {
110
          "size": "<размер диска в гигабайтах — например, 20GB>",
111
          "type": "<тип диска — NETWORK_STANDARD_SSD>"
112
        }
113
      },
114
      "instances": [
115
        {
116
          "count": <количество узлов ClickHouse Keeper в зоне доступности ru-central1-a — 1>,
117
          "zone": "ru-central1-a"
118
        },
119
        {
120
          "count": <количество узлов ClickHouse Keeper в зоне доступности ru-central1-b — 2>,
121
          "zone": "ru-central1-b"
122
        }
123
      ]
124
    },
125
    "bootstrapAdmin": {
126
      "username": "<имя администратора кластера>",
127
      "password": "<пароль администратора кластера>"
128
    },
129
    "maintenanceWindow": {
130
      "weekly": {
131
        "days": [
132
          "<день для сервисного окна — например, MONDAY>"
133
        ],
134
        "hour": "<время начала сервисного окна — от 0 до 23>"
135
      }
136
    },
137
    "backup": {
138
      "hour": <время начала резервного копирования>,
139
      "retainPeriodDays": <срок хранения резервных копий в днях>
140
    }
141
  }
142
}

Допустимое значение IOPS: от 1 000 до 10 000, кратное 100. Если значение не задано, применится значение по умолчанию.

Размер диска	Значение IOPS
10–32 ГБ	1 000
33–64 ГБ	2 000
65–96 ГБ	3 000
97–128 ГБ	4 000
129–160 ГБ	5 000
161–192 ГБ	6 000
193–224 ГБ	7 000
225–256 ГБ	8 000
257–288 ГБ	9 000
289 ГБ — максимальный	10 000

Выполните запрос:

1
curl -X POST https://mclickhouse.mwsapis.ru/mclickhouse/v1/projects/<имя проекта>/clusters/<уникальное имя кластера> \
2
  -H "Authorization: Bearer <IAM-токен>" \
3
  -H "Content-Type: application/json" \
4
  -d '@<путь к файлу с JSON-объектом>'

Если запрос был успешно принят, вы получите ответ с кодом 200 OK и параметрами созданного кластера.