# Operations: nubes_clickhouse

| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `181` | resourceRealm, s3Uid, resourceInstances, resourceInstancesShards, resourceCPU, resourceMemory, appVersion, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, needCreateKeeper, resourceCPUKeeper, resourceMemoryKeeper, resourceInstancesKeeper, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN | Операция создания кластера ClickHouse<br/><br/>Для подключения к кластеру также необходимо создать базу данных через операцию `create_database` и создание пользователя через операцию `create_user` |
| `create_database` | `subresource` | `create` | `database` | `186` | databaseName | База данных создаётся на всех репликах кластера ClickHouse |
| `create_user` | `subresource` | `create` | `user` | `185` | username, databaseName, accessHosts |  |
| `delete` | `instance` | `delete` | `` | `184` |  | Удаление возможно только после остановки сервиса через операцию `suspend`<br/>После выполнения операции необходимо выждать определенное кол-во времени |
| `delete_database` | `subresource` | `delete` | `database` | `188` | databaseName | Необратимое действие!!!<br/>Трижды подумай, заблокируй телефон тимлида и не выполняй это действие |
| `delete_user` | `subresource` | `delete` | `user` | `187` | username |  |
| `modify` | `instance` | `modify` | `` | `189` | resourceInstances, resourceInstancesShards, resourceCPU, resourceMemory, appVersion, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, needCreateKeeper, resourceCPUKeeper, resourceMemoryKeeper, resourceInstancesKeeper, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN |  |
| `resume` | `instance` | `resume` | `` | `183` |  |  |
| `suspend` | `instance` | `suspend` | `` | `182` |  | Операция приводит к удалению всех подов<br/>Persistent Volume остаются нетронутыми |

## Operation: create

| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `resourceRealm` | `string` | `ДА` | `` | Кластер Kubernetes в котором будет развёрнуто приложение | Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы | func=getAvailableResourceRealms | `572` |
| `s3Uid` | `uuid` | `ДА` | `` | Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно | **Если список не отображается** <br/>перейдите в раздел `S3 Object Storage` <br/>операция `create` | ref_svc_id=12 | `573` |
| `resourceInstances` | `integer &gt; 0` | `ДА` | `1` | Пример: `3` | **Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper` | minvalue=1; maxvalue=7 | `574` |
| `resourceInstancesShards` | `integer &gt; 0` | `ДА` | `1` | Пример: `1` | **Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда | minvalue=1; maxvalue=7 | `575` |
| `resourceCPU` | `integer &gt; 0` | `ДА` | `1000` | Пример: `1000` | Указывается в Milicores<br/>`1000` Mili == `1` Ядро | minvalue=1000; maxvalue=8000 | `576` |
| `resourceMemory` | `integer &gt; 0` | `ДА` | `1536` | Пример: `2048` | Указывается в Megabytes | minvalue=1536; maxvalue=8192 | `577` |
| `appVersion` | `string` | `ДА` | `25.10` | Версия `clickhouse-server` |  | value_list=25.10 | `578` |
| `resourceDisk` | `integer &gt; 0` | `ДА` | `10` | Пример: `100` | Указывается в Gigabytes | minvalue=1; maxvalue=999 | `579` |
| `needExternalAddressMaster` | `boolean` | `ДА` | `false` | Позволяет подключиться извне к ClickHouse | Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы | value_list=false, true | `580` |
| `ipSpaceNameMaster` | `string` | `НЕТ` | `` | Пример: `internet-no-antiddos-v1` | Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды` |  | `581` |
| `needCreateKeeper` | `boolean` | `ДА` | `true` | Необходим для кластеризации ClickHouse | Аналог `Zookeeper`, представленный от ClickHouse | value_list=false, true | `582` |
| `resourceCPUKeeper` | `integer &gt; 0` | `ДА` | `50` | Пример: `100` | Указывается в Milicores<br/>`1000` Mili == `1` Ядро | minvalue=50; maxvalue=8000 | `583` |
| `resourceMemoryKeeper` | `integer &gt; 0` | `ДА` | `152` | Пример: `256` | Указывается в Megabytes | minvalue=152; maxvalue=8192 | `584` |
| `resourceInstancesKeeper` | `integer &gt; 0` | `ДА` | `1` | Пример: `1` | Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды | minvalue=1; maxvalue=3; value_list=1, 3 | `585` |
| `ext_BACKUP_SCHEDULE` | `string` | `ДА` | `0 0 * * *` | Принимает формат `CRON` |  | 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))+)$ | `586` |
| `ext_BACKUP_NUM_TO_RETAIN` | `integer &gt; 0` | `ДА` | `7` | Пример: `7` | Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты** | minvalue=3; maxvalue=60 | `587` |

## Operation: create_database

| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `databaseName` | `string` | `ДА` | `` | Пример: `db01` |  | regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$ | `600` |

## Operation: create_user

| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `username` | `string` | `ДА` | `` | Пример: `myusername` |  | regex=^(?![0-9_])[a-zA-Z_][a-zA-Z0-9_]{0,62}$; maxlength=62; minlength=2 | `596` |
| `databaseName` | `json` | `ДА` | `["database"]` | Необходимо указать массив существующих баз | Если базы не существует - при выполнении операции вернётся ошибка |  | `598` |
| `accessHosts` | `string` | `ДА` | `::/0` | Пример: `::/0` |  |  | `599` |

## Operation: delete

None.

## Operation: delete_database

| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `databaseName` | `string` | `ДА` | `` | ВСЕ ДАННЫЕ ВНУТРИ БД БУДУТ УДАЛЕНЫ |  |  | `602` |

## Operation: delete_user

| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `username` | `` | `ДА` | `` | Имя пользователя, созданное через операцию `create_user` |  |  | `601` |

## Operation: modify

| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `resourceInstances` | `integer &gt; 0` | `ДА` | `` | Пример: `3` | **Для синхронизации данных между репликами** необходимо включить `Создать ClickHouse-Keeper` | minvalue=1; maxvalue=7 | `603` |
| `resourceInstancesShards` | `integer &gt; 0` | `ДА` | `` | Пример: `1` | **Шард** - это часть данных, разделенная на разные узлы (серверы) для горизонтального масштабирования и обработки больших объемов информации. <br/>**Реплика** - это точная копия данных внутри одного шарда | minvalue=1; maxvalue=7 | `604` |
| `resourceCPU` | `integer &gt; 0` | `ДА` | `` | Пример: `1000` | Указывается в Milicores<br/>`1000` Mili == `1` Ядро | minvalue=1000; maxvalue=8000 | `605` |
| `resourceMemory` | `integer &gt; 0` | `ДА` | `` | Пример: `2048` | Указывается в Megabytes | minvalue=1536; maxvalue=8192 | `606` |
| `appVersion` | `string` | `ДА` | `25.10` | Версия `clickhouse-server` |  |  | `607` |
| `resourceDisk` | `integer &gt; 0` | `ДА` | `` | Пример: `100` | Указывается в Gigabytes<br/>**Нельзя** выставлять меньше текущего значения | minvalue=1; maxvalue=999 | `608` |
| `needExternalAddressMaster` | `boolean` | `ДА` | `` | Позволяет подключиться извне к ClickHouse | Для выделения IP также необходимо указать имя Ip-space.<br/>Его можно получить из свойств ресурсной платформы | value_list=false, true | `609` |
| `ipSpaceNameMaster` | `string` | `ДА` | `` | Пример: `internet-no-antiddos-v1` | Имя ipSpace для публикации внешнего адреса<br/><br/>Не может быть пустым, если включен `Выделение белого ip для master ноды` |  | `610` |
| `needCreateKeeper` | `boolean` | `ДА` | `` | Необходим для кластеризации ClickHouse | Аналог `Zookeeper`, представленный от ClickHouse | value_list=false, true | `611` |
| `resourceCPUKeeper` | `integer &gt; 0` | `ДА` | `` | Пример: `100` | Указывается в Milicores<br/>`1000` Mili == `1` Ядро | minvalue=50; maxvalue=8000 | `612` |
| `resourceMemoryKeeper` | `integer &gt; 0` | `ДА` | `` | Пример: `256` | Указывается в Megabytes | minvalue=152; maxvalue=8192 | `613` |
| `resourceInstancesKeeper` | `integer &gt; 0` | `ДА` | `` | Пример: `1` | Для **теста** - 1 нода. <br/>Для **продуктива** - 3 ноды | minvalue=1; maxvalue=3; value_list=1, 3 | `614` |
| `ext_BACKUP_SCHEDULE` | `string` | `ДА` | `0 0 * * *` | Принимает формат `CRON` |  | 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))+)$ | `615` |
| `ext_BACKUP_NUM_TO_RETAIN` | `integer &gt; 0` | `ДА` | `` | Пример: `7` | Кол-во **полных** резервных копий<br/>Кол-во инкрементов - неограничено<br/><br/>Полная резервная копия выполняется раз в неделю<br/>*Если изначально полной резервной копии нет* выполняется полный бекап<br/>В остальные дни по крону выполняются **инкременты** | minvalue=3; maxvalue=60 | `616` |

## Operation: resume

None.

## Operation: suspend

None.