mws_mclickhouse_cluster (Data Source)
Заголовок раздела «mws_mclickhouse_cluster (Data Source)»Кластер Managed ClickHouse — это группа узлов (виртуальных машин), объединенных для высокоскоростной обработки и хранения данных с помощью СУБД ClickHouse. В облачной инфраструктуре кластер — единый интерфейс управления оперативной аналитической обработкой данных (OLAP, On-Line Analytical Processing) в реальном времени
Примеры использования
Заголовок раздела «Примеры использования»data "mws_mclickhouse_cluster" "mclickhouse_cluster_name" { cluster = "example-cluster"}Required
Заголовок раздела «Required»cluster(String) Название или идентификатор кластера.
Optional
Заголовок раздела «Optional»project(String) Путь к проекту.
Read-Only
Заголовок раздела «Read-Only»active(Boolean) Состояние кластера — включен или выключен.backup(Attributes) Спецификация работы автоматического резервного копирования. (see below for nested schema)bootstrap_admin(Attributes) Добавление пользователей при создании кластера Clickhouse. (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)shards(Attributes List) Описание шардов кластера. (see below for nested schema)status(Attributes) (see below for nested schema)storage(Attributes) Конфигурация схемы хранилищ ClickHouse. (see below for nested schema)version(String) Версия продукта.
Nested Schema for backup
Заголовок раздела «Nested Schema for backup»Read-Only:
hour(Number) Час начала окна автоматического резервного копирования.retain_period_days(Number) Количество дней хранения успешно снятой резервной копии.
Nested Schema for bootstrap_admin
Заголовок раздела «Nested Schema for bootstrap_admin»Read-Only:
username(String) Имя учетной записи администратора.
Nested Schema for coordinator
Заголовок раздела «Nested Schema for coordinator»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.
Nested Schema for coordinator.instances
Заголовок раздела «Nested Schema for coordinator.instances»Read-Only:
count(Number) Количество инстансов в зоне доступности.zone(String) Зона доступности.
Nested Schema for coordinator.resources
Заголовок раздела «Nested Schema for coordinator.resources»Read-Only:
disk(Attributes) Параметры диска. (see below for nested schema)vm_type(String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).
Nested Schema for coordinator.resources.disk
Заголовок раздела «Nested Schema for coordinator.resources.disk»Read-Only:
iops(Number) IOPS.size(String) Размер диска.type(String) Тип диска.
Nested Schema for endpoints
Заголовок раздела «Nested Schema for endpoints»Read-Only:
address(Attributes) Описание шаблона адреса/адресов, которые будут выделены. Дляrefбудет выделен только один адрес, дляspecбудет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)external_address(Attributes) Описание шаблона внешнего адреса/адресов, которые будут выделены. Дляrefбудет выделен только один адрес, дляspecбудет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)
Nested Schema for endpoints.address
Заголовок раздела «Nested Schema for endpoints.address»Read-Only:
ref(String) Ссылка на внутренний адрес эндпоинта в VPC.spec(Attributes) Описание шаблона адреса, который будет использоваться при выделении адресов. (see below for nested schema)
Nested Schema for endpoints.address.spec
Заголовок раздела «Nested Schema for endpoints.address.spec»Read-Only:
subnet(String) Подсеть облачной сети, которой принадлежит адрес.
Nested Schema for endpoints.external_address
Заголовок раздела «Nested Schema for endpoints.external_address»Read-Only:
ref(String) Ссылка на внешний адрес эндпоинта в VPC.spec(Attributes) Описание шаблона внешнего адреса, который будет использоваться при выделении адресов. (see below for nested schema)
Nested Schema for endpoints.external_address.spec
Заголовок раздела «Nested Schema for endpoints.external_address.spec»Nested Schema for maintenance_window
Заголовок раздела «Nested Schema for maintenance_window»Read-Only:
weekly(Attributes) (see below for nested schema)
Nested Schema for maintenance_window.weekly
Заголовок раздела «Nested Schema for maintenance_window.weekly»Read-Only:
days(List of String) Дни недели, в которые будет запущено задание на тех. обслуживание.duration(String) Допустимая продолжительность процесса обновления. Если не указано, то не ограничено по времени. Принимается только формат в часах (h).hour(Number) Час, в который будет запущено задание на тех. обслуживание.
Nested Schema for metadata
Заголовок раздела «Nested Schema for metadata»Read-Only:
create_time(String) Дата создания объекта.delete_time(String) Время запроса на удаление ресурса (не фактическое время удаления).description(String) Описание ресурса.display_name(String) Отображаемое имя. Необязательное поле, можно свободно задавать и изменять для удобства организации ресурсов.id(String) Ссылка на типизированный референс.purge_time(String)usages(Attributes List) Связи с другими ресурсами. В зависимости от типа связи операции над ресурсом могут быть ограничены. (see below for nested schema)
Nested Schema for metadata.usages
Заголовок раздела «Nested Schema for metadata.usages»Read-Only:
name(String) Имя связи, требуется для модификации коллекции.resource(String) Ссылка на ресурс.usage_type(String) Тип связи. Помимо стандартныхownиuseмогут быть добавлены специализированные типы для конкретных сервисов
Nested Schema for shards
Заголовок раздела «Nested Schema for shards»Read-Only:
count(Number) Количество шардов, которые будут созданы.endpoints(Attributes List) Описание эдпойнтов шардов. (see below for nested schema)instances(Attributes List) (see below for nested schema)name(String) Имя шарда, которому будут принадлежать инстансы. В случае с несколькими шардами имя формируется какname-{shardIndex}.resources(Attributes) Ресурсы одной ноды Clickhouse. (see below for nested schema)weight(Number) Вес шарда.
Nested Schema for shards.endpoints
Заголовок раздела «Nested Schema for shards.endpoints»Read-Only:
address(Attributes) Описание шаблона адреса/адресов, которые будут выделены. Дляrefбудет выделен только один адрес, дляspecбудет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)external_address(Attributes) Описание шаблона внешнего адреса/адресов, которые будут выделены. Дляrefбудет выделен только один адрес, дляspecбудет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)
Nested Schema for shards.endpoints.address
Заголовок раздела «Nested Schema for shards.endpoints.address»Read-Only:
ref(String) Ссылка на внутренний адрес эндпоинта в VPC.spec(Attributes) Описание шаблона адреса, который будет использоваться при выделении адресов. (see below for nested schema)
Nested Schema for shards.endpoints.address.spec
Заголовок раздела «Nested Schema for shards.endpoints.address.spec»Read-Only:
subnet(String) Подсеть облачной сети, к которой принадлежит адрес.
Nested Schema for shards.endpoints.external_address
Заголовок раздела «Nested Schema for shards.endpoints.external_address»Read-Only:
ref(String) Ссылка на внешний адрес эндпоинта в VPC.spec(Attributes) Описание шаблона внешнего адреса, который будет использоваться при выделении адресов. (see below for nested schema)
Nested Schema for shards.endpoints.external_address.spec
Заголовок раздела «Nested Schema for shards.endpoints.external_address.spec»Nested Schema for shards.instances
Заголовок раздела «Nested Schema for shards.instances»Read-Only:
count(Number) Количество инстансов в зоне доступности.endpoints(Attributes List) Описание эдпойнтов инстансов. (see below for nested schema)name(String) Имя инстанса в шарде. В случае с несколькими инстансами имя формируется какname-{replicaIndex}, гдеreplicaIndexимеет сквозную нумерацию в шарде.zone(String) Зона доступности.
Nested Schema for shards.instances.endpoints
Заголовок раздела «Nested Schema for shards.instances.endpoints»Read-Only:
address(Attributes) Описание шаблона адреса/адресов, которые будут выделены. Дляrefбудет выделен только один адрес, дляspecбудет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)external_address(Attributes) Описание шаблона внешнего адреса/адресов, которые будут выделены. Дляrefбудет выделен только один адрес, дляspecбудет выделено необходимое количество адресов в зависимости от сущности, для которой выделяются адреса. (see below for nested schema)
Nested Schema for shards.instances.endpoints.address
Заголовок раздела «Nested Schema for shards.instances.endpoints.address»Read-Only:
ref(String) Ссылка на внутренний адрес эндпоинта в VPC.spec(Attributes) Описание шаблона адреса, который будет использоваться при выделении адресов. (see below for nested schema)
Nested Schema for shards.instances.endpoints.address.spec
Заголовок раздела «Nested Schema for shards.instances.endpoints.address.spec»Read-Only:
subnet(String) Подсеть облачной сети, к которой принадлежит адрес.
Nested Schema for shards.instances.endpoints.external_address
Заголовок раздела «Nested Schema for shards.instances.endpoints.external_address»Read-Only:
ref(String) Ссылка на внешний адрес эндпоинта в VPC.spec(Attributes) Описание шаблона внешнего адреса, который будет использоваться при выделении адресов. (see below for nested schema)
Nested Schema for shards.instances.endpoints.external_address.spec
Заголовок раздела «Nested Schema for shards.instances.endpoints.external_address.spec»Nested Schema for shards.resources
Заголовок раздела «Nested Schema for shards.resources»Read-Only:
disk(Attributes) Параметры диска. (see below for nested schema)vm_type(String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).
Nested Schema for shards.resources.disk
Заголовок раздела «Nested Schema for shards.resources.disk»Read-Only:
iops(Number) IOPS.size(String) Размер диска.type(String) Тип диска.
Nested Schema for status
Заголовок раздела «Nested Schema for status»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- Восстанавливается.
Nested Schema for status.cluster
Заголовок раздела «Nested Schema for status.cluster»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) Версия продукта.
Nested Schema for status.cluster.backup
Заголовок раздела «Nested Schema for status.cluster.backup»Read-Only:
hour(Number) Час начала окна автоматического резервного копирования.retain_period_days(Number) Количество дней хранения успешно снятой резервной копии.
Nested Schema for status.cluster.coordinator
Заголовок раздела «Nested Schema for status.cluster.coordinator»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.
Nested Schema for status.cluster.coordinator.instances
Заголовок раздела «Nested Schema for status.cluster.coordinator.instances»Read-Only:
health(String)id(String) Идентификатор инстанса координатора.zone(String) Зона доступности.
Nested Schema for status.cluster.coordinator.resources
Заголовок раздела «Nested Schema for status.cluster.coordinator.resources»Read-Only:
disk(Attributes) Параметры диска. (see below for nested schema)vm_type(String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).
Nested Schema for status.cluster.coordinator.resources.disk
Заголовок раздела «Nested Schema for status.cluster.coordinator.resources.disk»Read-Only:
iops(Number) IOPS.size(String) Размер диска.type(String) Тип диска.
Nested Schema for status.cluster.endpoints
Заголовок раздела «Nested Schema for status.cluster.endpoints»Read-Only:
address(Attributes) Описание эндпойнта кластера в пользовательской сети (VPC). (see below for nested schema)external_address(Attributes) Описание внешнего доступа к кластеру. (see below for nested schema)
Nested Schema for status.cluster.endpoints.address
Заголовок раздела «Nested Schema for status.cluster.endpoints.address»Read-Only:
dns(Attributes List) Доменные имена. (see below for nested schema)ip_address(String) Выделенный адрес.ref(String) Идентификатор адреса в VPC.subnet(String) Идентификатор подсети облачной сети, к которой принадлежит адрес.
Nested Schema for status.cluster.endpoints.address.dns
Заголовок раздела «Nested Schema for status.cluster.endpoints.address.dns»Read-Only:
name(String) DNS-имя.
Nested Schema for status.cluster.endpoints.external_address
Заголовок раздела «Nested Schema for status.cluster.endpoints.external_address»Read-Only:
ip_address(String) Выделенный адрес.ref(String) Идентификатор адреса в VPC.
Nested Schema for status.cluster.maintenance_window
Заголовок раздела «Nested Schema for status.cluster.maintenance_window»Read-Only:
weekly(Attributes) (see below for nested schema)
Nested Schema for status.cluster.maintenance_window.weekly
Заголовок раздела «Nested Schema for status.cluster.maintenance_window.weekly»Read-Only:
days(List of String) Дни недели, в которые будет запущено задание на тех. обслуживание.duration(String) Допустимая продолжительность процесса обновления. Если не указано, то не ограничено по времени. Принимается только формат в часах (h).hour(Number) Час, в который будет запущено задание на тех. обслуживание.
Nested Schema for status.cluster.shards
Заголовок раздела «Nested Schema for status.cluster.shards»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) Вес шарда.
Nested Schema for status.cluster.shards.endpoints
Заголовок раздела «Nested Schema for status.cluster.shards.endpoints»Read-Only:
address(Attributes) Описание эндпойнта кластера в пользовательской сети (VPC). (see below for nested schema)external_address(Attributes) Описание внешнего доступа к кластеру. (see below for nested schema)
Nested Schema for status.cluster.shards.endpoints.address
Заголовок раздела «Nested Schema for status.cluster.shards.endpoints.address»Read-Only:
dns(Attributes List) Доменные имена. (see below for nested schema)ip_address(String) Выделенный адрес.ref(String) Идентификатор адреса в VPC.subnet(String) Идентификатор подсети облачной сети, к которой принадлежит адрес.
Nested Schema for status.cluster.shards.endpoints.address.dns
Заголовок раздела «Nested Schema for status.cluster.shards.endpoints.address.dns»Read-Only:
name(String) DNS-имя.
Nested Schema for status.cluster.shards.endpoints.external_address
Заголовок раздела «Nested Schema for status.cluster.shards.endpoints.external_address»Read-Only:
ip_address(String) Выделенный адрес.ref(String) Идентификатор адреса в VPC.
Nested Schema for status.cluster.shards.instances
Заголовок раздела «Nested Schema for status.cluster.shards.instances»Read-Only:
endpoints(Attributes List) Список эндпойнтов для подключения к инстансу. (see below for nested schema)health(String)id(String) Идентификатор инстанса шарда.zone(String) Зона доступности.
Nested Schema for status.cluster.shards.instances.endpoints
Заголовок раздела «Nested Schema for status.cluster.shards.instances.endpoints»Read-Only:
address(Attributes) Описание эндпойнта кластера в пользовательской сети (VPC). (see below for nested schema)external_address(Attributes) Описание внешнего доступа к кластеру. (see below for nested schema)
Nested Schema for status.cluster.shards.instances.endpoints.address
Заголовок раздела «Nested Schema for status.cluster.shards.instances.endpoints.address»Read-Only:
dns(Attributes List) Доменные имена. (see below for nested schema)ip_address(String) Выделенный адрес.ref(String) Идентификатор адреса в VPC.subnet(String) Идентификатор подсети облачной сети, к которой принадлежит адрес.
Nested Schema for status.cluster.shards.instances.endpoints.address.dns
Заголовок раздела «Nested Schema for status.cluster.shards.instances.endpoints.address.dns»Read-Only:
name(String) DNS-имя.
Nested Schema for status.cluster.shards.instances.endpoints.external_address
Заголовок раздела «Nested Schema for status.cluster.shards.instances.endpoints.external_address»Read-Only:
ip_address(String) Выделенный адрес.ref(String) Идентификатор адреса в VPC.
Nested Schema for status.cluster.shards.resources
Заголовок раздела «Nested Schema for status.cluster.shards.resources»Read-Only:
disk(Attributes) Параметры диска. (see below for nested schema)vm_type(String) Тип виртуальной машины, описывающий ресурсы (vCPU, memory).
Nested Schema for status.cluster.shards.resources.disk
Заголовок раздела «Nested Schema for status.cluster.shards.resources.disk»Read-Only:
iops(Number) IOPS.size(String) Размер диска.type(String) Тип диска.
Nested Schema for status.cluster.storage
Заголовок раздела «Nested Schema for status.cluster.storage»Read-Only:
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 начинает перемещать данные в следующий том по порядку.
Nested Schema for status.ready
Заголовок раздела «Nested Schema for status.ready»Read-Only:
message(String) Описание статуса.state(String) Состояние ресурса.
Nested Schema for storage
Заголовок раздела «Nested Schema for storage»Read-Only:
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 начинает перемещать данные в следующий том по порядку.