# Provider resources (full list)

Auto-generated summary from API/YAML (max detail).

## nubes_dummy
- Service ID: 1
- Description: Болванка для тестов
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
## Болванка для тестов.<br/><br/>А это просто много букв, чтобы посмотреть, как ведет себя текст при переполнении контейнера. <br/><br/><br/>``` json<br/>{<br/>    &quot;iamServiceUrl&quot;: &quot;https://auth-api-test.ngcloud.ru/api/v1/user&quot;,<br/>    &quot;idpResponse&quot;: {<br/>        &quot;prefix&quot;: {<br/>            &quot;charset&quot;: &quot;&quot;,<br/>            &quot;status_text&quot;: &quot;Request Time-out&quot;,<br/>            &quot;text&quot;: true,<br/>            &quot;errordetail&quot;: &quot;&quot;,<br/>            &quot;filecontent&quot;: &quot;Connection Timeout&quot;,<br/>            &quot;responseheader&quot;: {},<br/>            &quot;header&quot;: &quot;&quot;,<br/>            &quot;statuscode&quot;: &quot;408 Request Time-out&quot;,<br/>            &quo...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>198</td><td><strong><code class="code-no-wrap">durationMs</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>0</code></td><td>перед завершением подождать (sleep) столько миллисекунд</td><td></td></tr>
<tr><td>199</td><td><strong><code class="code-no-wrap">failAtStart</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>**Операция не будет завершена**<br/>Она будет в постоянном статусе PENDING, однако в Jenkins Job завершится с ошибкой</td><td>value_list=false, true</td></tr>
<tr><td>200</td><td><strong><code class="code-no-wrap">failInProgress</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb</td><td>value_list=false, true</td></tr>
<tr><td>201</td><td><strong><code class="code-no-wrap">whereFail</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>1</code></td><td>принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write</td><td>value_list=1, 2, 3</td></tr>
<tr><td>242</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование ресурсной платформы для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>286</td><td><strong><code class="code-no-wrap">bodymessage</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Дата, уходящая в Vault</td><td></td></tr>
<tr><td>321</td><td><strong><code class="code-no-wrap">mapExample</code></strong></td><td><code>map</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>322</td><td><strong><code class="code-no-wrap">jsonExample</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Для тестирования интерфейса. Сюда можно писать корректный json</td><td></td></tr>
<tr><td>396</td><td><strong><code class="code-no-wrap">nestedRefExample</code></strong></td><td></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>447</td><td><strong><code class="code-no-wrap">yamlExample</code></strong></td><td><code>yaml</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>647</td><td><strong><code class="code-no-wrap">mapFixed</code></strong></td><td><code>map-fixed</code></td><td>НЕТ</td><td></td><td>Новый тип поля</td><td></td></tr>
<tr><td>654</td><td><strong><code class="code-no-wrap">arrayMapFixedExample</code></strong></td><td><code>array-map-fixed</code></td><td>НЕТ</td><td></td><td>Array of map-fixed</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>287</td><td><strong><code class="code-no-wrap">durationMs</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>0</code></td><td>перед завершением подождать (sleep) столько миллисекунд</td><td></td></tr>
<tr><td>288</td><td><strong><code class="code-no-wrap">failAtStart</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>если true, завершить джоб, ничего не записывая в cmdb</td><td>value_list=false, true</td></tr>
<tr><td>289</td><td><strong><code class="code-no-wrap">failInProgress</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb</td><td>value_list=false, true</td></tr>
<tr><td>290</td><td><strong><code class="code-no-wrap">whereFail</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write</td><td>value_list=1, 2, 3</td></tr>
<tr><td>291</td><td><strong><code class="code-no-wrap">bodymessage</code></strong></td><td></td><td>НЕТ</td><td></td><td>Дата, уходящая в Vault</td><td></td></tr>
<tr><td>373</td><td><strong><code class="code-no-wrap">mapExample</code></strong></td><td><code>map</code></td><td>НЕТ</td><td><code>{}</code></td><td></td><td></td></tr>
<tr><td>374</td><td><strong><code class="code-no-wrap">jsonExample</code></strong></td><td></td><td>НЕТ</td><td></td><td></td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `18` | durationMs, failAtStart, failInProgress, whereFail, resourceRealm, bodymessage, mapExample, jsonExample, nestedRefExample, yamlExample, mapFixed, arrayMapFixedExample | Это мануал к операции CREATE сервиса Болванка |
| `delete` | `instance` | `delete` | `` | `71` |  |  |
| `modify` | `instance` | `modify` | `` | `92` | durationMs, failAtStart, failInProgress, whereFail, bodymessage, mapExample, jsonExample |  |
| `redeploy` | `action` | `redeploy` | `` | `240` |  |  |
| `resume` | `instance` | `resume` | `` | `94` |  |  |
| `suspend` | `instance` | `suspend` | `` | `93` |  |  |


## nubes_template
- Service ID: 2
- Description: Болванка для тестирования
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>202</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>100</code></td><td></td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>203</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>200</code></td><td></td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>204</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>205</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>206</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>207</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>208</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>209</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>210</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>211</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `74` | resourceCPU, resourceMemory, resourceDisk, resourceInstances, resourceRealm, domain |  |
| `delete` | `instance` | `delete` | `` | `75` |  |  |
| `modify` | `instance` | `modify` | `` | `76` | resourceCPU, resourceMemory, resourceDisk, resourceInstances |  |
| `resume` | `instance` | `resume` | `` | `98` |  |  |
| `suspend` | `instance` | `suspend` | `` | `97` |  |  |


## nubes_s3
- Service ID: 12
- Description: Масштабируемое хранилище данных
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Руководство доступно по ссылке:<br/>https://docs.s3.msk-1.ngcloud.ru/s3/s3.description.html

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>163</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>320</td><td><strong><code class="code-no-wrap">displayName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Человеко-читаемое имя (транслит из Elma) - передаётся имя клиента</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>50</td><td><strong><code class="code-no-wrap">maxSizeGbPerUser</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>maxSizeGb. Передаём руками</td><td>minvalue=-1; maxvalue=50000</td></tr>
<tr><td>51</td><td><strong><code class="code-no-wrap">maxObjectsPerBucket</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота на бакет. Кол-во объектов. Передаём руками</td><td>minvalue=1; maxvalue=1e+07</td></tr>
<tr><td>52</td><td><strong><code class="code-no-wrap">maxBucketsPerUser</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота на пользователя. Количество бакетов пользователя. Передаём руками</td><td>minvalue=1; maxvalue=1000</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `1` | resourceRealm, displayName |  |
| `create_sub_user` | `subresource` | `create` | `sub_user` | `6` | subUserName, subUserAccess |  |
| `delete` | `instance` | `delete` | `` | `5` |  |  |
| `delete_sub_user` | `subresource` | `delete` | `sub_user` | `7` | subUserName |  |
| `modify` | `instance` | `modify` | `` | `4` | maxSizeGbPerUser, maxObjectsPerBucket, maxBucketsPerUser | При первичном вызове операции услуга Trial прекращает действие |
| `resume` | `instance` | `resume` | `` | `3` |  |  |
| `suspend` | `instance` | `suspend` | `` | `2` |  |  |


## nubes_s3bucket
- Service ID: 13
- Description: Бакет в сервисе S3
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>124</td><td><strong><code class="code-no-wrap">s3UserUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>UID Корневой услуги S3. На основе него будет создан бакет.</td><td>ref_svc_id=12</td></tr>
<tr><td>125</td><td><strong><code class="code-no-wrap">bucketName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя бакета s3</td><td></td></tr>
<tr><td>126</td><td><strong><code class="code-no-wrap">maxSize</code></strong></td><td></td><td>ДА</td><td><code>-1</code></td><td>Максимальный размер бакета s3. Если поставить -1, будет безлимит. Размер указывается в Bytes</td><td></td></tr>
<tr><td>127</td><td><strong><code class="code-no-wrap">readAll</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Публичный доступ на чтение позволяет любому пользователю интернета скачивать объекты из бакета.</td><td>value_list=false, true</td></tr>
<tr><td>128</td><td><strong><code class="code-no-wrap">listAll</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Публичный доступ к листингу позволяет любому пользователю интернета получить список объектов в бакете.</td><td>value_list=false, true</td></tr>
<tr><td>129</td><td><strong><code class="code-no-wrap">corsAll</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Публичный доступ к чтению настроек позволяет любому пользователю интернета читать конфигурации CORS</td><td>value_list=false, true</td></tr>
<tr><td>130</td><td><strong><code class="code-no-wrap">placement</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>HOT</code></td><td>Класс хранилища, который используется по умолчанию при загрузке объектов. Чем холоднее, тем дешевле место, но дороже обращения</td><td>value_list=HOT, COLD</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `51` | s3UserUid, bucketName, maxSize, readAll, listAll, corsAll, placement |  |
| `delete` | `instance` | `delete` | `` | `52` |  |  |


## nubes_vc_org
- Service ID: 19
- Description: Организация в Cloud Director
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Организация в Cloud Director через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Организация в Cloud Director** предназначен для управления изолированными организационными единицами (тенантами) внутри инфраструктуры Cloud Director. Он обеспечивает создание, модификацию и администрирование организаций, предоставление им облачных ресурсов, а также контроль уровня доступа. Сервис используется для организации рабочих окружений потребителей, управления жизненным циклом организаций и их сетевой инфраструктурой.<br/><br/>### Доступные операции<br/><br/>**create** — Создание новой организации с заданными характеристиками и типом доступа.<br/>**delete** — Удаление организации после перехода в состояние suspend; приводит к удалению всех связанных сущностей...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>418</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка<br/><br/>**Если список не отображается**<br/>обратитесь к сервис менеджеру с вопросом предоставления ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>556</td><td><strong><code class="code-no-wrap">organizationType</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>iaas</code></td><td>Доступ к организации предоставляется только при выборе `iaas`</td><td>value_list=iaas, saas</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>662</td><td><strong><code class="code-no-wrap">vIPConfigure</code></strong></td><td><code>array-map-fixed</code></td><td>ДА</td><td></td><td></td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `136` | resourceRealm, organizationType | `IaaS`  - Доступ в Keycloak предоставляется пользователю, который создаёт услугу<br/>`SaaS` - Без доступа к Keycloak |
| `delete` | `instance` | `delete` | `` | `137` |  | Удалить возможно только через 14 дней после выполнения операции `suspend`<br/>**ОСТОРЖНО: Удаление приводит к полному удалению всех сущностей внутри этого тенанта**<br/><br/>Если существуют инстансы VDC, Edge, vApp, Vm или Kubernetes-кластер Штурвал, которые были созданы, из ЛК удалены не будут. Необходимо обратиться к `технической поддержке` для удаления инстансов |
| `modify` | `instance` | `modify` | `` | `207` | vIPConfigure | Для возможности изменения параметров предварительно необходимо создать **Виртуальный датацентр (VDC)**, потом **Сетевой шлюз периметра (Edge Gateway)**<br/>Также при удалении ipSpaces убедитесь, что все внешние IP удалены. В случае если хоть одна привязка vIP есть, данный ipSpace удалён **не будет** |
| `reconcile` | `action` | `reconcile` | `` | `249` |  |  |
| `resume` | `instance` | `resume` | `` | `144` |  |  |
| `suspend` | `instance` | `suspend` | `` | `143` |  | Операция **не останавливает ВМки** в облаке, но не даёт редактировать все сущности внутри тенанта |


## nubes_vc_org_saas
- Service ID: 20
- Description: Без интеграции Keycloak
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Верхнеуровневая сущность создаваемая для Заказчика.<br/>Внутри Организация вы можете создать: Виртуальные датацентры, Каталоги.

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>185</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `8` | resourceRealm | Создание организации в Cloud Director<br/>Id в клауд директоре создаётся на основе contragentCode |
| `delete` | `instance` | `delete` | `` | `23` |  |  |
| `resume` | `instance` | `resume` | `` | `119` |  |  |
| `suspend` | `instance` | `suspend` | `` | `118` |  |  |


## nubes_vc_vdc
- Service ID: 21
- Description: Выделение вычислительных ресурсов
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Виртуальный датацентр (vDC) через платформу<br/><br/>## 1. Общая информация<br/><br/>**Виртуальный датацентр (vDC)** — это логическая изолированная среда в VMware Cloud Director, предназначенная для размещения и управления виртуальными машинами, сетевой инфраструктурой и ресурсами хранения. Сервис обеспечивает выделение вычислительных ресурсов под конкретную организацию и предоставляет гибкие параметры масштабирования, контроля потребления и разделения ресурсов.<br/><br/>### Доступные операции<br/><br/>**create** — Создание виртуального датацентра (vDC) с заданными параметрами CPU, RAM, Storage и сетевой конфигурацией.<br/>**delete** — Удаление vDC. Требуется предварительный перевод vDC в состояние *suspend*. Полное удаление возможно через 14 дней.<br/>**modif...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>30</td><td><strong><code class="code-no-wrap">organizationUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>Для создания VDC предварительно необходимо создать организацию через услугу `Организация в Cloud Director`</td><td>ref_svc_id=19</td></tr>
<tr><td>335</td><td><strong><code class="code-no-wrap">providerVdc</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Приписка `2.8` - Скорость vCPU - 2800MHz<br/>И так далее...<br/></td><td></td></tr>
<tr><td>361</td><td><strong><code class="code-no-wrap">storageConfig</code></strong></td><td><code>array-map-fixed</code></td><td>ДА</td><td></td><td>Первая политика в списке указывается как &amp;quot;По умолчанию&amp;quot;</td><td></td></tr>
<tr><td>397</td><td><strong><code class="code-no-wrap">cpuGuaranteed</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>20</code></td><td>Свойство нельзя изменить после создания</td><td>value_list=20, 50, 80</td></tr>
<tr><td>398</td><td><strong><code class="code-no-wrap">memGuaranteed</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>20</code></td><td>После создания нельзя изменить</td><td>value_list=20, 50, 80</td></tr>
<tr><td>557</td><td><strong><code class="code-no-wrap">cpuAllocated</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>10</code></td><td>шт</td><td>minvalue=1; maxvalue=200</td></tr>
<tr><td>558</td><td><strong><code class="code-no-wrap">memAllocated</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>20</code></td><td>gb</td><td>minvalue=1; maxvalue=4096</td></tr>
<tr><td>746</td><td><strong><code class="code-no-wrap">networkProvider</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>560</td><td><strong><code class="code-no-wrap">cpuAllocated</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>шт</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>561</td><td><strong><code class="code-no-wrap">memAllocated</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>gb</td><td>minvalue=1; maxvalue=1024</td></tr>
<tr><td>562</td><td><strong><code class="code-no-wrap">storageConfig</code></strong></td><td><code>array-map-fixed</code></td><td>ДА</td><td></td><td>Первая политика в списке указывается как &amp;quot;По умолчанию&amp;quot;</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `9` | organizationUid, providerVdc, storageConfig, cpuGuaranteed, memGuaranteed, cpuAllocated, memAllocated, networkProvider |  |
| `delete` | `instance` | `delete` | `` | `24` |  | Удалить возможно только через 14 дней после выполнения операции `suspend`<br/>**ОСТОРЖНО: Удаление приводит к полному удалению всех сущностей внутри этого VDC**<br/><br/>Если существуют инстансы Edge, vApp, Vm или Kubernetes-кластер Штурвал, которые были созданы, из ЛК удалены не будут. Необходимо обратиться к `технической поддержке` для удаления инстансов |
| `modify` | `instance` | `modify` | `` | `112` | cpuAllocated, memAllocated, storageConfig |  |
| `reconcile` | `action` | `reconcile` | `` | `250` |  |  |
| `resume` | `instance` | `resume` | `` | `172` |  |  |
| `suspend` | `instance` | `suspend` | `` | `171` |  | Операция **не останавливает ВМки** в облаке, но не даёт редактировать все сущности внутри VDC |


## nubes_vc_nsxt
- Service ID: 22
- Description: Обеспечение сетевой доступности в тенанте
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Сетевой шлюз периметра (Edge) через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Сетевой шлюз периметра (Edge)** предназначен для создания периметрового сетевого шлюза в рамках одного виртуального датацентра (vDC) или группы виртуальных датацентров (groupvDC).  <br/>При создании автоматически разворачивается routed-сеть с адресным пространством `10.10.102.0/24`.  <br/>Сервис обеспечивает сетевую изоляцию, маршрутизацию, а также может включать функциональность балансировщика нагрузки AVI (ALB) для последующей интеграции, включая поддержку кластеров Штурвал.<br/><br/>### Доступные операции<br/><br/>**create** — Создание нового Edge с привязкой к vDC или groupvDC и развёртыванием routed-сети.  <br/>**delete** — Удаление ранее созданного Edge. Недос...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>8</td><td><strong><code class="code-no-wrap">vdcUid</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Необходимо, если выбран тип подключаемой VDC: `vdc`</td><td>ref_svc_id=21</td></tr>
<tr><td>340</td><td><strong><code class="code-no-wrap">needEnableAVI</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Параметры `Наименование segroup`, `Кол-во VS на AVI` необходимо также указать</td><td>value_list=false, true</td></tr>
<tr><td>341</td><td><strong><code class="code-no-wrap">virtualServicesCount</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>1</code></td><td>Во избежании коллапса пока выделяется до 4<br/>Необходимо указывать, если включён параметр `Включить ALB`</td><td>minvalue=1; maxvalue=4</td></tr>
<tr><td>621</td><td><strong><code class="code-no-wrap">vdcType</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>vdc</code></td><td>При выборе vdc обеспечивает сетевую доступность только в рамках этого vdc<br/>При выборе groupvdc обеспечивает сетевую доступность между всеми vdc, которые включены в groupvdc</td><td>value_list=vdc, vdcGroup</td></tr>
<tr><td>622</td><td><strong><code class="code-no-wrap">vdcGroupUid</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Необходимо, если выбран тип подключаемой VDC: `groupvdc`</td><td>ref_svc_id=29</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>368</td><td><strong><code class="code-no-wrap">needEnableAVI</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td></td><td>Параметры `Наименование segroup`, `Кол-во VS на AVI` необходимо также указать</td><td>value_list=false, true</td></tr>
<tr><td>369</td><td><strong><code class="code-no-wrap">virtualServicesCount</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Во избежании коллапса пока выделяется до 4<br/>Необходимо указывать, если включён параметр `Включить ALB`</td><td>minvalue=1; maxvalue=4</td></tr>
<tr><td>371</td><td><strong><code class="code-no-wrap">needExternalAddressSNAT</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td></td><td>Параметр `ip Space для VIP` станет обязательным, если указан `true`</td><td>value_list=false, true</td></tr>
<tr><td>372</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ip Space для внешнего IP<br/><br/>getKeyListFromStruct(getInstanceState(getValueFromStruct(getInstanceState(getValueFromStruct(getInstanceState(), &amp;quot;params.vdcUid&amp;quot;)), &amp;quot;params.organizationUid&amp;quot;)), &amp;quot;params.vIPConfigure&amp;quot;)</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `10` | vdcUid, needEnableAVI, virtualServicesCount, vdcType, vdcGroupUid |  |
| `delete` | `instance` | `delete` | `` | `25` |  | Невозможно удалить если routed-сеть в Edge связана с:<br/>- vApp<br/>- VM<br/>- Kubernetes-кластер Штурвал<br/><br/>Запустить операцию возможно, но будет ошибка |
| `modify` | `instance` | `modify` | `` | `111` | needEnableAVI, virtualServicesCount, needExternalAddressSNAT, ipSpaceName | Для создания SNAT Правила убедитесь, что в организации есть свободные IP<br/>Редактировать кол-во свободных IP можно в услуге `Организация в Cloud Director` -&gt; `modify` |
| `reconcile` | `action` | `reconcile` | `` | `252` |  |  |


## nubes_vc_vm
- Service ID: 23
- Description: Виртуальная машина без каких-либо особенностей. <br/>Данная услуга запускает vc_ip для выдачи белого адреса и подключения к ВМ
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Виртуальная машина без каких-либо особенностей. <br/>Данная услуга запускает vc_ip для выдачи белого адреса и подключения к ВМ

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>33</td><td><strong><code class="code-no-wrap">vappUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>InstanceUid vApp. vApp должен быть создан</td><td>ref_svc_id=26</td></tr>
<tr><td>35</td><td><strong><code class="code-no-wrap">vmName</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>vm0001</code></td><td>Имя ВМ. Не поддерживает спец-символы</td><td>regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$</td></tr>
<tr><td>36</td><td><strong><code class="code-no-wrap">vmCpu</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>2</code></td><td>CPU</td><td></td></tr>
<tr><td>37</td><td><strong><code class="code-no-wrap">vmRam</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>2</code></td><td>RAM (GB)</td><td></td></tr>
<tr><td>38</td><td><strong><code class="code-no-wrap">vmDisksize</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>10</code></td><td>Размер диска под сервис (GB)</td><td></td></tr>
<tr><td>176</td><td><strong><code class="code-no-wrap">templateName</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>RockyLinux_9-16G</code></td><td>ОС</td><td>value_list=RockyLinux_9-16G, OracleLinux_9-16G, Ubuntu_24-20G, Ubuntu_22-20G</td></tr>
<tr><td>177</td><td><strong><code class="code-no-wrap">accessIpList</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>79.111.119.78/32 185.247.187.1/32</code></td><td>Вставить содержимое из &#x27;curl ifconfig.io&#x27;<br/>IP адреса в CIDR формате через пробел для настройки аксес листов</td><td></td></tr>
<tr><td>406</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Брать из свойств ресурсной платформы<br/>.vcd.ipSpace<br/><br/>Имя IP-space для выделения внешнего IP (IP выделяется обязательно)</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>186</td><td><strong><code class="code-no-wrap">vmCpu</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>CPU</td><td></td></tr>
<tr><td>187</td><td><strong><code class="code-no-wrap">vmRam</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>RAM</td><td></td></tr>
<tr><td>188</td><td><strong><code class="code-no-wrap">vmDisksize</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Размер диска под сервис (GB)</td><td></td></tr>
<tr><td>189</td><td><strong><code class="code-no-wrap">accessIpList</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>IP адреса в CIDR формате через пробел для настройки аксес листов</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `26` | vappUid, vmName, vmCpu, vmRam, vmDisksize, templateName, accessIpList, ipSpaceName |  |
| `delete` | `instance` | `delete` | `` | `29` |  |  |
| `modify` | `instance` | `modify` | `` | `68` | vmCpu, vmRam, vmDisksize, accessIpList | Операция автоматически останавливает ВМ. |
| `resume` | `instance` | `resume` | `` | `28` |  |  |
| `suspend` | `instance` | `suspend` | `` | `27` |  |  |


## nubes_vcexternalip
- Service ID: 25
- Description: Резервирование IP адреса
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
**Обычно эта услуга разворачивается автоматически при развёртывании более сложных услуг**<br/>Вручную создавать можно, однако услуга требует много параметров, о которых можно просто не знать<br/><br/>Резервировать публичные IP адреса можно только после создания NGcloud Organization, NGcloud Виртуальный датацентр, NGcloud Каталог, Сетевой шлюз периметра.<br/>Вы можете назначить IP адрес для существующего экземпляра сервиса.

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>140</td><td><strong><code class="code-no-wrap">serviceUid</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>141</td><td><strong><code class="code-no-wrap">dnatCreate</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>true</code></td><td>Необходимо создать DNAT-правило.</td><td></td></tr>
<tr><td>142</td><td><strong><code class="code-no-wrap">internalPortAccess</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>5432</code></td><td>Порт для связки ната с адресом. Несколько значений можно передавать через пробел. Если передать all, то dnat будет на все порты. Требует dnatCreate=true<br/></td><td></td></tr>
<tr><td>143</td><td><strong><code class="code-no-wrap">snatCreate</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td></td><td>Необходимо создать SNAT-правило.<br/></td><td></td></tr>
<tr><td>144</td><td><strong><code class="code-no-wrap">internalAddrAccess</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Внутренний адрес для связки ната. Требует dnatCreate=true или snatCreate=true</td><td></td></tr>
<tr><td>324</td><td><strong><code class="code-no-wrap">fromServiceNamespace</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Namespace составной услуги (для отображения правил FW)</td><td></td></tr>
<tr><td>325</td><td><strong><code class="code-no-wrap">fromServiceCloudEdgeName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Edge составной услуги (указывать, если resourceRealm связан с CloudDirector)</td><td></td></tr>
<tr><td>326</td><td><strong><code class="code-no-wrap">fromServiceCloudVdcName</code></strong></td><td></td><td>НЕТ</td><td></td><td>Vdc составной услуги (указывать, если resourceRealm связан с CloudDirector)</td><td></td></tr>
<tr><td>327</td><td><strong><code class="code-no-wrap">fromServiceCloudOrgName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Org составной услуги (указывать, если resourceRealm связан с CloudDirector)</td><td></td></tr>
<tr><td>328</td><td><strong><code class="code-no-wrap">fromServiceCloudVmwareUrl</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Api-Url составной услуги (указывать, если resourceRealm связан с CloudDirector)</td><td></td></tr>
<tr><td>336</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Тип ip Space (internet-ipv4-v1 / internet-antiddos-v1 / internet-no-antiddos-v1)</td><td></td></tr>
<tr><td>488</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>624</td><td><strong><code class="code-no-wrap">fromServiceCloudEdgeScope</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>626</td><td><strong><code class="code-no-wrap">fromServiceVdcGroupName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>627</td><td><strong><code class="code-no-wrap">serviceUid</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>628</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>629</td><td><strong><code class="code-no-wrap">dnatCreate</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>630</td><td><strong><code class="code-no-wrap">snatCreate</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>631</td><td><strong><code class="code-no-wrap">internalPortAccess</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>632</td><td><strong><code class="code-no-wrap">internalAddrAccess</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `56` | serviceUid, dnatCreate, internalPortAccess, snatCreate, internalAddrAccess, fromServiceNamespace, fromServiceCloudEdgeName, fromServiceCloudVdcName, fromServiceCloudOrgName, fromServiceCloudVmwareUrl, ipSpaceName, resourceRealm, fromServiceCloudEdgeScope, fromServiceVdcGroupName |  |
| `delete` | `instance` | `delete` | `` | `57` |  |  |
| `modify` | `instance` | `modify` | `` | `197` | serviceUid, ipSpaceName, dnatCreate, snatCreate, internalPortAccess, internalAddrAccess |  |


## nubes_vapp
- Service ID: 26
- Description: Группировка виртуальных машин
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Виртуальный каталог ВМ (vApp) через платформу<br/><br/>## 1. Общая информация<br/><br/>**Виртуальный каталог ВМ (vApp)** — это логическая каталог, объединённая в единый управляемый объект. Сервис предназначен для совместного развертывания, управления жизненным циклом и сетевого взаимодействия набора связанных ВМ. Основные функции включают:<br/>- централизованное управление включением, выключением и приостановкой группы ВМ;<br/>- унифицированный сетевой доступ через привязанный Edge-шлюз;<br/><br/>### Доступные операции<br/><br/>**create** — Создание нового vApp с привязкой к заданным услугам VDC и Edge<br/>**delete** — Удаление существующего vApp. Требуется предварительный перевод vApp в состояние *suspend*. Полное удаление возможно через 14 дней.<br/>**suspen...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>190</td><td><strong><code class="code-no-wrap">nsxtUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>К какой сети может быть подключен виртуальный каталог</td><td>ref_svc_id=22</td></tr>
<tr><td>191</td><td><strong><code class="code-no-wrap">vappName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имеет строгую маску `^[a-z0-9][a-z0-9.-]{3,61}[a-z0-9]$`<br/><br/>Используется в формировании DNS-Имени (для виртуальных машин)</td><td>regex=^[a-z0-9][a-z0-9.-]{3,61}[a-z0-9]$; minlength=3</td></tr>
<tr><td>623</td><td><strong><code class="code-no-wrap">vdcUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>В каких ресурсах будет создан виртуальный каталог</td><td>ref_svc_id=21</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `69` | nsxtUid, vappName, vdcUid |  |
| `delete` | `instance` | `delete` | `` | `70` |  |  |
| `resume` | `instance` | `resume` | `` | `209` |  |  |
| `suspend` | `instance` | `suspend` | `` | `208` |  |  |


## nubes_vc_vm_v2
- Service ID: 27
- Description: Виртуальная машина с возможностью настройки Cloud Init<br/>Можно развернуть в услуге несколько ВМ<br/>В зависимости от настроек можно выдавать на ВМ vip + dns
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>301</td><td><strong><code class="code-no-wrap">serverListJson</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>[{}]</code></td><td>Необходимо изменить vappUid и ipSpaceName<br/>Пример конфигурации взять по ссылке ниже<br/><br/>Объект серверов вида [{}] (Map(Object))<br/>Более подробнее смотреть в README.md (https://gitea.mgmt.nubes.ru/cloudServices/vcVmV2)</td><td>maxlength=65536; minlength=10</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>302</td><td><strong><code class="code-no-wrap">serverListJson</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>[{}]</code></td><td>Объект серверов вида [{}] (Map(Object))<br/>Более подробнее смотреть в README.md (https://gitea.mgmt.nubes.ru/cloudServices/vcVmV2)</td><td>maxlength=65536; minlength=10</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `100` | serverListJson |  |
| `delete` | `instance` | `delete` | `` | `101` |  |  |
| `modify` | `instance` | `modify` | `` | `104` | serverListJson |  |
| `resume` | `instance` | `resume` | `` | `102` |  |  |
| `suspend` | `instance` | `suspend` | `` | `103` |  |  |


## nubes_vc_vm_v3
- Service ID: 28
- Description: Создание виртуальной машины
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Документация по разворачиванию ВМ в Личном кабинете<br/><br/>Данный сервис позволяет разворачивать виртуальные машины (ВМ) непосредственно из Личного кабинета (ЛК).<br/><br/>## Доступные операции<br/>- **create** — Создание виртуальной машины<br/>- **delete** — Удаление виртуальной машины<br/>- **resume** — Запуск виртуальной машины<br/>- **suspend** — Остановка виртуальной машины

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>407</td><td><strong><code class="code-no-wrap">vappUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td></td><td>ref_svc_id=26</td></tr>
<tr><td>408</td><td><strong><code class="code-no-wrap">vmName</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td></td><td>regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$</td></tr>
<tr><td>409</td><td><strong><code class="code-no-wrap">vmCpu</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>шт</td><td>minvalue=1; maxvalue=64</td></tr>
<tr><td>410</td><td><strong><code class="code-no-wrap">vmRam</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Gb</td><td>minvalue=1; maxvalue=256</td></tr>
<tr><td>411</td><td><strong><code class="code-no-wrap">vmDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Основной диск у vm зависит от образа (см. документацию)<br/>Если необходимо дополнительное место для vm, введите колличество Gb в эту форму</td><td>regex=^(?:$|(?:0|[1-9]\d{0,2}|1\d{3}|20(?:[0-3]\d|4[0-8])))$</td></tr>
<tr><td>412</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>413</td><td><strong><code class="code-no-wrap">accessIpList</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Формат массива<br/>Каким адресам будет предоставлен доступ до вм<br/><br/>Требует выделенного внешнего IP<br/>Если ничего не передано, то выставлено [&amp;quot;0.0.0.0/0&amp;quot;]</td><td>regex=^(?:$|\[\s*(?:&quot;(?:\d{1,3}\.){3}\d{1,3}(?:\/\d{1,2})?&quot;(?:\s*,\s*&quot;(?:\d{1,3}\.){3}\d{1,3}(?:\/\d{1,2})?&quot;)*)\s*\])$</td></tr>
<tr><td>414</td><td><strong><code class="code-no-wrap">imageVm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>415</td><td><strong><code class="code-no-wrap">cloudInit</code></strong></td><td><code>yaml</code></td><td>НЕТ</td><td></td><td>Можно передать создание дополнительных пользователей. <br/>На текущий момент не реализовано выполнения в cloud-init, установки пакетов, выполнения команд и записи файлов.</td><td></td></tr>
<tr><td>416</td><td><strong><code class="code-no-wrap">userLogin</code></strong></td><td></td><td>ДА</td><td><code>myuser</code></td><td>Учётка SSH</td><td></td></tr>
<tr><td>417</td><td><strong><code class="code-no-wrap">userPublicKey</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Публичная часть SSH-Ключа для пользователя</td><td></td></tr>
<tr><td>448</td><td><strong><code class="code-no-wrap">accessPortList</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>[&quot;22&quot;]</code></td><td>По каким портам открыть доступ к ВМ.<br/>Порты 22, 10050 проставляются автоматически<br/>Пока доступно: <br/>22 - SSH, <br/>80 - HTTP,<br/>443 - HTTPS,<br/>10050 - ZABBIX</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>493</td><td><strong><code class="code-no-wrap">vmCpu</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>шт</td><td>minvalue=1; maxvalue=64</td></tr>
<tr><td>494</td><td><strong><code class="code-no-wrap">vmRam</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Gb</td><td>minvalue=1; maxvalue=256</td></tr>
<tr><td>495</td><td><strong><code class="code-no-wrap">vmDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Основной диск у vm зависит от образа (см. документацию)<br/>Если необходимо дополнительное место для vm, введите колличество Gb в эту форму</td><td>regex=^(?:$|(?:0|[1-9]\d{0,2}|1\d{3}|20(?:[0-3]\d|4[0-8])))$</td></tr>
<tr><td>496</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>no-needed, без внешнего ip<br/>internet-antiddos-v1, с функцией защиты от ddos атак<br/>internet-no-antiddos-v1, с функцией защиты от ddos атак<br/>internet-ipv4-v1 тестовое простанство dev</td><td>value_list=no-needed, internet-antiddos-v1, internet-no-antiddos-v1</td></tr>
<tr><td>497</td><td><strong><code class="code-no-wrap">accessIpList</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Формат массива<br/>Каким адресам будет предоставлен доступ до вм<br/><br/>Требует выделенного внешнего IP<br/>Если ничего не передано, то выставлено [&amp;quot;0.0.0.0/0&amp;quot;]</td><td></td></tr>
<tr><td>498</td><td><strong><code class="code-no-wrap">accessPortList</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Формат массива<br/>По каким портам открыть доступ к ВМ.<br/>Пока доступно:<br/>22 - SSH,<br/>80 - HTTP,<br/>443 - HTTPS</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `132` | vappUid, vmName, vmCpu, vmRam, vmDisk, ipSpaceName, accessIpList, imageVm, cloudInit, userLogin, userPublicKey, accessPortList | # Документация по использованию услуги развёртывания ВМ в Личном кабинете<br/><br/>Данный сервис позволяет разворачивать виртуальные машины (ВМ) непосредственно из Личного кабинета (ЛК).<br/><br/>## Доступные операции<br/>- **create** — Создание виртуальной машины<br/>- **delete** — Удаление виртуальной машины<br/>- **resume** — Запуск виртуальной машины<br/>- **suspend** — Остановка виртуальной машины<br/><br/>---<br/><br/>## Параметры для развёртывания ВМ<br/><br/>### Обязательные параметры:<br/><br/>**vappUid**<br/>UUID vApp, в которой будет создаваться виртуальная машина.<br/>*Пример: WZ00400*<br/><br/>**vmName**<br/>Уникальное имя виртуальной машины.<br/>*Пример: test-vm*<br/><br/>**vmCpu**<br/>Количество ядер процессора. Должно быть больше 0.<br/>*Пример: 1*<br/><br/>**vmRam**<br/>Объем оперативной памяти в гигабайтах. Должно быть больше 0.<br/>*Пример: 1*<br/><br/><br/>**accessPortList**<br/>Белый список портов для доступа к виртуальной машине извне в формате JSON.<br/>*Пример: [&quot;22&quot;,&quot;10050]*<br/><br/>**imageVm**<br/>Образ операционной системы для развёртывания.<br/>*Доступные значения: RockyLinux_9-16G-cloudinit, Ubuntu_22-20G, Debian_13-20G*<br/><br/>**userLogin**<br/>Логин пользователя для SSH-доступа.<br/>*По умолчанию: myuser*<br/><br/>**userPublicKey**<br/>Публичный SSH-ключ пользователя в формате OpenSSH.<br/>*Пример: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...*<br/><br/>**needAddZabbixTemplate**<br/>Значение истина\лож определяющее будет ли добавлен хост в zabbix.<br/>*Пример: true*<br/><br/>### Опциональные параметры:<br/><br/>**accessIpList**<br/>Белый список IP-адресов для доступа к виртуальной машине в формате JSON. Если оставить пустым, вм будет доступена со всех адресов.<br/>*Пример: [&quot;192.168.1.1&quot;, &quot;10.0.0.5&quot;]*<br/><br/>**vmDisk**<br/>Размер дополнительного диска в гигабайтах. Должно быть больше 0.<br/>*Пример: 50*<br/><br/>**ipSpaceName**<br/>Внешний IP-адрес. Если не требуется — укажите значение &quot;no-needed&quot;.<br/><br/>**cloudInit**<br/>YAML-скрипт для кастомизации системы через cloud-init.<br/><br/>---<br/><br/>## Доступные образы операционных систем<br/><br/>### RockyLinux_9-16G-cloudinit<br/>Базовый образ на основе Rocky Linux 9 (Rocky-9.6-x86_64-minimal) для серверных задач.<br/>- Размер системного диска: 16 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>### Ubuntu_22-20G<br/>Образ на основе Ubuntu Server 22.04 LTS для облачного окружения.<br/>- Размер системного диска: 20 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>### Debian_13-20G<br/>Образ на основе Debian 13 (Trixie) для стабильной серверной работы.<br/>- Размер системного диска: 20 ГБ<br/>- Поддержка cloud-init<br/>- Минимальные требования: 1 vCPU, 1 ГБ RAM<br/><br/>---<br/><br/>## Пример использования Cloud-init<br/><br/>```yaml<br/>users:<br/>  - name: myuser<br/>    sudo: ALL=(ALL) NOPASSWD:ALL<br/>    groups: sudo<br/>    shell: /bin/bash<br/>    ssh-authorized-keys:<br/>      - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...<br/><br/>packages:<br/>  - nginx<br/><br/>runcmd:<br/>  - systemctl enable --now nginx<br/>  - systemctl restart nginx<br/>```<br/><br/>---<br/><br/>## Результат выполнения<br/><br/>После успешного развёртывания в Личном кабинете появится новая виртуальная машина с заданными характеристиками. SSH-доступ осуществляется с использованием указанных логина и публичного ключа.<br/><br/>---<br/><br/>## Важные примечания<br/><br/>### Особенности работы:<br/>- Для отключения внешнего IP укажите значение &quot;no-needed&quot; в параметре ipSpaceName<br/>- Параметр cloudInit является опциональным<br/><br/>### Ограничения:<br/>- Не рекомендуется использовать продолжительные инструкции в cloud-init (таймаут 5 минут)<br/>- Не поддерживается запись файлов через cloud-init<br/>- Не реализовано создание резервных копий ВМ<br/><br/>---<br/><br/>## Диагностика проблем с cloud-init<br/><br/>### Основной лог-файл:<br/>```bash<br/>/var/log/cloud-init.log<br/>```<br/><br/>### Пакет не устанавливается:<br/>- Проверьте доступность пакета в репозитории<br/>- Убедитесь в правильности написания имени пакета<br/>- Попробуйте установить вручную: `apt install &lt;имя_пакета&gt;` (Debian/Ubuntu) или `dnf install &lt;имя_пакета&gt;` (Rocky Linux)<br/><br/>### Команда не выполняется:<br/>- Проверьте наличие требуемой утилиты в системе<br/>- Убедитесь в правильности синтаксиса команды<br/>- Попробуйте выполнить команду вручную для диагностики |
| `delete` | `instance` | `delete` | `` | `133` |  |  |
| `modify` | `instance` | `modify` | `` | `159` | vmCpu, vmRam, vmDisk, ipSpaceName, accessIpList, accessPortList |  |
| `redeploy` | `action` | `redeploy` | `` | `164` | vmName, vmCpu, vmRam, vmDisk, ipSpaceName, accessIpList, imageVm, userLogin, userPublicKey, cloudInit, accessPortList |  |
| `resume` | `instance` | `resume` | `` | `135` |  |  |
| `suspend` | `instance` | `suspend` | `` | `134` |  |  |


## nubes_vc_vdc_group
- Service ID: 29
- Description: Обеспечение сетевой доступности между датацентрами
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Группа виртуальных датацентров (groupvDC) через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Группа виртуальных датацентров (groupvDC)** предназначен для логического объединения нескольких виртуальных датацентров (vDC) в единую группу. Это позволяет растягивать SDN между разными vDC и централизованно управлять сетевой связностью. Управление инфраструктурой осуществляется через Cloud Director.<br/>Сервис применяется в случаях, когда требуется обеспечить единое сетевое пространство для распределенных виртуальных датацентров.<br/><br/>### Доступные операции<br/><br/>**create** — Создание новой группы виртуальных датацентров.<br/>**delete** — Удаление существующей группы vDC.<br/>**add_vdc** — Добавление дополнительного виртуального датацентра в гру...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>618</td><td><strong><code class="code-no-wrap">vdcUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td></td><td>ref_svc_id=21</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `add_vdc` | `action` | `add_vdc` | `` | `192` | vdcUid | **Не нужно** выбирать UUID VDC, который уже был добавлен в группу |
| `create` | `instance` | `create` | `` | `191` | vdcUid | **VDC Группа** нужна для объединения всех VDC в организации в одну логическую группу.<br/>Это позволит, к примеру, создать **общую сеть** для всех VDC в организации<br/><br/>- Для создания группы VDC необходимо указать **инстанс** услуги VDC (`Виртуальный датацентр`)<br/>- **Важный момент** - удалить эту VDC из группы нельзя. Если такая потребность появится, необходимо будет **ПОЛНОСТЬЮ** удалить группу VDC и уже потом создать новую |
| `delete` | `instance` | `delete` | `` | `195` |  |  |
| `reconcile` | `action` | `reconcile` | `` | `251` |  |  |
| `remove_vdc` | `action` | `remove_vdc` | `` | `193` | vdcName |  |


## nubes_vmpostgre
- Service ID: 32
- Description: Сервис настройки PostgreSQL для виртуальной машины.<br/>Требует наличия ВМ
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Сервис настройки PostgreSQL для виртуальной машины.<br/>Требует наличия ВМ

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>43</td><td><strong><code class="code-no-wrap">vdcUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>InstanceUid vdc. Vdc должен быть создан<br/></td><td>ref_svc_id=21</td></tr>
<tr><td>44</td><td><strong><code class="code-no-wrap">nsxtUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>InstanceUid nsxt. Nsxt должен быть создан<br/></td><td>ref_svc_id=22</td></tr>
<tr><td>45</td><td><strong><code class="code-no-wrap">vmUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>InstanceUid ВМ. ВМ должна быть создана<br/></td><td>ref_svc_id=23</td></tr>
<tr><td>46</td><td><strong><code class="code-no-wrap">userDb</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>servicedb</code></td><td>Наименование Базы данных<br/></td><td></td></tr>
<tr><td>47</td><td><strong><code class="code-no-wrap">userLogin</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>serviceuser</code></td><td>Пользователь базы данных<br/></td><td></td></tr>
<tr><td>48</td><td><strong><code class="code-no-wrap">userPassword</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>fj29gm48fm!d374mc9</code></td><td>Пароль от доступа к Базе данных<br/></td><td></td></tr>
<tr><td>859</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Ресурсная платформа</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `32` | vdcUid, nsxtUid, vmUid, userDb, userLogin, userPassword, resourceRealm |  |
| `delete` | `instance` | `delete` | `` | `33` |  |  |


## nubes_nextcloud
- Service ID: 50
- Description: Платформа совместной работы
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Ресурсная платформа: k8s. Автоматизация: helm chart

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>21</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Наименование домена. Если будет указан FQDN, то происходят проверки DNS. Если указан поддомен, то будет добавлен в зону services.ngcloud.ru<br/>Можно указать клиентскую DNS-Запись. Важно, чтобы запись смотрела на Ingress кластера</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>99</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1000</code></td><td>Квота ядра пода (Указывается в mili). 1 ядро = 1000 Mili</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>100</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1024</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=1024; maxvalue=8192</td></tr>
<tr><td>101</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>2</code></td><td>Квота диска (Указывается в GIGAbytes)<br/>Диск не может быть меньше 2G (!)</td><td>minvalue=2; maxvalue=999</td></tr>
<tr><td>192</td><td><strong><code class="code-no-wrap">documentServer</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>collabora</code></td><td>Выбор сервера документов (onlyoffice)/(collabora). onlyoffice пока не доступен<br/>Размер пода collabora:<br/>1.8 ядра. 2Gi ОЗУ</td><td>value_list=collabora</td></tr>
<tr><td>470</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов<br/>Не может пока быть больше одного, так как нужны SC под RWMany</td><td>minvalue=1; maxvalue=7; value_list=1</td></tr>
<tr><td>564</td><td><strong><code class="code-no-wrap">psqlUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td></td><td>ref_svc_id=90</td></tr>
<tr><td>569</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td></td><td>ДА</td><td><code>32.0.1</code></td><td></td><td>value_list=32.0.1</td></tr>
<tr><td>570</td><td><strong><code class="code-no-wrap">redisUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td></td><td>ref_svc_id=91</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>178</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота ядра пода (Указывается в mili)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>179</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>180</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>547</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Количество узлов.<br/>Не может пока быть больше одного, так как нужны SC под RWMany</td><td>minvalue=1; maxvalue=7; value_list=1</td></tr>
<tr><td>571</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Нельзя обновляться сразу через несколько версий сразу</td><td>value_list=32.0.1</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `16` | domain, resourceCPU, resourceMemory, resourceDisk, documentServer, resourceInstances, psqlUid, appVersion, redisUid | DEV-Ветка сборки Nextcloud |
| `delete` | `instance` | `delete` | `` | `17` |  | DEV-Ветка удаления Nextcloud |
| `modify` | `instance` | `modify` | `` | `67` | resourceCPU, resourceMemory, resourceDisk, resourceInstances, appVersion |  |
| `restart` | `action` | `restart` | `` | `66` |  |  |
| `resume` | `instance` | `resume` | `` | `129` |  |  |
| `suspend` | `instance` | `suspend` | `` | `128` |  |  |


## nubes_superset
- Service ID: 81
- Description: Сервер отчетов
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Apache Superset как сервис. <br/>Ресурсная платформа: k8s. <br/>Автоматизация: k8s operator.<br/>Авторизация: 2FA keycloak (для доменного логина @mgmt.nubes.ru)

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>14</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>20</td><td><strong><code class="code-no-wrap">emails</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>testuser1</code></td><td>Учётная запись, которой будут выданы админские права. В формате email [ну не совсем. Для доменных учетных записей - без доменного суффикса]. Обязана находиться в Keycloak. Можно передавать несколько через пробел</td><td></td></tr>
<tr><td>96</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Квота ядра пода (Указывается в mili). 1000 Mili = 1 ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>97</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>98</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>109</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>227</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `12` | domain, emails, resourceCPU, resourceMemory, resourceDisk, resourceRealm, resourceInstances | DEV-Ветка сборки Superset |
| `delete` | `instance` | `delete` | `` | `13` |  | DEV-Ветка удаления Superset |


## nubes_harbor
- Service ID: 82
- Description: Реестр для хранения образов контейнеров
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Расширенный реестр для управления Docker-образами с enterprise-функциями безопасности, репликации и контроля доступа.<br/>Container Registry позволяет хранить, развертывать и управлять Docker-образами контейнеров в инфраструктуре NGcloud.<br/>Сервис можно использовать в процессе разработки контейнеров. Например, вы можете настроить систему автоматизации на работу с реестром в Container Registry в рамках процесса непрерывной интеграции. Контейнеры идеально подходят для запуска небольших, независимых и легко изменяемых сервисов.<br/>Чтобы начать работу, создайте реестр и загрузите в него Docker-образ<br/>Авторизация: keycloak

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>16</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>17</td><td><strong><code class="code-no-wrap">emails</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>testuser1</code></td><td>Учётная запись, которой будут выданы админские права. Обязана находиться в Keycloak. Можно передавать несколько через пробел</td><td></td></tr>
<tr><td>110</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>228</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>100</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>229</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>200</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>230</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>231</td><td><strong><code class="code-no-wrap">s3Uid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>UUID экземпляра услуги S3</td><td>ref_svc_id=12</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `14` | domain, emails, resourceRealm, resourceCPU, resourceMemory, resourceInstances, s3Uid | DEV-Ветка сборки Harbor |
| `delete` | `instance` | `delete` | `` | `15` |  | DEV-Ветка удаления Harbor |


## nubes_k8s_ziti_controller
- Service ID: 88
- Description: Контроллер управления Client to service & service to service Zero trust network<br/>
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>294</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>300</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>295</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>296</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>297</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>298</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>299</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `99` | resourceCPU, resourceMemory, resourceDisk, resourceInstances, resourceRealm, domain |  |
| `delete` | `instance` | `delete` | `` | `105` |  |  |


## nubes_flask
- Service ID: 89
- Description: Flask
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>248</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>249</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>250</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>300</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>251</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>256</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>252</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>253</td><td><strong><code class="code-no-wrap">gitPath</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>https://github.com/Foxyhhd/Baldurs-Gate-test.git</code></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>254</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>string</code></td><td>НЕТ</td><td><code>{ &amp;quot;param&amp;quot;: &amp;quot;value&amp;quot; }</code></td><td>Массив переменных, будут переданы в env приложения</td><td></td></tr>
<tr><td>255</td><td><strong><code class="code-no-wrap">healthPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>451</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>452</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>453</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>454</td><td><strong><code class="code-no-wrap">gitPath</code></strong></td><td></td><td>ДА</td><td></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>455</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>{ &quot;param&quot;: &quot;value&quot; }</code></td><td>Массив переменных, будут переданы в env приложения</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `88` | domain, resourceRealm, resourceCPU, resourceMemory, resourceInstances, gitPath, jsonEnv, healthPath |  |
| `delete` | `instance` | `delete` | `` | `89` |  |  |
| `modify` | `instance` | `modify` | `` | `146` | resourceCPU, resourceMemory, resourceInstances, gitPath, jsonEnv |  |
| `resume` | `instance` | `resume` | `` | `145` |  |  |
| `suspend` | `instance` | `suspend` | `` | `125` |  |  |


## nubes_postgres
- Service ID: 90
- Description: Управляемая база данных PostgreSQL
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию PostgreSQL через платформу

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>23</td><td><strong><code class="code-no-wrap">s3Uid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно</td><td>ref_svc_id=12</td></tr>
<tr><td>80</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в кластере. 1,3,5,7</td><td>minvalue=1; maxvalue=7; regex=^[1357]$</td></tr>
<tr><td>81</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>82</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>83</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td></td><td>ДА</td><td><code>10</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>102</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Кластер Kubernetes, на котором будет развернут экземпляр</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>145</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>146</td><td><strong><code class="code-no-wrap">needExternalAddressSlave</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к slave. Будет работать, если slave в принципе есть</td><td>value_list=false, true</td></tr>
<tr><td>265</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>НЕТ</td><td><code>0 0 * * *</code></td><td>Не обязательный. Время запуска бекапа</td><td>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))+)$</td></tr>
<tr><td>266</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>7</code></td><td>Не обязательный. Количество сохраняемых бекапов</td><td>minvalue=1; maxvalue=99</td></tr>
<tr><td>310</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>17</code></td><td>Версия PostgreSQL</td><td>value_list=17, 16, 15, 14, 13</td></tr>
<tr><td>311</td><td><strong><code class="code-no-wrap">jsonParameters</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>{ &quot;log_connections&quot;: &quot;off&quot;, &quot;log_disconnections&quot;: &quot;off&quot; }</code></td><td>Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html</td><td>maxlength=2048</td></tr>
<tr><td>312</td><td><strong><code class="code-no-wrap">enablePgPoolerMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает pgPooler (на запись). Будет создан новый под</td><td>value_list=false, true</td></tr>
<tr><td>313</td><td><strong><code class="code-no-wrap">enablePgPoolerSlave</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает pgPooler (на чтение). Будет создан новый под</td><td>value_list=false, true</td></tr>
<tr><td>314</td><td><strong><code class="code-no-wrap">allowNoSSL</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр</td><td>value_list=false, true</td></tr>
<tr><td>329</td><td><strong><code class="code-no-wrap">autoScale</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги</td><td>value_list=false, true</td></tr>
<tr><td>330</td><td><strong><code class="code-no-wrap">autoScalePercentage</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>10</code></td><td>Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема</td><td>value_list=10, 15, 20</td></tr>
<tr><td>331</td><td><strong><code class="code-no-wrap">autoScaleTechWindow</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>0</code></td><td>Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)</td><td>value_list=0, 5, 12, 23</td></tr>
<tr><td>337</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
<tr><td>338</td><td><strong><code class="code-no-wrap">ipSpaceNameSlave</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave</td><td></td></tr>
<tr><td>339</td><td><strong><code class="code-no-wrap">autoScaleQuotaGb</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>1</code></td><td>Квота для autoScale</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>91</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>92</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>93</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>94</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>147</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td>Выделяет внешний IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>148</td><td><strong><code class="code-no-wrap">needExternalAddressSlave</code></strong></td><td><code>boolean</code></td><td>ДА</td><td></td><td>Выделяет внешний IP для доступа к slave. Действует, если slave в принципе есть</td><td>value_list=false, true</td></tr>
<tr><td>267</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Не обязательный. Время запуска бекапа</td><td>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))+)$</td></tr>
<tr><td>268</td><td><strong><code class="code-no-wrap">ext_BACKUP_NUM_TO_RETAIN</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Не обязательный. Количество сохраняемых бекапов</td><td>minvalue=1; maxvalue=99</td></tr>
<tr><td>315</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Версия PostgreSQL. Нельзя опускать вниз</td><td>value_list=17, 16, 15, 14, 13</td></tr>
<tr><td>316</td><td><strong><code class="code-no-wrap">jsonParameters</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html</td><td>maxlength=2048</td></tr>
<tr><td>317</td><td><strong><code class="code-no-wrap">enablePgPoolerMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает pgPooler (на запись). Будет создан новый под</td><td>value_list=false, true</td></tr>
<tr><td>318</td><td><strong><code class="code-no-wrap">enablePgPoolerSlave</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает pgPooler (на чтение). Будет создан новый под</td><td>value_list=false, true</td></tr>
<tr><td>319</td><td><strong><code class="code-no-wrap">allowNoSSL</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр</td><td>value_list=false, true</td></tr>
<tr><td>541</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
<tr><td>542</td><td><strong><code class="code-no-wrap">ipSpaceNameSlave</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `19` | s3Uid, resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm, needExternalAddressMaster, needExternalAddressSlave, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN, appVersion, jsonParameters, enablePgPoolerMaster, enablePgPoolerSlave, allowNoSSL, autoScale, autoScalePercentage, autoScaleTechWindow, ipSpaceNameMaster, ipSpaceNameSlave, autoScaleQuotaGb | руководство |
| `delete` | `instance` | `delete` | `` | `20` | deleteS3Bucket |  |
| `modify` | `instance` | `modify` | `` | `48` | resourceInstances, resourceMemory, resourceCPU, resourceDisk, needExternalAddressMaster, needExternalAddressSlave, ext_BACKUP_SCHEDULE, ext_BACKUP_NUM_TO_RETAIN, appVersion, jsonParameters, enablePgPoolerMaster, enablePgPoolerSlave, allowNoSSL, ipSpaceNameMaster, ipSpaceNameSlave |  |
| `recovery` | `action` | `recovery` | `` | `47` | resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm |  |
| `restart` | `action` | `restart` | `` | `54` |  | ВНИМАНИЕ - Рестарт предполагает УДАЛЕНИЕ подов.<br/>Может быть полная поломка. Крайне осторожно запускать при работе |
| `resume` | `instance` | `resume` | `` | `114` |  |  |
| `suspend` | `instance` | `suspend` | `` | `115` |  |  |


## nubes_redis
- Service ID: 91
- Description: Управляемая база данных Redis
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Redis кластер. Под кеши. <br/>Ресурсная платформа: k8s. <br/>Автоматизация: k8s operator<br/>port 6379

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>112</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1000</code></td><td>Квота ядра пода (Указывается в mili)</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>113</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1024</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=512; maxvalue=8192</td></tr>
<tr><td>114</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>30</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=10; maxvalue=999</td></tr>
<tr><td>181</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в сети. Если выделить больше 1 ноды, будет добавлено дополнительно 3 Sentinel ноды</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>182</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения<br/></td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>183</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Выделяет внешний IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>184</td><td><strong><code class="code-no-wrap">needExternalAddressSlave</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Выделяет внешний IP для доступа к slave. Будет работать если slave в целом есть</td><td>value_list=false, true</td></tr>
<tr><td>548</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster</td><td></td></tr>
<tr><td>549</td><td><strong><code class="code-no-wrap">ipSpaceNameSlave</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave</td><td></td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `21` | resourceCPU, resourceMemory, resourceDisk, resourceInstances, resourceRealm, needExternalAddressMaster, needExternalAddressSlave, ipSpaceNameMaster, ipSpaceNameSlave |  |
| `delete` | `instance` | `delete` | `` | `22` |  |  |


## nubes_mongodb
- Service ID: 92
- Description: Управляемая база данных MongoDB
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию MongoDB через платформу<br/><br/>## 1. Общая информация<br/><br/>MongoDB — документоориентированная распределённая база данных, обеспечивающая высокую доступность, горизонтальное масштабирование и гибкую модель хранения.<br/><br/>### Доступные операции с кластером<br/><br/>* **create** — создание кластера<br/>* **delete** — удаление кластера<br/>* **suspend** — остановка кластера<br/>* **resume** — запуск кластера<br/><br/>### Доступные операции с пользователями<br/><br/>* **create_user** — создание пользователя<br/>* **modify_user** — модификация пользователя<br/>* **delete_user** — удаление пользователя

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>487</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2`</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>588</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2048`</td><td>minvalue=1000</td></tr>
<tr><td>589</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `1000`</td><td></td></tr>
<tr><td>590</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `20`</td><td></td></tr>
<tr><td>595</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>645</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>false</code></td><td>Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`</td><td>value_list=false, true</td></tr>
<tr><td>646</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `37` | resourceInstances, resourceMemory, resourceCPU, resourceDisk, resourceRealm, needExternalAddressMaster, ipSpaceNameMaster |  |
| `create_user` | `subresource` | `create` | `user` | `198` | username, dbName, role |  |
| `delete` | `instance` | `delete` | `` | `190` |  |  |
| `delete_user` | `subresource` | `delete` | `user` | `199` | username |  |
| `modify_user` | `subresource` | `modify` | `user` | `200` | username, dbName, role |  |
| `resume` | `instance` | `resume` | `` | `196` |  |  |
| `suspend` | `instance` | `suspend` | `` | `194` |  |  |


## nubes_rabbitmq
- Service ID: 93
- Description: Сервер очередей
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию RabbitMQ через платформу

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>116</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1000</code></td><td>Пример: `2000`</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>117</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1124</code></td><td>Пример: `2048`</td><td>minvalue=512; maxvalue=8192</td></tr>
<tr><td>118</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>30</code></td><td>Пример: `20`</td><td>minvalue=5; maxvalue=999</td></tr>
<tr><td>119</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>224</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Пример: `1`</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>225</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Флаг, определяющий, нужно ли выделять внешний IP для доступа к master. Пример: `true` или `false`</td><td>value_list=false, true</td></tr>
<tr><td>543</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Пример: `internet-no-antiddos-v1`</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>304</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2000`</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>305</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2048`</td><td>minvalue=512; maxvalue=8192</td></tr>
<tr><td>306</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `20`</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>307</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `1`</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>308</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>309</td><td><strong><code class="code-no-wrap">needExternalAddressSlave</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к slave</td><td>value_list=false, true</td></tr>
<tr><td>545</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Пример: `internet-no-antiddos-v1`</td><td></td></tr>
<tr><td>546</td><td><strong><code class="code-no-wrap">ipSpaceNameSlave</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Пример: `internet-no-antiddos-v1`</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `38` | resourceCPU, resourceMemory, resourceDisk, resourceRealm, resourceInstances, needExternalAddressMaster, ipSpaceNameMaster |  |
| `delete` | `instance` | `delete` | `` | `39` |  |  |
| `modify` | `instance` | `modify` | `` | `106` | resourceCPU, resourceMemory, resourceDisk, resourceInstances, needExternalAddressMaster, needExternalAddressSlave, ipSpaceNameMaster, ipSpaceNameSlave |  |
| `resume` | `instance` | `resume` | `` | `117` |  |  |
| `suspend` | `instance` | `suspend` | `` | `116` |  | Пока не работает из за того что RabbitmqCluster нельзя занулить |


## nubes_lucee
- Service ID: 94
- Description: Cервер приложений
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>103</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>104</td><td><strong><code class="code-no-wrap">gitPath</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>https://github.com/xahys/testlucee</code></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>105</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>json</code></td><td>НЕТ</td><td><code>{ &quot;param&quot;: &quot;value&quot; }</code></td><td>Здесь вы можете задать переменные среды в формате KEY=VALUE. Они будут доступны внутри вашего приложения.</td><td>maxlength=2048</td></tr>
<tr><td>106</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>300</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>107</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>108</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>132</td><td><strong><code class="code-no-wrap">healthPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код</td><td></td></tr>
<tr><td>139</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>263</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>5.4</code></td><td>Версия Lucee</td><td>regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>133</td><td><strong><code class="code-no-wrap">gitPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>134</td><td><strong><code class="code-no-wrap">healthPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код.</td><td></td></tr>
<tr><td>135</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Массив переменных, будут переданы в env приложения</td><td>maxlength=2048</td></tr>
<tr><td>136</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>137</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>138</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>264</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>5.4</code></td><td></td><td>regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `49` | domain, gitPath, jsonEnv, resourceCPU, resourceMemory, resourceRealm, healthPath, resourceInstances, appVersion |  |
| `delete` | `instance` | `delete` | `` | `50` |  |  |
| `modify` | `instance` | `modify` | `` | `55` | gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, appVersion | Если CFS оставить пустым, то при запуске джобы берётся параметр из instanceData |
| `redeploy` | `action` | `redeploy` | `` | `53` | resourceRealm |  |
| `restart` | `action` | `restart` | `` | `163` |  |  |
| `resume` | `instance` | `resume` | `` | `95` |  |  |
| `suspend` | `instance` | `suspend` | `` | `96` |  |  |


## nubes_nodejs
- Service ID: 95
- Description: Cервер приложений
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Развертывает контейнер в k8s кластере с node:16, который можно использовать для запуска своих приложений.<br/>Приложение должно быть доступно по ссылки в git репозитории, которая является входным параметром.

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>149</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>150</td><td><strong><code class="code-no-wrap">gitPath</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>https://github.com/xahys/testnode.git</code></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>151</td><td><strong><code class="code-no-wrap">healthPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. Если оставить пустым, healtcheck&#x27;а не будет</td><td></td></tr>
<tr><td>152</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Массив переменных, будут переданы в env приложения</td><td></td></tr>
<tr><td>153</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Квота ядра пода (milicores). 1000Mili = 1 Ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>154</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1024</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>155</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>156</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>270</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>23</code></td><td>Версия приложения</td><td>regex=^(\d){2}$; value_list=18, 20, 22, 23</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>157</td><td><strong><code class="code-no-wrap">gitPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до Git, который будет webroot для сайта</td><td></td></tr>
<tr><td>158</td><td><strong><code class="code-no-wrap">healthPath</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код.</td><td></td></tr>
<tr><td>159</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Массив переменных, будут переданы в env приложения</td><td>maxlength=2048</td></tr>
<tr><td>160</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>161</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>162</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>271</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>23</code></td><td>Версия приложения</td><td>regex=^(\d){2}$; value_list=18, 20, 22, 23</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `58` | domain, gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, resourceRealm, appVersion |  |
| `delete` | `instance` | `delete` | `` | `61` |  |  |
| `modify` | `instance` | `modify` | `` | `59` | gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, appVersion |  |
| `redeploy` | `action` | `redeploy` | `` | `60` | resourceRealm |  |
| `resume` | `instance` | `resume` | `` | `121` |  |  |
| `suspend` | `instance` | `suspend` | `` | `120` |  |  |


## nubes_pgadmin
- Service ID: 96
- Description: Административный интерфейс для PostgreSQL
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Инструмент с графическим интерфейсом для управления базами данных PostgreSQL

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>164</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>165</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>200</code></td><td>Квота ядра пода (milicores). 1000Mili = 1 Ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>166</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>256</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>167</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>169</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>170</td><td><strong><code class="code-no-wrap">login</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Логин для подключения к pgAdmin, в формате email (login@email.net)</td><td>regex=^([a-zA-Z0-9._-]+@[a-zA-Z0-9._-]+\.[a-zA-Z0-9_-]+)$; maxlength=255; minlength=3</td></tr>
<tr><td>171</td><td><strong><code class="code-no-wrap">password</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Пароль для подключения к pgAdmin</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>172</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>173</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>174</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `62` | domain, resourceCPU, resourceMemory, resourceDisk, resourceRealm, login, password |  |
| `delete` | `instance` | `delete` | `` | `63` |  |  |
| `modify` | `instance` | `modify` | `` | `64` | resourceCPU, resourceMemory, resourceDisk |  |
| `redeploy` | `action` | `redeploy` | `` | `65` | resourceRealm |  |
| `resume` | `instance` | `resume` | `` | `123` |  |  |
| `suspend` | `instance` | `suspend` | `` | `122` |  |  |


## nubes_nodered
- Service ID: 97
- Description: Low-code платформа для IoT
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>193</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>194</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>195</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>196</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>197</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование поддомена, будет добавлено в k8stemplate.dev.nubes.ru</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>323</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `72` | resourceCPU, resourceMemory, resourceDisk, resourceRealm, domain, resourceInstances |  |
| `delete` | `instance` | `delete` | `` | `73` |  |  |


## nubes_http
- Service ID: 98
- Description: Простой HTTP контейнер
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>212</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>213</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>100</code></td><td>Квота ядра пода (Указывается в mili)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>214</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>200</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>215</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество реплик приложения. Трафик будет распределяться между подами в режиме Round-Robin</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>216</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование кластера Kubernetes для подключения</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>217</td><td><strong><code class="code-no-wrap">registryPath</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>nexus-sa.tst.nubes.ru/docker-nubes/jolt</code></td><td>Путь до image, который будет установлен как deployment</td><td></td></tr>
<tr><td>241</td><td><strong><code class="code-no-wrap">jsonEnv</code></strong></td><td><code>json</code></td><td>НЕТ</td><td><code>{&amp;quot;param&amp;quot;: &amp;quot;value&amp;quot;}</code></td><td>Массив переменных, будут переданы в env приложения</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>218</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td></td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>219</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td></td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>220</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `77` | domain, resourceCPU, resourceMemory, resourceInstances, resourceRealm, registryPath, jsonEnv |  |
| `delete` | `instance` | `delete` | `` | `78` |  |  |
| `modify` | `instance` | `modify` | `` | `81` | resourceCPU, resourceMemory, resourceInstances |  |
| `redeploy` | `action` | `redeploy` | `` | `79` | resourceRealm |  |
| `resume` | `instance` | `resume` | `` | `130` |  |  |
| `suspend` | `instance` | `suspend` | `` | `131` |  |  |


## nubes_gitea
- Service ID: 99
- Description: Сервис контроля версий
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Развертывает сервис контроля версий Gitea<br/>Зависит от сервиса postgresql который должен быть развернут заранее.

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>232</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=300; maxvalue=4000</td></tr>
<tr><td>233</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=256; maxvalue=8192</td></tr>
<tr><td>234</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>235</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>237</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>web01</code></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>238</td><td><strong><code class="code-no-wrap">psqlUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>UUID Услуги k8sPgsql. Пользователя techGitea, базу данных gitea создаёт автоматически</td><td>ref_svc_id=90</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>259</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>100</code></td><td>Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>260</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>128</code></td><td>Квота памяти пода (Указывается в Megabytes)</td><td>minvalue=256; maxvalue=8192</td></tr>
<tr><td>261</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>262</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `82` | resourceCPU, resourceMemory, resourceDisk, resourceInstances, domain, psqlUid |  |
| `delete` | `instance` | `delete` | `` | `83` |  |  |
| `modify` | `instance` | `modify` | `` | `91` | resourceCPU, resourceMemory, resourceDisk, resourceInstances |  |
| `resume` | `instance` | `resume` | `` | `127` |  |  |
| `suspend` | `instance` | `suspend` | `` | `126` |  |  |


## nubes_openwhisk
- Service ID: 100
- Description: Добавление и удаления пользователя (учетной записи, тенанта) для работы с Openwhisk
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Добавление и удаления пользователя для работы с Openwhisk

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>64</td><td><strong><code class="code-no-wrap">username</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя пользователя Openwhisk</td><td></td></tr>
<tr><td>863</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Ресурсная платформа</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `41` | username, resourceRealm |  |
| `delete` | `instance` | `delete` | `` | `42` | username |  |


## nubes_dnszone
- Service ID: 110
- Description: Хостинг DNS зоны
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
## ![image](https://img.icons8.com/?size=50&id=41400&format=png) Необходимо делегировать зону у регистратора на Авторитетные DNS (Сервера зон)<br/><br/>ns3.ngcloud.ru<br/>``` bash<br/>185.247.187.83<br/>2a10:aa80:0:5::3<br/>```<br/><br/>ns4.ngcloud.ru<br/>``` bash<br/>81.22.46.43<br/>2a10:aa80:0:6::3<br/>```

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>66</td><td><strong><code class="code-no-wrap">zoneEmail</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Контактный e-mail</td><td></td></tr>
<tr><td>67</td><td><strong><code class="code-no-wrap">zoneName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя зоны</td><td>regex=^([a-z0-9-]+\.)+[a-z0-9-]+$</td></tr>
<tr><td>68</td><td><strong><code class="code-no-wrap">zoneKind</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>NATIVE</code></td><td>Тип зоны</td><td>value_list=NATIVE, SLAVE</td></tr>
<tr><td>69</td><td><strong><code class="code-no-wrap">zoneMastersForSlave</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Использовать если выбран тип SLAVE. IP адреса в формате через пробел для настройки Master-серверов</td><td></td></tr>
<tr><td>70</td><td><strong><code class="code-no-wrap">zoneTimeToRefresh</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>86400</code></td><td>Время ожидания ответа вторичного DNS перед запросом SOA-записи с первичных серверов</td><td></td></tr>
<tr><td>71</td><td><strong><code class="code-no-wrap">zoneTimeToRetry</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>7200</code></td><td>Время в течение которого сервер повторно попробует синхронизировать информацию с первичных DNS-серверов</td><td></td></tr>
<tr><td>72</td><td><strong><code class="code-no-wrap">zoneTimeToExpire</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>3600000</code></td><td>Время в течение которого вторичный DNS будет пытаться завершить синхронизацию зоны с первичным</td><td></td></tr>
<tr><td>73</td><td><strong><code class="code-no-wrap">zoneTimeToLive</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>86400</code></td><td>Время, в течение которого информация будет кешироваться другими DNS-серверами</td><td></td></tr>
<tr><td>284</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `43` | zoneEmail, zoneName, zoneKind, zoneMastersForSlave, zoneTimeToRefresh, zoneTimeToRetry, zoneTimeToExpire, zoneTimeToLive, resourceRealm |  |
| `delete` | `instance` | `delete` | `` | `44` |  |  |


## nubes_dnsrecord
- Service ID: 111
- Description: DNS запись в созданной зоне
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Необходима DNS зона, в которой будет создана DNS запись.<br/>Выберите <br/>* Зону в которой будет создана запись<br/>* Тип записи<br/>* Имя записи<br/>* Значение записи

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>75</td><td><strong><code class="code-no-wrap">zoneUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>UUID экземпляра услуги DNS-зоны</td><td>ref_svc_id=110</td></tr>
<tr><td>76</td><td><strong><code class="code-no-wrap">recordType</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Тип DNS-записи</td><td>value_list=A, AAAA, CNAME, MX, PTR, SOA, SRV, TXT, LUA, NS, SSHFP</td></tr>
<tr><td>77</td><td><strong><code class="code-no-wrap">recordName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя записи. Имя зоны в конце проставляется автоматически</td><td>unique_scope=parent</td></tr>
<tr><td>78</td><td><strong><code class="code-no-wrap">recordInput</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Значение. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP</td><td></td></tr>
<tr><td>450</td><td><strong><code class="code-no-wrap">recordTTL</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>3600</code></td><td>Time-to-Leave записи. Раз в какое время запись будет обновлена</td><td>minvalue=30; maxvalue=604800</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>256</td><td><strong><code class="code-no-wrap">recordInput</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Запись. Необходима валидация, в зависимости от типа записи. Должно быть заменено на UUID-внешнийIP</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `45` | zoneUid, recordType, recordName, recordInput, recordTTL |  |
| `delete` | `instance` | `delete` | `` | `46` |  |  |
| `modify` | `instance` | `modify` | `` | `90` | recordInput |  |


## nubes_tenant
- Service ID: 112
- Description: Организация доступов к мониторингу
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>239</td><td><strong><code class="code-no-wrap">grafanaOrgName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>WZ-Код клиента</td><td>regex=^WZ[\d]+$</td></tr>
<tr><td>240</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `84` | grafanaOrgName, resourceRealm |  |
| `delete` | `instance` | `delete` | `` | `86` |  |  |
| `modify` | `instance` | `modify` | `` | `87` |  | Просто удаляет все текущие датасоурсы и ставит их заново<br/>Полезно, когда нужно &quot;ресетнуть&quot; / &quot;добавить&quot; |


## nubes_vc_complex
- Service ID: 113
- Description: Создание готовой иерархии ресурсов
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Создает окружение для ВМ.<br/><br/>## Создает сервисы:<br/>**Организация**<br/>**Виртуальный датацентр**<br/>**Каталог**<br/>**Сетевой шлюз периметра**<br/><br/>

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>332</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Наименование ресурсной платформы</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>334</td><td><strong><code class="code-no-wrap">vappName</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Имя vApp</td><td>regex=^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$</td></tr>
<tr><td>358</td><td><strong><code class="code-no-wrap">vdcProviderGateway</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>sandbox-v1cl1-pvdc</code></td><td>Взять из свойств ресурсной платформы.<br/>Путь .vcd.providerVdc - взять KEY<br/><br/>providerGateway Cloud Director. Влияет ресурсы будут предоставлены. Является полем (List&amp;lt;String&amp;gt;) в свойствах рес. платформы ЛК, но сам параметр передаётся только как один String</td><td></td></tr>
<tr><td>359</td><td><strong><code class="code-no-wrap">virtualServicesCount</code></strong></td><td></td><td>ДА</td><td><code>1</code></td><td>Кол-во виртуальных сервисов, которые выделяются на AVI. Во избежании коллапса пока выделяется до 4</td><td>minvalue=1; maxvalue=4</td></tr>
<tr><td>360</td><td><strong><code class="code-no-wrap">ipSpaceName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td><code>internet-ipv4-v1</code></td><td>Имя ip Space для внешнего IP. Целесообразнее брать самый дешёвый, так как это vip для исходящего трафика. Необходимо задавать если включен needExternalAddressSNAT</td><td></td></tr>
<tr><td>399</td><td><strong><code class="code-no-wrap">storageConfig</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>[{&quot;name&quot;: &quot;&quot;, &quot;size&quot;: 1024}]</code></td><td>Описывается как массив объектов, где описывается имя политики и её размер</td><td></td></tr>
<tr><td>400</td><td><strong><code class="code-no-wrap">vdcNetworkPool</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>nsxt-sandbox-geneve-np</code></td><td></td><td></td></tr>
<tr><td>401</td><td><strong><code class="code-no-wrap">cpuGuaranteed</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>20</code></td><td></td><td>value_list=20, 50, 80</td></tr>
<tr><td>402</td><td><strong><code class="code-no-wrap">memGuaranteed</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>20</code></td><td></td><td>value_list=20, 50, 80</td></tr>
<tr><td>403</td><td><strong><code class="code-no-wrap">segroupName</code></strong></td><td><code>string</code></td><td>НЕТ</td><td><code>SEGROUP-SANDBOX-CL1-SHARED-01</code></td><td>Наименование segroup, в котором будут выделяться пулы на AVI</td><td></td></tr>
<tr><td>404</td><td><strong><code class="code-no-wrap">needExternalAddressSNAT</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>true</code></td><td>Выделяет внешний IP на Edge. Используется для SNAT всего трафика</td><td>value_list=false, true</td></tr>
<tr><td>405</td><td><strong><code class="code-no-wrap">needEnableAVI</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает AVI в Cloud Director</td><td>value_list=false, true</td></tr>
<tr><td>566</td><td><strong><code class="code-no-wrap">cpuAllocated</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>1</code></td><td>шт</td><td>minvalue=1</td></tr>
<tr><td>567</td><td><strong><code class="code-no-wrap">memAllocated</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>10</code></td><td>gb</td><td>minvalue=1</td></tr>
<tr><td>568</td><td><strong><code class="code-no-wrap">vIPCount</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>0</code></td><td>ш</td><td>minvalue=0; maxvalue=20</td></tr>
</tbody></table>

### Modify parameters
None.

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `107` | resourceRealm, vappName, vdcProviderGateway, virtualServicesCount, ipSpaceName, storageConfig, vdcNetworkPool, cpuGuaranteed, memGuaranteed, segroupName, needExternalAddressSNAT, needEnableAVI, cpuAllocated, memAllocated, vIPCount |  |


## nubes_gitea_complex
- Service ID: 114
- Description: Комплексная услуга из [&quot;gittea&quot;, &quot;postgres&quot;]
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Комплексная услуга из [&quot;gittea&quot;, &quot;postgres&quot;]

### Create parameters
None.

### Modify parameters
None.

### Operations
None.


## nubes_mariadb
- Service ID: 115
- Description: Управляемая база данных MySQL
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Mariadb кластер. Ресурсная платформа: k8s. Автоматизация: k8s operator.<br/>Автоматическое резервное копирование, ручное восстановление.

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>422</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Платформа для развертывания</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>424</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=500; maxvalue=4000</td></tr>
<tr><td>425</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1024</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=1024; maxvalue=8192</td></tr>
<tr><td>426</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>427</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td>Количество узлов</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>428</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>429</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster</td><td></td></tr>
<tr><td>430</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>НЕТ</td><td><code>0 * * * *</code></td><td>Не обязательный. Время запуска бекапа</td><td>regex=^(\*|(\d+|\*\/\d+|\d+(,\d+)*))\s\*\s\*\s\*\s\*$</td></tr>
<tr><td>431</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>9.4.0</code></td><td>Версия MySQL</td><td>value_list=8.4.0, 9.4.0</td></tr>
<tr><td>432</td><td><strong><code class="code-no-wrap">autoScale</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги</td><td>value_list=false, true</td></tr>
<tr><td>433</td><td><strong><code class="code-no-wrap">autoScalePercentage</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>10</code></td><td>Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема</td><td>value_list=10, 15, 20</td></tr>
<tr><td>434</td><td><strong><code class="code-no-wrap">autoScaleTechWindow</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>0</code></td><td>Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)</td><td>value_list=0, 5, 12, 23</td></tr>
<tr><td>435</td><td><strong><code class="code-no-wrap">autoScaleQuotaGb</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td><code>1</code></td><td>Квота для autoScale</td><td></td></tr>
<tr><td>459</td><td><strong><code class="code-no-wrap">s3Uid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно</td><td>ref_svc_id=12</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>436</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>437</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>438</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>439</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>440</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td></td><td></td><td>value_list=false, true</td></tr>
<tr><td>441</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>442</td><td><strong><code class="code-no-wrap">ext_BACKUP_SCHEDULE</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>443</td><td><strong><code class="code-no-wrap">autoScale</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td></td><td></td><td>value_list=false, true</td></tr>
<tr><td>444</td><td><strong><code class="code-no-wrap">autoScalePercentage</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>445</td><td><strong><code class="code-no-wrap">autoScaleTechWindow</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
<tr><td>446</td><td><strong><code class="code-no-wrap">autoScaleQuotaGb</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td></td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `138` | resourceRealm, resourceCPU, resourceMemory, resourceDisk, resourceInstances, needExternalAddressMaster, ipSpaceNameMaster, ext_BACKUP_SCHEDULE, appVersion, autoScale, autoScalePercentage, autoScaleTechWindow, autoScaleQuotaGb, s3Uid |  |
| `delete` | `instance` | `delete` | `` | `139` | deleteS3Bucket |  |
| `modify` | `instance` | `modify` | `` | `142` | resourceCPU, resourceMemory, resourceInstances, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, ext_BACKUP_SCHEDULE, autoScale, autoScalePercentage, autoScaleTechWindow, autoScaleQuotaGb |  |
| `resume` | `instance` | `resume` | `` | `141` |  |  |
| `suspend` | `instance` | `suspend` | `` | `140` |  |  |


## nubes_kafka
- Service ID: 116
- Description: Сервис создания кластера Apache Kafka
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Apache Kafka через платформу

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>461</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2`</td><td>minvalue=1; value_list=1, 2, 3, 4, 5</td></tr>
<tr><td>462</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2048`</td><td>minvalue=1000</td></tr>
<tr><td>463</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `2000`</td><td>minvalue=1000</td></tr>
<tr><td>464</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Пример: `20`</td><td></td></tr>
<tr><td>465</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>false</code></td><td>Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`</td><td>value_list=false, true</td></tr>
<tr><td>466</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
<tr><td>469</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка</td><td>func=getAvailableResourceRealms</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>501</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Пример: `2`</td><td>value_list=1, 2, 3, 4, 5</td></tr>
<tr><td>502</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Пример: `2048`</td><td>minvalue=1000</td></tr>
<tr><td>503</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td></td><td>НЕТ</td><td></td><td>Пример: `2000`</td><td>minvalue=1000</td></tr>
<tr><td>504</td><td><strong><code class="code-no-wrap">resourceDisk</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Пример: `20`</td><td></td></tr>
<tr><td>505</td><td><strong><code class="code-no-wrap">needExternalAddressMaster</code></strong></td><td><code>boolean</code></td><td>НЕТ</td><td><code>false</code></td><td>Флаг, определяющий, нужно ли выделять внешний IP для доступа к master-брокеру. Пример: `true` или `false`</td><td>value_list=false, true</td></tr>
<tr><td>506</td><td><strong><code class="code-no-wrap">ipSpaceNameMaster</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Если включен предыдущий параметр, то поле необходимо заполнить. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `148` | resourceInstances, resourceMemory, resourceCPU, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster, resourceRealm |  |
| `create_topic` | `subresource` | `create` | `topic` | `165` | nameTopic, partitions, replicas | # Инструкция по управлению топиками Apache Kafka через платформу<br/><br/>## 1. Общая информация<br/><br/>---<br/><br/>Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам.<br/>Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_topic**    — Создание топика<br/>- **modify_topic**    — Модификация топика<br/>- **delete_topic**    — Удаление топика<br/><br/>---<br/><br/>## 2. Параметры создания топика<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового топика:<br/><br/>* **Имя топика**<br/>  Название топика.<br/>  Должно быть уникальным в пределах кластера.<br/>  Пример: `orders-events`.<br/><br/>* **Партиции**<br/>  Количество партиций топика.<br/>  Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки.<br/>  Пример: `6`. Здесь важно рассказать о том как происходит расчет оптимального количества<br/>  Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.<br/><br/>* **Реплики**<br/>  Количество реплик для каждой партиции.<br/>  Обычно равно количеству доступных брокеров или меньше.<br/>  Пример: `3`.<br/><br/><br/>---<br/><br/>## 4. Параметры модификации топика<br/><br/>Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными:<br/><br/>* **Имя топика**<br/>  Название топика.<br/>  Пример: `orders-events`.<br/><br/>* **Партиции**<br/>  Новое количество партиций.<br/>  Пример: `12`.<br/><br/>* **Реплики**<br/>  Новое количество реплик.<br/>  Пример: `2`.<br/><br/>---<br/><br/>## 5. Рекомендации<br/><br/>* Планируйте количество партиций с запасом — уменьшение их числа невозможно.<br/>* Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров.<br/>* Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки.<br/><br/>--- |
| `create_user` | `subresource` | `create` | `user` | `168` | username, nameTopic, operations, group, accessHosts | # Инструкция по управлению пользователями Apache Kafka.<br/><br/>---<br/><br/>## 1. Общая информация<br/><br/>Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.<br/>Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.<br/>Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_user**    — Создание пользователя<br/>- **modify_user**    — Модификация пользователя<br/>- **delete_user**    — Удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры создания пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/>  Пример: `username-admin`<br/><br/>* **Топик**<br/>  Название топика, к которому будут назначены права для данного пользователя.<br/>  Пример: `orders-events`.<br/>  Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/>  Список разрешённых операций на указанном топике.<br/>  Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/>  Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/>  Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/>  Список хостов или подсетей, с которых разрешено подключение пользователя.<br/>  Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 3. Параметры модификации пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при модификации пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/>  Пример: `username-admin`<br/><br/>* **Топик**<br/>  Название топика, к которому будут назначены права для данного пользователя.<br/>  Пример: `orders-events`.<br/>  Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/>  Список разрешённых операций на указанном топике.<br/>  Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/>  Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/>  Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/>  Список хостов или подсетей, с которых разрешено подключение пользователя.<br/>  Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 4. Параметры удалении пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при удалении пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя удаляемого пользователя.<br/>  Пример: `username-admin`<br/><br/>## 5. Выходные параметры<br/><br/>После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:<br/><br/>* **ca.crt**<br/>  Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.<br/>  Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>   echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/>   ```<br/><br/>* **ca.p12**<br/>  PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.p12<br/>  ```<br/><br/>* **ca.password**<br/>  Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>* **user.crt**<br/>  Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.<br/>  Используется совместно с приватным ключом `user.key` для аутентификации.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/>  ```<br/><br/>* **user.key**<br/>  Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.key<br/>  ```<br/><br/>* **user.p12**<br/>  PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo &quot;&lt;содержание поля&gt;&quot; | base64 -d &gt; &lt;название&gt;.p12<br/>  ```<br/><br/>* **user.password**<br/>  Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>Эти параметры используются для настройки TLS-подключения.<br/><br/>---<br/><br/>## 6. Пример конфигурации клиента внутри кластера<br/><br/>Пример пода:<br/><br/>```yaml<br/>apiVersion: v1<br/>kind: Pod<br/>metadata:<br/>  name: kafka-4<br/>spec:<br/>  volumes:<br/>    - name: work<br/>      emptyDir: {}<br/>  containers:<br/>    - name: kcat<br/>      image: quay.io/strimzi/kafka:latest-kafka-4.0.0<br/>      command: [&quot;sleep&quot;, &quot;5600&quot;]<br/>      volumeMounts:<br/>        - name: work<br/>          mountPath: /work<br/>  restartPolicy: Never<br/>```<br/><br/>Создаём под и сохраняем сертификаты:<br/><br/>```bash<br/>kubectl cp user.p12 kafka-4:/work/<br/>kubectl cp ca.p12 kafka-4:/work/<br/>```<br/><br/>Создаём файлы конфигурации:<br/><br/>```bash<br/>cat &gt; /work/user-read.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>```bash<br/>cat &gt; /work/user-write.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user-write.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>Листинг доступных топиков:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-topics.sh \<br/>  --bootstrap-server kafkak8s-bootstrap-external:9093 \<br/>  --command-config /work/user-read.properties \<br/>  --list<br/>```<br/><br/>Запись сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-producer.sh \<br/>  --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \<br/>  --topic &lt;topic&gt; \<br/>  --producer.config /work/user-write.properties<br/>```<br/><br/>Чтение сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-consumer.sh \<br/>  --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \<br/>  --topic &lt;topic&gt; \<br/>  --from-beginning \<br/>  --group &lt;group&gt; \<br/>  --consumer.config /work/user-read.properties \<br/>  --max-messages 50<br/>```<br/><br/>---<br/><br/>## 7. Пример внешнего подключения с использованием **kcat**<br/><br/>**Листинг топиков**<br/><br/>```bash<br/>kcat -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -L \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-read.crt \<br/>  -X ssl.key.location=./user-read.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Запись сообщения**<br/><br/>```bash<br/> echo &quot;hello from kcat&quot; | kcat -P \<br/>  -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -t write-test \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-write.crt \<br/>  -X ssl.key.location=./user-write.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Чтение сообщений**<br/><br/>```bash<br/>kcat -C \<br/>  -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -t write-test \<br/>  -o beginning \<br/>  -q \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-read.crt \<br/>  -X ssl.key.location=./user-read.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>---<br/><br/><br/>## 9. Рекомендации<br/><br/>* Минимизируйте набор разрешённых операций для повышения безопасности.<br/>* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.<br/>* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.<br/>* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.<br/><br/>--- |
| `delete` | `instance` | `delete` | `` | `149` |  |  |
| `delete_topic` | `subresource` | `delete` | `topic` | `167` | nameTopic |  |
| `delete_user` | `subresource` | `delete` | `user` | `170` | username | # Инструкция по управлению пользователями Apache Kafka.<br/><br/>---<br/><br/>## 1. Общая информация<br/><br/>Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.<br/>Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.<br/>Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_user**    — Создание пользователя<br/>- **modify_user**    — Модификация пользователя<br/>- **delete_user**    — Удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры создания пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/>  Пример: `username-admin`<br/><br/>* **Топик**<br/>  Название топика, к которому будут назначены права для данного пользователя.<br/>  Пример: `orders-events`.<br/>  Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/>  Список разрешённых операций на указанном топике.<br/>  Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/>  Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/>  Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/>  Список хостов или подсетей, с которых разрешено подключение пользователя.<br/>  Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 3. Параметры модификации пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при модификации пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/>  Пример: `username-admin`<br/><br/>* **Топик**<br/>  Название топика, к которому будут назначены права для данного пользователя.<br/>  Пример: `orders-events`.<br/>  Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/>  Список разрешённых операций на указанном топике.<br/>  Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/>  Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/>  Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/>  Список хостов или подсетей, с которых разрешено подключение пользователя.<br/>  Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 4. Параметры удалении пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при удалении пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя удаляемого пользователя.<br/>  Пример: `username-admin`<br/><br/>## 5. Выходные параметры<br/><br/>После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:<br/><br/>* **ca.crt**<br/>  Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.<br/>  Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>   echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/>   ```<br/><br/>* **ca.p12**<br/>  PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.p12<br/>  ```<br/><br/>* **ca.password**<br/>  Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>* **user.crt**<br/>  Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.<br/>  Используется совместно с приватным ключом `user.key` для аутентификации.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/>  ```<br/><br/>* **user.key**<br/>  Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.key<br/>  ```<br/><br/>* **user.p12**<br/>  PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo &quot;&lt;содержание поля&gt;&quot; | base64 -d &gt; &lt;название&gt;.p12<br/>  ```<br/><br/>* **user.password**<br/>  Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>Эти параметры используются для настройки TLS-подключения.<br/><br/>---<br/><br/>## 6. Пример конфигурации клиента внутри кластера<br/><br/>Пример пода:<br/><br/>```yaml<br/>apiVersion: v1<br/>kind: Pod<br/>metadata:<br/>  name: kafka-4<br/>spec:<br/>  volumes:<br/>    - name: work<br/>      emptyDir: {}<br/>  containers:<br/>    - name: kcat<br/>      image: quay.io/strimzi/kafka:latest-kafka-4.0.0<br/>      command: [&quot;sleep&quot;, &quot;5600&quot;]<br/>      volumeMounts:<br/>        - name: work<br/>          mountPath: /work<br/>  restartPolicy: Never<br/>```<br/><br/>Создаём под и сохраняем сертификаты:<br/><br/>```bash<br/>kubectl cp user.p12 kafka-4:/work/<br/>kubectl cp ca.p12 kafka-4:/work/<br/>```<br/><br/>Создаём файлы конфигурации:<br/><br/>```bash<br/>cat &gt; /work/user-read.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>```bash<br/>cat &gt; /work/user-write.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user-write.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>Листинг доступных топиков:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-topics.sh \<br/>  --bootstrap-server kafkak8s-bootstrap-external:9093 \<br/>  --command-config /work/user-read.properties \<br/>  --list<br/>```<br/><br/>Запись сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-producer.sh \<br/>  --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \<br/>  --topic &lt;topic&gt; \<br/>  --producer.config /work/user-write.properties<br/>```<br/><br/>Чтение сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-consumer.sh \<br/>  --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \<br/>  --topic &lt;topic&gt; \<br/>  --from-beginning \<br/>  --group &lt;group&gt; \<br/>  --consumer.config /work/user-read.properties \<br/>  --max-messages 50<br/>```<br/><br/>---<br/><br/>## 7. Пример внешнего подключения с использованием **kcat**<br/><br/>**Листинг топиков**<br/><br/>```bash<br/>kcat -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -L \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-read.crt \<br/>  -X ssl.key.location=./user-read.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Запись сообщения**<br/><br/>```bash<br/> echo &quot;hello from kcat&quot; | kcat -P \<br/>  -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -t write-test \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-write.crt \<br/>  -X ssl.key.location=./user-write.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Чтение сообщений**<br/><br/>```bash<br/>kcat -C \<br/>  -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -t write-test \<br/>  -o beginning \<br/>  -q \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-read.crt \<br/>  -X ssl.key.location=./user-read.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>---<br/><br/><br/>## 9. Рекомендации<br/><br/>* Минимизируйте набор разрешённых операций для повышения безопасности.<br/>* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.<br/>* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.<br/>* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.<br/><br/>--- |
| `modify` | `instance` | `modify` | `` | `162` | resourceInstances, resourceMemory, resourceCPU, resourceDisk, needExternalAddressMaster, ipSpaceNameMaster |  |
| `modify_topic` | `subresource` | `modify` | `topic` | `166` | nameTopic, partitions, replicas | # Инструкция по управлению топиками Apache Kafka через платформу<br/><br/>## 1. Общая информация<br/><br/>---<br/><br/>Топик — это основная сущность в Apache Kafka, предназначенная для приёма сообщений от продюсеров и передачи их консюмерам.<br/>Платформа позволяет создавать, удалять и изменять параметры топиков без прямого доступа к брокерам, обеспечивая удобное управление через интерфейс или API.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_topic**    — Создание топика<br/>- **modify_topic**    — Модификация топика<br/>- **delete_topic**    — Удаление топика<br/><br/>---<br/><br/>## 2. Параметры создания топика<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового топика:<br/><br/>* **Имя топика**<br/>  Название топика.<br/>  Должно быть уникальным в пределах кластера.<br/>  Пример: `orders-events`.<br/><br/>* **Партиции**<br/>  Количество партиций топика.<br/>  Рекомендуется выбирать с учётом уровня параллелизма потребителей и предполагаемой нагрузки.<br/>  Пример: `6`. Здесь важно рассказать о том как происходит расчет оптимального количества<br/>  Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.<br/><br/>* **Реплики**<br/>  Количество реплик для каждой партиции.<br/>  Обычно равно количеству доступных брокеров или меньше.<br/>  Пример: `3`.<br/><br/><br/>---<br/><br/>## 4. Параметры модификации топика<br/><br/>Для уже существующих топиков можно изменять параметры. Все параметры являются опциональными:<br/><br/>* **Имя топика**<br/>  Название топика.<br/>  Пример: `orders-events`.<br/><br/>* **Партиции**<br/>  Новое количество партиций.<br/>  Пример: `12`.<br/><br/>* **Реплики**<br/>  Новое количество реплик.<br/>  Пример: `2`.<br/><br/>---<br/><br/>## 5. Рекомендации<br/><br/>* Планируйте количество партиций с запасом — уменьшение их числа невозможно.<br/>* Количество реплик должно соответствовать требуемому уровню отказоустойчивости, но не превышать количество брокеров.<br/>* Изменение параметров топика в рабочем окружении может временно влиять на производительность. Рекомендуется проводить крупные изменения в периоды минимальной нагрузки.<br/><br/>--- |
| `modify_user` | `subresource` | `modify` | `user` | `169` | nameTopic, operations, group, accessHosts, username | # Инструкция по управлению пользователями Apache Kafka.<br/><br/>---<br/><br/>## 1. Общая информация<br/><br/>Пользователи в Apache Kafka используются для аутентификации и авторизации при подключении к кластеру.<br/>Платформа позволяет создавать, удалять и изменять пользователей без прямого доступа к брокерам, а также настраивать права доступа к топикам и группам.<br/>Это обеспечивает централизованное и безопасное управление доступом к ресурсам Kafka.<br/><br/>---<br/><br/>## Доступные операции<br/><br/>- **create_user**    — Создание пользователя<br/>- **modify_user**    — Модификация пользователя<br/>- **delete_user**    — Удаление пользователя<br/><br/>---<br/><br/>## 2. Параметры создания пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при создании нового пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/>  Пример: `username-admin`<br/><br/>* **Топик**<br/>  Название топика, к которому будут назначены права для данного пользователя.<br/>  Пример: `orders-events`.<br/>  Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/>  Список разрешённых операций на указанном топике.<br/>  Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/>  Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/>  Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/>  Список хостов или подсетей, с которых разрешено подключение пользователя.<br/>  Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 3. Параметры модификации пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при модификации пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя создаваемого пользователя. Используется для подключения к Kafka и настройки прав.<br/>  Пример: `username-admin`<br/><br/>* **Топик**<br/>  Название топика, к которому будут назначены права для данного пользователя.<br/>  Пример: `orders-events`.<br/>  Использовать маску нельзя (`orders*`), только полное название или `*`.<br/><br/>* **Операции**<br/>  Список разрешённых операций на указанном топике.<br/>  Пример: `Describe, Read, Write`<br/><br/>* **Группа**<br/>  Имя группы, которой разрешён доступ. Используется при настройке консюмер-групп.<br/>  Пример: `order-consumers`.<br/><br/>* **Разрешённые хосты**<br/>  Список хостов или подсетей, с которых разрешено подключение пользователя.<br/>  Пример: `192.168.1.0/24` или `*`.<br/><br/>---<br/><br/>## 4. Параметры удалении пользователя<br/><br/>Ниже перечислены параметры, которые необходимо указать при удалении пользователя:<br/><br/>* **Имя пользователя**<br/>  Имя удаляемого пользователя.<br/>  Пример: `username-admin`<br/><br/>## 5. Выходные параметры<br/><br/>После успешного создания пользователя платформа возвращает параметры, необходимые для подключения:<br/><br/>* **ca.crt**<br/>  Корневой сертификат (Certificate Authority), используемый для проверки подлинности сервера при TLS-подключении.<br/>  Файл содержит публичный ключ удостоверяющего центра, которому доверяют брокеры и клиенты. Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>   echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/>   ```<br/><br/>* **ca.p12**<br/>  PKCS#12-хранилище с корневым сертификатом (Certificate Authority), используемое для проверки подлинности сервера при TLS-подключении.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.p12<br/>  ```<br/><br/>* **ca.password**<br/>  Пароль для доступа к хранилищу `ca.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>* **user.crt**<br/>  Клиентский сертификат, подтверждающий личность пользователя при подключении к Kafka.<br/>  Используется совместно с приватным ключом `user.key` для аутентификации.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.crt<br/>  ```<br/><br/>* **user.key**<br/>  Приватный ключ пользователя, применяемый для установления защищённого TLS-соединения и подтверждения подлинности.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo '&lt;содержание поля&gt;' | base64 -d &gt; &lt;название&gt;.key<br/>  ```<br/><br/>* **user.p12**<br/>  PKCS#12-хранилище с клиентским сертификатом и приватным ключом, предназначенное для аутентификации пользователя в Kafka.<br/>  Выдаеться в формате base64 для получения файла сертификата использовать команду<br/>  ```bash<br/>  echo &quot;&lt;содержание поля&gt;&quot; | base64 -d &gt; &lt;название&gt;.p12<br/>  ```<br/><br/>* **user.password**<br/>  Пароль для доступа к хранилищу `user.p12`. Выдаеться в чистом виде. Раскодировать не нужно.<br/><br/>Эти параметры используются для настройки TLS-подключения.<br/><br/>---<br/><br/>## 6. Пример конфигурации клиента внутри кластера<br/><br/>Пример пода:<br/><br/>```yaml<br/>apiVersion: v1<br/>kind: Pod<br/>metadata:<br/>  name: kafka-4<br/>spec:<br/>  volumes:<br/>    - name: work<br/>      emptyDir: {}<br/>  containers:<br/>    - name: kcat<br/>      image: quay.io/strimzi/kafka:latest-kafka-4.0.0<br/>      command: [&quot;sleep&quot;, &quot;5600&quot;]<br/>      volumeMounts:<br/>        - name: work<br/>          mountPath: /work<br/>  restartPolicy: Never<br/>```<br/><br/>Создаём под и сохраняем сертификаты:<br/><br/>```bash<br/>kubectl cp user.p12 kafka-4:/work/<br/>kubectl cp ca.p12 kafka-4:/work/<br/>```<br/><br/>Создаём файлы конфигурации:<br/><br/>```bash<br/>cat &gt; /work/user-read.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>```bash<br/>cat &gt; /work/user-write.properties &lt;&lt;'EOF'<br/>security.protocol=SSL<br/>ssl.keystore.type=PKCS12<br/>ssl.keystore.location=/work/user-write.p12<br/>ssl.keystore.password=&lt;user.password&gt;<br/>ssl.truststore.type=PKCS12<br/>ssl.truststore.location=/work/ca.p12<br/>ssl.truststore.password=&lt;ca.password&gt;<br/>EOF<br/>```<br/><br/>Листинг доступных топиков:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-topics.sh \<br/>  --bootstrap-server kafkak8s-bootstrap-external:9093 \<br/>  --command-config /work/user-read.properties \<br/>  --list<br/>```<br/><br/>Запись сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-producer.sh \<br/>  --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \<br/>  --topic &lt;topic&gt; \<br/>  --producer.config /work/user-write.properties<br/>```<br/><br/>Чтение сообщений:<br/><br/>```bash<br/>/opt/kafka/bin/kafka-console-consumer.sh \<br/>  --bootstrap-server &lt;адрес сервис брокера&gt;:9093 \<br/>  --topic &lt;topic&gt; \<br/>  --from-beginning \<br/>  --group &lt;group&gt; \<br/>  --consumer.config /work/user-read.properties \<br/>  --max-messages 50<br/>```<br/><br/>---<br/><br/>## 7. Пример внешнего подключения с использованием **kcat**<br/><br/>**Листинг топиков**<br/><br/>```bash<br/>kcat -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -L \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-read.crt \<br/>  -X ssl.key.location=./user-read.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Запись сообщения**<br/><br/>```bash<br/> echo &quot;hello from kcat&quot; | kcat -P \<br/>  -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -t write-test \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-write.crt \<br/>  -X ssl.key.location=./user-write.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>**Чтение сообщений**<br/><br/>```bash<br/>kcat -C \<br/>  -b &lt;externalConnect.bootstrap.fqdn&gt;:9093 \<br/>  -t write-test \<br/>  -o beginning \<br/>  -q \<br/>  -X security.protocol=SSL \<br/>  -X ssl.ca.location=./ca.crt \<br/>  -X ssl.certificate.location=./user-read.crt \<br/>  -X ssl.key.location=./user-read.key \<br/>  -X ssl.endpoint.identification.algorithm=none<br/>```<br/><br/>---<br/><br/><br/>## 9. Рекомендации<br/><br/>* Минимизируйте набор разрешённых операций для повышения безопасности.<br/>* Используйте отдельные учётные записи для продюсеров, консюмеров и системных сервисов.<br/>* Ограничивайте доступ по IP или подсетям с помощью параметра **Разрешённые хосты**.<br/>* После изменения прав или групп пользователя рекомендуется проверить подключение и доступ к топикам.<br/><br/>--- |
| `resume` | `instance` | `resume` | `` | `161` |  |  |
| `suspend` | `instance` | `suspend` | `` | `160` |  |  |


## nubes_nifi
- Service ID: 117
- Description: ETL-система
- MAN: embedded in resource page
- Operations: embedded in resource page

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>471</td><td><strong><code class="code-no-wrap">kafkaUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>Выбрать кластер из списка</td><td>ref_svc_id=116</td></tr>
<tr><td>472</td><td><strong><code class="code-no-wrap">partitions</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.</td><td></td></tr>
<tr><td>473</td><td><strong><code class="code-no-wrap">replicas</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Количество партиций ≤ (число брокеров). Пример `2`</td><td></td></tr>
<tr><td>474</td><td><strong><code class="code-no-wrap">nameTopic</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Пример: `orders-events`</td><td></td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>477</td><td><strong><code class="code-no-wrap">partitions</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки.</td><td></td></tr>
<tr><td>478</td><td><strong><code class="code-no-wrap">replicas</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Количество партиций ≤ (число брокеров). Пример `2`</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `150` | kafkaUid, partitions, replicas, nameTopic |  |
| `delete` | `instance` | `delete` | `` | `151` |  |  |
| `modify` | `instance` | `modify` | `` | `154` | partitions, replicas |  |


## nubes_akhq
- Service ID: 119
- Description: Web интерфейс Akhq для работы с Apache Kafka
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Apache Kafka через платформу

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>550</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Выбрать платформу из списка</td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>551</td><td><strong><code class="code-no-wrap">resourceMemory</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>512</code></td><td>Пример: `1024`</td><td>minvalue=512</td></tr>
<tr><td>552</td><td><strong><code class="code-no-wrap">resourceCPU</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>500</code></td><td>Пример: `1000`</td><td>minvalue=500</td></tr>
<tr><td>553</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm</td><td>regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$</td></tr>
<tr><td>554</td><td><strong><code class="code-no-wrap">resourceInstances</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td></td><td>minvalue=1</td></tr>
<tr><td>555</td><td><strong><code class="code-no-wrap">kafkaUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>Выбрать кластер из списка</td><td>ref_svc_id=116</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>565</td><td><strong><code class="code-no-wrap">kafkaUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>Выбрать кластер из списка</td><td>ref_svc_id=116</td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `175` | resourceRealm, resourceMemory, resourceCPU, domain, resourceInstances, kafkaUid |  |
| `delete` | `instance` | `delete` | `` | `176` |  |  |
| `modify` | `instance` | `modify` | `` | `180` | kafkaUid |  |
| `resume` | `instance` | `resume` | `` | `178` |  |  |
| `suspend` | `instance` | `suspend` | `` | `177` |  |  |


## nubes_clickhouse
- Service ID: 120
- Description: Управляемая база данных ClickHouse
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по управлению кластерами и пользователями ClickHouse

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

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

### Operations
| 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 остаются нетронутыми |


## nubes_valo_tenant
- Service ID: 149
- Description: Корпоративная система обмена и синхронизации файлов
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
# Инструкция по развертыванию Тенант Valo через платформу<br/><br/>## 1. Общая информация<br/>Тенант Valo — логический изолированный экземпляр сервиса VALO Cloud, предоставляющий защищённое облачное хранилище, синхронизацию данных и доступ к документам с различных устройств. При создании тенант автоматически разворачивается в тестовом режиме сроком на 2 месяца. Перевод в промышленную эксплуатацию выполняется отдельной операцией.<br/><br/>### Доступные операции<br/><br/>* **create** — создание нового тенанта в тестовом режиме сроком на 2 месяца.<br/>* **modify** — изменение настроек тенанта, включая перевод из ТЕСТ в ПРОД.<br/>* **suspend** — выключение (приостановка работы) тенанта.<br/>* **resume** — включение ранее приостановленного тенанта.<br/>* **delete** — удаление тенанта; доступно...

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>655</td><td><strong><code class="code-no-wrap">resourceRealm</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td></td><td>func=getAvailableResourceRealms</td></tr>
<tr><td>656</td><td><strong><code class="code-no-wrap">domain</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Будет добавлено в зону valo.ngcloud.ru</td><td>regex=^[a-z0-9](?:[a-z0-9-]{3,61}[a-z0-9])?$; maxlength=61; minlength=3</td></tr>
<tr><td>657</td><td><strong><code class="code-no-wrap">valoOptions</code></strong></td><td><code>map-fixed</code></td><td>ДА</td><td><code>{}</code></td><td></td><td></td></tr>
<tr><td>658</td><td><strong><code class="code-no-wrap">s3Storage</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>10</code></td><td>Данные хранятся в отдельном экземпляре S3</td><td>minvalue=1; maxvalue=999</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>659</td><td><strong><code class="code-no-wrap">valoOptions</code></strong></td><td><code>map-fixed</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>660</td><td><strong><code class="code-no-wrap">s3Storage</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td>Данные хранятся в отдельном экземпляре S3</td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `202` | resourceRealm, domain, valoOptions, s3Storage |  |
| `delete` | `instance` | `delete` | `` | `206` |  |  |
| `modify` | `instance` | `modify` | `` | `203` | valoOptions, s3Storage |  |
| `resume` | `instance` | `resume` | `` | `205` |  |  |
| `suspend` | `instance` | `suspend` | `` | `204` |  |  |


## nubes_k8s_sthutrval_cluster
- Service ID: 150
- Description: Платформа управления K8s<br/>
- MAN: embedded in resource page
- Operations: embedded in resource page

### Summary
Перед разворачиванием убедиться, что в облаке есть 2 свободных невыделенных IP в пуле

### Create parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>344</td><td><strong><code class="code-no-wrap">nsxtUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td>InstanceUid nsxt. Nsxt должен быть создан</td><td>ref_svc_id=22</td></tr>
<tr><td>345</td><td><strong><code class="code-no-wrap">clusterName</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>example1</code></td><td>Наименование кластера Kubernetes. Имя будет использоваться в fqdn (svc.$CLUSTER_NAME)</td><td>regex=(?=^.{1,63}$)^[a-z0-9]([a-z0-9-]*[a-z0-9])?$; unique_scope=provider</td></tr>
<tr><td>346</td><td><strong><code class="code-no-wrap">controlPlaneSizingPolicy</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Настройка Control Plane. CPU (шт) / MEM (gb).<br/>Наверное, должна подтягиваться из свойств ресурсной платформы</td><td></td></tr>
<tr><td>347</td><td><strong><code class="code-no-wrap">controlPlaneSizingDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>30</code></td><td>Настройка Control Plane. Disk (Gb)</td><td>minvalue=20; maxvalue=999</td></tr>
<tr><td>348</td><td><strong><code class="code-no-wrap">controlPlaneCount</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>1</code></td><td></td><td>minvalue=1; maxvalue=9</td></tr>
<tr><td>349</td><td><strong><code class="code-no-wrap">workersSizingPolicy</code></strong></td><td><code>string</code></td><td>ДА</td><td></td><td>Настройка workers. CPU (шт) / MEM (gb)</td><td></td></tr>
<tr><td>350</td><td><strong><code class="code-no-wrap">workersSizingDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>40</code></td><td>Настройка workers. Disk (Gb)</td><td>minvalue=20; maxvalue=999</td></tr>
<tr><td>351</td><td><strong><code class="code-no-wrap">workersCount</code></strong></td><td><code>integer</code></td><td>ДА</td><td><code>2</code></td><td>Настройка workers. Кол-во нод</td><td>minvalue=1; maxvalue=99</td></tr>
<tr><td>352</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>ДА</td><td><code>2.12.1</code></td><td>Версия Штурвал (не является версией Kubernetes)</td><td>value_list=2.12.1, 2.11.0</td></tr>
<tr><td>353</td><td><strong><code class="code-no-wrap">needExternalAddressAPI</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>true</code></td><td>Выделяет внешний IP для доступа к kubernetes API. Пока нельзя выставить false</td><td>value_list=true</td></tr>
<tr><td>354</td><td><strong><code class="code-no-wrap">accessIpListAPI</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>[]</code></td><td>Access IP List для подключения к Kubernetes API. Указывается массив. Если передан пустой массив, доступ выделяется всем</td><td></td></tr>
<tr><td>355</td><td><strong><code class="code-no-wrap">needExternalAddressIngress</code></strong></td><td><code>boolean</code></td><td>ДА</td><td><code>true</code></td><td>Выделяет внешний IP для доступа к Ingress</td><td>value_list=true</td></tr>
<tr><td>356</td><td><strong><code class="code-no-wrap">accessIpListIngress</code></strong></td><td><code>json</code></td><td>ДА</td><td><code>[]</code></td><td>Access IP List для подключения к Ingress. Указывается массив. Если передан пустой массив, доступ выделяется всем</td><td></td></tr>
<tr><td>747</td><td><strong><code class="code-no-wrap">vdcUid</code></strong></td><td><code>uuid</code></td><td>ДА</td><td></td><td></td><td>ref_svc_id=21</td></tr>
</tbody></table>

### Modify parameters
<table class="resource-table">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>362</td><td><strong><code class="code-no-wrap">controlPlaneCount</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Кол-во нод Control Plane</td><td>minvalue=1; maxvalue=9</td></tr>
<tr><td>363</td><td><strong><code class="code-no-wrap">workersCount</code></strong></td><td><code>integer</code></td><td>НЕТ</td><td></td><td>Кол-во нод Workers</td><td>minvalue=1; maxvalue=99</td></tr>
<tr><td>364</td><td><strong><code class="code-no-wrap">accessIpListAPI</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Access IP List для подключения к Kubernetes API. Указывается массив. Если передан пустой массив, доступ выделяется всем</td><td></td></tr>
<tr><td>365</td><td><strong><code class="code-no-wrap">accessIpListIngress</code></strong></td><td><code>json</code></td><td>НЕТ</td><td></td><td>Access IP List для подключения к Ingress. Указывается массив. Если передан пустой массив, доступ выделяется всем</td><td></td></tr>
<tr><td>563</td><td><strong><code class="code-no-wrap">appVersion</code></strong></td><td><code>string</code></td><td>НЕТ</td><td></td><td>Версия Штурвал (не является версией Kubernetes)<br/>Понижать версию нельзя<br/>Обновиться на несколько минорных нельзя<br/>Невозможно перепрыгнуть не с последней минорной на мажорную<br/>Можно обновиться на несколько патчей</td><td>value_list=2.11.0, 2.12.1</td></tr>
<tr><td>637</td><td><strong><code class="code-no-wrap">controlPlaneSizingDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td></td><td></td></tr>
<tr><td>638</td><td><strong><code class="code-no-wrap">workersSizingDisk</code></strong></td><td><code>integer</code></td><td>ДА</td><td></td><td></td><td></td></tr>
</tbody></table>

### Operations
| Operation | Kind | Action | Subresource | ID | Params | Description |
|---|---|---|---|---|---|---|
| `create` | `instance` | `create` | `` | `108` | nsxtUid, clusterName, controlPlaneSizingPolicy, controlPlaneSizingDisk, controlPlaneCount, workersSizingPolicy, workersSizingDisk, workersCount, appVersion, needExternalAddressAPI, accessIpListAPI, needExternalAddressIngress, accessIpListIngress, vdcUid |  |
| `delete` | `instance` | `delete` | `` | `109` |  |  |
| `modify` | `instance` | `modify` | `` | `110` | controlPlaneCount, workersCount, accessIpListAPI, accessIpListIngress, appVersion, controlPlaneSizingDisk, workersSizingDisk |  |
| `reconcile` | `action` | `reconcile` | `` | `253` |  |  |
| `resume` | `instance` | `resume` | `` | `174` |  |  |
| `suspend` | `instance` | `suspend` | `` | `173` |  |  |
| `update_secrets` | `action` | `update_secrets` | `` | `179` |  |  |