add: documentation

2026-06-30 15:45:24 +04:00
parent 540c1f7293
commit ca276d200f
1055 changed files with 47294 additions and 0 deletions
@@ -0,0 +1,58 @@
+# Operations: nubes_mariadb
+
+| 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` |  |  |
+
+## Operation: create
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания |  | func=getAvailableResourceRealms | `422` |
+| `resourceCPU` | `integer &gt; 0` | `ДА` | `500` | Квота ядра пода (milicores) |  | minvalue=500; maxvalue=4000 | `424` |
+| `resourceMemory` | `integer &gt; 0` | `ДА` | `1024` | Квота памяти пода (MBytes) |  | minvalue=1024; maxvalue=8192 | `425` |
+| `resourceDisk` | `integer &gt; 0` | `ДА` | `1` | Квота диска (Указывается в GIGAbytes) |  | minvalue=1; maxvalue=999 | `426` |
+| `resourceInstances` | `integer &gt; 0` | `ДА` | `1` | Количество узлов |  | minvalue=1; maxvalue=7 | `427` |
+| `needExternalAddressMaster` | `boolean` | `ДА` | `false` | Выделяет внешний (белый) IP для доступа к master |  | value_list=false, true | `428` |
+| `ipSpaceNameMaster` | `string` | `НЕТ` | `` | Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster |  |  | `429` |
+| `ext_BACKUP_SCHEDULE` | `string` | `НЕТ` | `0 * * * *` | Не обязательный. Время запуска бекапа |  | regex=^(\*|(\d+|\*\/\d+|\d+(,\d+)*))\s\*\s\*\s\*\s\*$ | `430` |
+| `appVersion` | `string` | `ДА` | `9.4.0` | Версия MySQL |  | value_list=8.4.0, 9.4.0 | `431` |
+| `autoScale` | `boolean` | `ДА` | `false` | Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги |  | value_list=false, true | `432` |
+| `autoScalePercentage` | `integer &gt; 0` | `НЕТ` | `10` | Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема |  | value_list=10, 15, 20 | `433` |
+| `autoScaleTechWindow` | `integer &gt;= 0` | `НЕТ` | `0` | Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23) |  | value_list=0, 5, 12, 23 | `434` |
+| `autoScaleQuotaGb` | `integer &gt; 0` | `НЕТ` | `1` | Квота для autoScale |  |  | `435` |
+| `s3Uid` | `uuid` | `ДА` | `` | Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно |  | ref_svc_id=12 | `459` |
+
+## Operation: delete
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `deleteS3Bucket` | `boolean` | `ДА` | `true` | Также удалить технический S3 Bucket с бэкапами? |  | value_list=false, true | `456` |
+
+## Operation: modify
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `resourceCPU` | `integer &gt; 0` | `НЕТ` | `` |  |  |  | `436` |
+| `resourceMemory` | `integer &gt; 0` | `НЕТ` | `` |  |  |  | `437` |
+| `resourceInstances` | `integer &gt; 0` | `НЕТ` | `` |  |  |  | `438` |
+| `resourceDisk` | `integer &gt; 0` | `НЕТ` | `` |  |  |  | `439` |
+| `needExternalAddressMaster` | `boolean` | `НЕТ` | `` |  |  | value_list=false, true | `440` |
+| `ipSpaceNameMaster` | `` | `НЕТ` | `` |  |  |  | `441` |
+| `ext_BACKUP_SCHEDULE` | `string` | `НЕТ` | `` |  |  |  | `442` |
+| `autoScale` | `boolean` | `НЕТ` | `` |  |  | value_list=false, true | `443` |
+| `autoScalePercentage` | `integer &gt; 0` | `НЕТ` | `` |  |  |  | `444` |
+| `autoScaleTechWindow` | `integer &gt;= 0` | `НЕТ` | `` |  |  |  | `445` |
+| `autoScaleQuotaGb` | `integer &gt; 0` | `НЕТ` | `` |  |  |  | `446` |
+
+## Operation: resume
+
+None.
+
+## Operation: suspend
+
+None.