Resource nubes_clickhouse · Service ID: 120 · Service Name: ClickHouse

Manual · Create params · Modify params · Output params · Operations · Example

Create params

Обязательные параметры (вводимые пользователем)

ID	Code	Type	Description	Constraints
837	startup_configuration	map-fixed
838	cluster_configuration	map-fixed
839	access_configuration	map-fixed
840	clickhouse_keeper_configuration	map-fixed
841	clickhouse_configuration	map-fixed
842	backup_configuration	map-fixed
843	autoscale_configuration	map-fixed
851	clickhouse_files_configuration	array-map-fixed	Формат: - path: somethings3.xml xmlConfig: '<clickhouse>......</clickhouse>'

startupConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
194	resource_realm	string	**yes**		Кластер Kubernetes, на котором будет развернут экземпляр	value_list=iot-naeel, k8s-3-sandbox-nubes-ru, k8s-4-sandbox-nubes-ru, naeel-test-3

clusterConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
196	memory	integer	**yes**	2048	Указывается в Megabytes
197	replicas	integer	**yes**	1		value_list=1, 3, 5, 7
199	shards	integer	**yes**	1	**Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. **Реплика** - это точная копия данных внутри одного шарда	value_list=1, 2, 3
198	disk	integer	**yes**	10	Указывается в GIGAbytes
195	cpu	integer	**yes**	1000	Указывается в Milicores `1000` Mili == `1` Ядро

accessConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
200	master_ip_space	string	**yes**		Из какого Ip-Space резервировать внешний IP Список предоставляется из Организации, в котором развёрнута ресурсная платформа
201	master_access_list	json	**yes**	[]	Необходимо настраивать, когда зарезервирован внешний адрес Если передан пустой массив, доступ выделяется всем

clickhouseKeeperConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
203	memory	integer	**yes**	512	Указывается в Megabytes
204	replicas	integer	**yes**	0	Если указан 0, то инстансы ClickHouse Keeper развёрнуты не будут	value_list=0, 1, 3
202	cpu	integer	**yes**	500	Указывается в Milicores `1000` Mili == `1` Ядро

clickhouseConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
205	version	string	**yes**	25.10		value_list=25.10

backupConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
206	s3_uid	uuid	**yes**		Экземпляр S3 обязателен
207	retain	integer	**yes**	7
208	schedule	string	**yes**	0 0 * * *		regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$

autoscaleConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
209	enabled	boolean	**yes**	false	Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги	value_list=false, true
210	schedule	integer	**yes**	0	Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)	value_list=0, 5, 12, 23
211	quota	integer	**yes**	100	До какого размера возможно увеличивать диск, когда включен Autoscale
212	percent	integer	**yes**	10	Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема Минимальный размер на который расширяется - **1Gb**	value_list=10, 15, 20

clickhouseFilesConfiguration (map-fixed)

ID	Code	Type	Required	Default	Description	Constraints
234	path	string	**yes**	something.xml		regex=^[a-zA-Z0-9]+\.xml$
235	xml_config	string	**yes**	<clickhouse></clickhouse>	Предварительно xml необходимо отформатировать через ``` $ tr -d '\n \t' < input.xml > output.xml ``` Позже будет исправлено

Параметры поведения (кратко)
По умолчанию: `suspend_on_destroy = True`, `adopt_existing_on_create = False`.
При `terraform destroy` или удалении ресурса из манифеста:
- `suspend_on_destroy=true` — инстанс переводится в `Suspend` (не удаляется).
- `suspend_on_destroy=false` — Terraform удаляет ресурс только из state.
При `apply` флаг `adopt_existing_on_create` работает как авто-`import`:
- `false` — если ресурс уже есть, будет ошибка.
- `true` — Terraform может взять существующий инстанс под управление (`running` → adopt, `suspended` → resume+adopt при совпадении параметров).
Важно: один инстанс должен быть только в одном state. Иначе получите конфликт управления.