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,54 @@
+# Operations: nubes_nodejs
+
+| 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` |  |  |
+
+## Operation: create
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `domain` | `string` | `ДА` | `web01` | Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm | Наименование поддомена, будет добавлено в nodejs.dev.nubes.ru | regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$ | `149` |
+| `gitPath` | `string` | `ДА` | `https://github.com/xahys/testnode.git` | Путь до Git, который будет webroot для сайта | Путь до Git, который будет webroot для сайта |  | `150` |
+| `healthPath` | `string` | `НЕТ` | `` | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. Если оставить пустым, healtcheck'а не будет | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. Если оставить пустым, healtcheck'а не будет |  | `151` |
+| `jsonEnv` | `json` | `НЕТ` | `` | Массив переменных, будут переданы в env приложения | Массив переменных, будут переданы в env приложения |  | `152` |
+| `resourceCPU` | `integer &gt; 0` | `ДА` | `500` | Квота ядра пода (milicores). 1000Mili = 1 Ядро | Квота ядра пода (milicores). 1000Mili = 1 Ядро | minvalue=100; maxvalue=4000 | `153` |
+| `resourceMemory` | `integer &gt; 0` | `ДА` | `1024` | Квота памяти пода (MBytes) | Квота памяти пода (MBytes) | minvalue=128; maxvalue=8192 | `154` |
+| `resourceInstances` | `integer &gt; 0` | `ДА` | `1` | Количество узлов | Количество узлов в сети | minvalue=1; maxvalue=7 | `155` |
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания |  | func=getAvailableResourceRealms | `156` |
+| `appVersion` | `string` | `ДА` | `23` | Версия приложения |  | regex=^(\d){2}$; value_list=18, 20, 22, 23 | `270` |
+
+## Operation: delete
+
+None.
+
+## Operation: modify
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `gitPath` | `string` | `НЕТ` | `` | Путь до Git, который будет webroot для сайта | Путь до Git, который будет webroot для сайта |  | `157` |
+| `healthPath` | `string` | `НЕТ` | `` | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. |  | `158` |
+| `jsonEnv` | `json` | `НЕТ` | `` | Массив переменных, будут переданы в env приложения | Массив переменных, будут переданы в env приложения | maxlength=2048 | `159` |
+| `resourceCPU` | `integer &gt; 0` | `НЕТ` | `` | Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро | Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро | minvalue=100; maxvalue=4000 | `160` |
+| `resourceMemory` | `integer &gt; 0` | `НЕТ` | `` | Квота памяти пода (Указывается в Megabytes) | Квота памяти пода (Указывается в Megabytes) | minvalue=128; maxvalue=8192 | `161` |
+| `resourceInstances` | `integer &gt; 0` | `НЕТ` | `` | Количество узлов | Количество узлов в сети | minvalue=1; maxvalue=7 | `162` |
+| `appVersion` | `string` | `ДА` | `23` | Версия приложения | Версия приложения | regex=^(\d){2}$; value_list=18, 20, 22, 23 | `271` |
+
+## Operation: redeploy
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания |  | func=getAvailableResourceRealms | `258` |
+
+## Operation: resume
+
+None.
+
+## Operation: suspend
+
+None.