Кластер Managed ClickHouse — это группа узлов (виртуальных машин), объединенных для высокоскоростной обработки и хранения данных с помощью СУБД ClickHouse. В облачной инфраструктуре кластер — единый интерфейс управления оперативной аналитической обработкой данных (OLAP, On-Line Analytical Processing) в реальном времени

1
resource "mws_vpc_network" "network" {
2
  network = var.network_name
3
}
4

5
resource "mws_vpc_subnet" "subnet" {
6
  subnet  = var.subnet_name
7
  network = mws_vpc_network.network.network
8
  cidr    = var.subnet_cidr
9
}
10

11
resource "mws_mclickhouse_cluster" "example" {
12
  cluster = var.cluster_name
13
  version = "25.3"
14
  active  = true
15

16
  metadata = {
17
    display_name = "Standalone ClickHouse Cluster Example"
18
    description  = "Standalone ClickHouse Cluster"
19
  }
20

21
  shards = [{
22
    name = "shard"
23

24
    resources = {
25
      vm_type = "vmTypes/gen-4-8"
26
      disk = {
27
        type = "NETWORK_STANDARD_SSD"
28
        size = "10Gb"
29
      }
30
    }
31

32
    weight = 1
33

34
    instances = [{
35
      name  = "instance-1"
36
      zone  = "ru-central1-a"
37
      count = 1
38

39
      endpoints = [{
40
        address = {
41
          spec = {
42
            subnet = mws_vpc_subnet.subnet.metadata.id
43
          }
44
        }
45
        external_address = {
46
          spec = {}
47
        }
48
      }]
49
    }]
50
  }]
51

52
  bootstrap_admin = {
53
    username         = var.cluster_admin_username
54
    password_version = 1
55
    password         = var.cluster_admin_password
56
  }
57

58
  maintenance_window = {
59
    weekly = {
60
      days = ["MONDAY"]
61
      hour = 3
62
    }
63
  }
64

65
  backup = {
66
    hour               = 2
67
    retain_period_days = 7
68
  }
69
}
70

71
variable "network_name" {
72
  type        = string
73
  default     = "standalone-ch-network"
74
  description = "Network name"
75
}
76

77
variable "subnet_name" {
78
  type        = string
79
  default     = "standalone-ch-subnet"
80
  description = "Subnet name"
81
}
82

83
variable "subnet_cidr" {
84
  type        = string
85
  default     = "192.168.1.0/24"
86
  description = "Subnet CIDR"
87
}
88

89
variable "cluster_name" {
90
  type        = string
91
  default     = "standalone-ch"
92
  description = "ClickHouse cluster name"
93
}
94

95
variable "cluster_admin_username" {
96
  type        = string
97
  default     = "admin"
98
  description = "ClickHouse cluster admin username"
99
}
100

101
variable "cluster_admin_password" {
102
  type        = string
103
  sensitive   = true
104
  default     = "securePassword123!"
105
  description = "ClickHouse cluster admin password"
106
}

• bootstrap_admin (Attributes) Добавление пользователей при создании кластера Clickhouse. (see below for nested schema)
• cluster (String) Название или идентификатор кластера.
• shards (Attributes List) Описание шардов кластера. (see below for nested schema)
• version (String) Версия продукта.

• active (Boolean) Состояние кластера — включен или выключен.
• backup (Attributes) Спецификация работы автоматического резервного копирования. (see below for nested schema)
• config (Map of String) Настройки Clickhouse. Если не указаны, будут использованы настройки по умолчанию
• coordinator (Attributes) Описание координатора кластера. (see below for nested schema)
• endpoints (Attributes List) Описание эдпойнтов кластера. (see below for nested schema)
• kind (String)
• maintenance_window (Attributes) (see below for nested schema)
• metadata (Attributes) (see below for nested schema)
• project (String) Путь к проекту.
• storage (Attributes) Конфигурация схемы хранилищ ClickHouse. (see below for nested schema)
• timeouts (Attributes) (see below for nested schema)

• id (String) ID ресурса.
• status (Attributes) (see below for nested schema)

Required:

• password (String, Sensitive, Write-only) Пароль учетной записи администратора.
• username (String) Имя учетной записи администратора.

Optional:

• password_version (Number) Increase this field’s value if you want to force updating the associated write-only field.

Required:

• instances (Attributes List) (see below for nested schema)
• name (String) Имя шарда, которому будут принадлежать инстансы. В случае с несколькими шардами имя формируется как name-{shardIndex}.
• resources (Attributes) Ресурсы одной ноды Clickhouse. (see below for nested schema)

Optional:

• count (Number) Количество шардов, которые будут созданы.
• endpoints (Attributes List) Описание эдпойнтов шардов. (see below for nested schema)
• weight (Number) Вес шарда.

Required:

• zone (String) Зона доступности.

Optional:

• count (Number) Количество инстансов в зоне доступности.
• endpoints (Attributes List) Описание эдпойнтов инстансов. (see below for nested schema)
• name (String) Имя инстанса в шарде. В случае с несколькими инстансами имя формируется как name-{replicaIndex}, где replicaIndex имеет сквозную нумерацию в шарде.

Required:

• address (Attributes) Описание шаблона адреса/адресов, которые будут выделены. Для ref будет выделен только один адрес, для spec будет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)

Optional:

• external_address (Attributes) Описание шаблона внешнего адреса/адресов, которые будут выделены. Для ref будет выделен только один адрес, для spec будет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)

Optional:

• ref (String) Ссылка на внутренний адрес эндпоинта в VPC.
• spec (Attributes) Описание шаблона адреса, который будет использоваться при выделении адресов. (see below for nested schema)

Required:

• subnet (String) Подсеть облачной сети, к которой принадлежит адрес.

Optional:

• ref (String) Ссылка на внешний адрес эндпоинта в VPC.
• spec (Attributes) Описание шаблона внешнего адреса, который будет использоваться при выделении адресов. (see below for nested schema)

Required:

• disk (Attributes) Параметры диска. (see below for nested schema)
• vm_type (String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).

Required:

• size (String) Размер диска.
• type (String) Тип диска.

Optional:

• iops (Number) IOPS.

Required:

• address (Attributes) Описание шаблона адреса/адресов, которые будут выделены. Для ref будет выделен только один адрес, для spec будет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)

Optional:

• external_address (Attributes) Описание шаблона внешнего адреса/адресов, которые будут выделены. Для ref будет выделен только один адрес, для spec будет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)

Optional:

• ref (String) Ссылка на внутренний адрес эндпоинта в VPC.
• spec (Attributes) Описание шаблона адреса, который будет использоваться при выделении адресов. (see below for nested schema)

Required:

• subnet (String) Подсеть облачной сети, к которой принадлежит адрес.

Optional:

• ref (String) Ссылка на внешний адрес эндпоинта в VPC.
• spec (Attributes) Описание шаблона внешнего адреса, который будет использоваться при выделении адресов. (see below for nested schema)

Optional:

• hour (Number) Час начала окна автоматического резервного копирования.
• retain_period_days (Number) Количество дней хранения успешно снятой резервной копии.

Required:

• instances (Attributes List) (see below for nested schema)
• resources (Attributes) Параметры виртуальной машины, где будет работать Clickhouse Keeper/Zookeeper. Необязательный параметр в standalone-конфигурации. (see below for nested schema)

Optional:

• type (String) Тип координатора. Если не указано, то при наличии более одного хоста, используется Clickhouse Keeper.

Required:

• zone (String) Зона доступности.

Optional:

• count (Number) Количество инстансов в зоне доступности.

Required:

• disk (Attributes) Параметры диска. (see below for nested schema)
• vm_type (String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).

Required:

• size (String) Размер диска.
• type (String) Тип диска.

Optional:

• iops (Number) IOPS.

Required:

• address (Attributes) Описание шаблона адреса/адресов, которые будут выделены. Для ref будет выделен только один адрес, для spec будет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)

Optional:

• external_address (Attributes) Описание шаблона внешнего адреса/адресов, которые будут выделены. Для ref будет выделен только один адрес, для spec будет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)

Optional:

• ref (String) Ссылка на внутренний адрес эндпоинта в VPC.
• spec (Attributes) Описание шаблона адреса, который будет использоваться при выделении адресов. (see below for nested schema)

Required:

• subnet (String) Подсеть облачной сети, к которой принадлежит адрес.

Optional:

• ref (String) Ссылка на внешний адрес эндпоинта в VPC.
• spec (Attributes) Описание шаблона внешнего адреса, который будет использоваться при выделении адресов. (see below for nested schema)

Required:

• weekly (Attributes) (see below for nested schema)

Required:

• days (List of String) Дни недели, в которые будет запущено задание на тех. обслуживание.
• hour (Number) Час, в который будет запущено задание на тех. обслуживание.

Optional:

• duration (String) Допустимая продолжительность процесса обновления. Если не указано, то не ограничено по времени. Принимается только формат в часах (h).

Optional:

• description (String) Описание ресурса.
• display_name (String) Отображаемое имя. Необязательное поле, можно свободно задавать и изменять для удобства организации ресурсов.

Read-Only:

• create_time (String) Дата создания объекта.
• delete_time (String) Время запроса на удаление ресурса (не фактическое время удаления).
• id (String) Ссылка на типизированный референс.
• purge_time (String)
• usages (Attributes List) Связи с другими ресурсами. В зависимости от типа связи операции над ресурсом могут быть ограничены. (see below for nested schema)

Read-Only:

• name (String) Имя связи. Требуется для модификации коллекции.
• resource (String) Ссылка на ресурс.
• usage_type (String) Тип связи. Помимо стандартных own и use могут быть добавлены специализированные типы для конкретных сервисов.

Optional:

• cache_max_size (String) Максимальный размер кеша объектного хранилища, расположенный на SSD.
• data_caching_enabled (Boolean) Включить кеширование данных с объектного хранилища на сетевых SSD дисках.
• hybrid_storage_enabled (Boolean) Включить гибридное хранилище (hot SSD + cold S3).
• max_data_part_size_ssd (String) Максимальный размер части данных в байтах, который может храниться на дисках тома (SSD).
• move_factor (Number) Соотношение свободного дискового пространства на SSD дисках кластера (от 0.01 до 1) Когда это соотношение превышает значение параметра конфигурации, ClickHouse начинает перемещать данные в следующий том по порядку.

Optional:

• create (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as ”30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).
• delete (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as ”30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
• update (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as ”30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours).

Read-Only:

• cluster (Attributes) Параметры объекта кластера. (see below for nested schema)
• health (String) Работоспособность кластера:

  • ALIVE - Полностью работоспособен;
  • DEGRADED - Деградирует (некоторые, но не все, экземпляры неработоспособны);
  • FAILED - Неработоспособен;
  • UNKNOWN - Не удаётся определить состояние (на этапе создания).
• ready (Attributes) Информация о статусе реконсиляции. (see below for nested schema)
• state (String) Состояние кластера:

  • CREATING - Создаётся;
  • RUNNING - Работает в штатном режиме;
  • STOPPING - Останавливается;
  • STOPPED - Остановлен;
  • STARTING - Запуск ранее остановленного;
  • UPDATING - Выполняется обновление;
  • ERROR - Произошла ошибка, требуется участие команды поддержки;
  • DELETING - Удаляется;
  • DELETED - Удалён;
  • UNIDENTIFIED - Не удаётся определить статус;
  • RESTORING - Восстанавливается.

Read-Only:

• active (Boolean) Состояние кластера — включен или выключен.
• backup (Attributes) Спецификация работы автоматического резервного копирования. (see below for nested schema)
• config (Map of String) Настройки Clickhouse.
• coordinator (Attributes) Описание координаторов кластера. (see below for nested schema)
• endpoints (Attributes List) Список эндпойнтов для подключения к кластеру. (see below for nested schema)
• maintenance_window (Attributes) (see below for nested schema)
• shards (Attributes List) Описание шардов кластера. (see below for nested schema)
• storage (Attributes) Конфигурация схемы хранилищ ClickHouse. (see below for nested schema)
• version (String) Версия продукта.

Read-Only:

• hour (Number) Час начала окна автоматического резервного копирования.
• retain_period_days (Number) Количество дней хранения успешно снятой резервной копии.

Read-Only:

• instances (Attributes List) Описание инстансов координатора. (see below for nested schema)
• resources (Attributes) Параметры виртуальной машины, где будет работать Clickhouse Keeper/Zookeeper. Необязательный параметр в standalone-конфигурации. (see below for nested schema)
• type (String) Тип координатора. Если не указано, то при наличии более одного хоста, используется Clickhouse Keeper.

Read-Only:

• health (String)
• id (String) Идентификатор инстанса координатора.
• zone (String) Зона доступности.

Required:

• disk (Attributes) Параметры диска. (see below for nested schema)
• vm_type (String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).

Required:

• size (String) Размер диска.
• type (String) Тип диска.

Optional:

• iops (Number) IOPS.

Read-Only:

• address (Attributes) Описание эндпойнта кластера в пользовательской сети (VPC). (see below for nested schema)
• external_address (Attributes) Описание внешнего доступа к кластеру. (see below for nested schema)

Read-Only:

• dns (Attributes List) Доменные имена. (see below for nested schema)
• ip_address (String) Выделенный адрес.
• ref (String) Идентификатор адреса в VPC.
• subnet (String) Идентификатор подсети облачной сети, к которой принадлежит адрес.

Read-Only:

• name (String) DNS-имя.

Read-Only:

• ip_address (String) Выделенный адрес.
• ref (String) Идентификатор адреса в VPC.

Required:

• weekly (Attributes) (see below for nested schema)

Required:

• days (List of String) Дни недели, в которые будет запущено задание на тех. обслуживание.
• hour (Number) Час, в который будет запущено задание на тех. обслуживание.

Optional:

• duration (String) Допустимая продолжительность процесса обновления. Если не указано, то не ограничено по времени. Принимается только формат в часах (h).

Read-Only:

• endpoints (Attributes List) Список эндпойнтов для подключения к шарду. (see below for nested schema)
• id (String) Идентификатор шарда
• instances (Attributes List) Описание инстансов шарда. (see below for nested schema)
• name (String) Имя шарда, которому будут принадлежать инстансы.
• resources (Attributes) Параметры виртуальной машины, где будут работать инстансы Clickhouse данного шарда. (see below for nested schema)
• weight (Number) Вес шарда.

Read-Only:

• address (Attributes) Описание эндпойнта кластера в пользовательской сети (VPC). (see below for nested schema)
• external_address (Attributes) Описание внешнего доступа к кластеру. (see below for nested schema)

Read-Only:

• dns (Attributes List) Доменные имена. (see below for nested schema)
• ip_address (String) Выделенный адрес.
• ref (String) Идентификатор адреса в VPC.
• subnet (String) Идентификатор подсети облачной сети, к которой принадлежит адрес.

Read-Only:

• name (String) DNS-имя.

Read-Only:

• ip_address (String) Выделенный адрес.
• ref (String) Идентификатор адреса в VPC.

Read-Only:

• endpoints (Attributes List) Список эндпойнтов для подключения к инстансу. (see below for nested schema)
• health (String)
• id (String) Идентификатор инстанса шарда.
• zone (String) Зона доступности.

Read-Only:

• address (Attributes) Описание эндпойнта кластера в пользовательской сети (VPC). (see below for nested schema)
• external_address (Attributes) Описание внешнего доступа к кластеру. (see below for nested schema)

Read-Only:

• dns (Attributes List) Доменные имена. (see below for nested schema)
• ip_address (String) Выделенный адрес.
• ref (String) Идентификатор адреса в VPC.
• subnet (String) Идентификатор подсети облачной сети, к которой принадлежит адрес.

Read-Only:

• name (String) DNS-имя.

Read-Only:

• ip_address (String) Выделенный адрес.
• ref (String) Идентификатор адреса в VPC.

Required:

• disk (Attributes) Параметры диска. (see below for nested schema)
• vm_type (String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).

Required:

• size (String) Размер диска.
• type (String) Тип диска.

Optional:

• iops (Number) IOPS.

Optional:

• cache_max_size (String) Максимальный размер кеша объектного хранилища, расположенный на SSD.
• data_caching_enabled (Boolean) Включить кеширование данных с объектного хранилища на сетевых SSD дисках.
• hybrid_storage_enabled (Boolean) Включить гибридное хранилище (hot SSD + cold S3).
• max_data_part_size_ssd (String) Максимальный размер части данных в байтах, который может храниться на дисках тома (SSD).
• move_factor (Number) Соотношение свободного дискового пространства на SSD дисках кластера (от 0.01 до 1) Когда это соотношение превышает значение параметра конфигурации, ClickHouse начинает перемещать данные в следующий том по порядку.

Read-Only:

• message (String) Описание статуса.
• state (String) Состояние ресурса.