add: documentation

This commit is contained in:
“Naeel”
2026-06-30 15:45:24 +04:00
parent 540c1f7293
commit ca276d200f
1055 changed files with 47294 additions and 0 deletions
@@ -0,0 +1,44 @@
# Operations: nubes_flask
| 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` | | |
## Operation: create
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `domain` | `string` | `ДА` | `web01` | Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm | | regex=^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$ | `248` |
| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | | func=getAvailableResourceRealms | `249` |
| `resourceCPU` | `integer > 0` | `ДА` | `300` | Квота ядра пода (milicores) | | minvalue=100; maxvalue=4000 | `250` |
| `resourceMemory` | `integer > 0` | `ДА` | `256` | Квота памяти пода (MBytes) | | minvalue=128; maxvalue=8192 | `251` |
| `resourceInstances` | `integer > 0` | `ДА` | `1` | Количество узлов | | minvalue=1; maxvalue=7 | `252` |
| `gitPath` | `string` | `ДА` | `https://github.com/Foxyhhd/Baldurs-Gate-test.git` | Путь до Git, который будет webroot для сайта | Путь до Git, который будет webroot для сайта | | `253` |
| `jsonEnv` | `string` | `НЕТ` | `{ "param": "value" }` | Массив переменных, будут переданы в env приложения | | | `254` |
| `healthPath` | `string` | `НЕТ` | `` | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код | | | `255` |
## Operation: delete
None.
## Operation: modify
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `resourceCPU` | `integer > 0` | `ДА` | `` | Квота ядра пода (milicores) | | minvalue=100; maxvalue=4000 | `451` |
| `resourceMemory` | `integer > 0` | `ДА` | `` | Квота памяти пода (MBytes) | | minvalue=128; maxvalue=8192 | `452` |
| `resourceInstances` | `integer > 0` | `ДА` | `` | Количество узлов | | minvalue=1; maxvalue=7 | `453` |
| `gitPath` | `` | `ДА` | `` | Путь до Git, который будет webroot для сайта | | | `454` |
| `jsonEnv` | `json` | `ДА` | `{ "param": "value" }` | Массив переменных, будут переданы в env приложения | | | `455` |
## Operation: resume
None.
## Operation: suspend
None.