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,48 @@
# Operations: nubes_pgadmin
| 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` | | |
## Operation: create
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `domain` | `string` | `ДА` | `web01` | Если будет указан FQDN, то происходят проверки DNS на валидность А-записи, или будет добавлено в зону resourceRealm | Если будет указан 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])?$; unique_scope=provider | `164` |
| `resourceCPU` | `integer > 0` | `ДА` | `200` | Квота ядра пода (milicores). 1000Mili = 1 Ядро | Квота ядра пода (milicores). 1000Mili = 1 Ядро | minvalue=100; maxvalue=4000 | `165` |
| `resourceMemory` | `integer > 0` | `ДА` | `256` | Квота памяти пода (MBytes) | Квота памяти пода (MBytes) | minvalue=128; maxvalue=8192 | `166` |
| `resourceDisk` | `integer > 0` | `ДА` | `1` | Квота диска (Указывается в GIGAbytes) | Квота диска (Указывается в GIGAbytes) | minvalue=1; maxvalue=999 | `167` |
| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | Наименование кластера Kubernetes для подключения | func=getAvailableResourceRealms | `169` |
| `login` | `string` | `ДА` | `` | Логин для подключения к pgAdmin, в формате email (login@email.net) | Логин для подключения к pgAdmin, в формате email (login@email.net) | regex=^([a-zA-Z0-9._-]+@[a-zA-Z0-9._-]+\.[a-zA-Z0-9_-]+)$; maxlength=255; minlength=3 | `170` |
| `password` | `string` | `ДА` | `` | Пароль для подключения к pgAdmin | Пароль для подключения к pgAdmin | | `171` |
## Operation: delete
None.
## Operation: modify
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `resourceCPU` | `integer > 0` | `НЕТ` | `` | Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро | Квота ядра пода (Указывается в mili). 1000Mili = 1 Ядро | minvalue=100; maxvalue=4000 | `172` |
| `resourceMemory` | `integer > 0` | `НЕТ` | `` | Квота памяти пода (MBytes) | Квота памяти пода (MBytes) | minvalue=128; maxvalue=8192 | `173` |
| `resourceDisk` | `integer > 0` | `НЕТ` | `1` | Квота диска (Указывается в GIGAbytes) | Квота диска (Указывается в GIGAbytes) | minvalue=1; maxvalue=999 | `174` |
## Operation: redeploy
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|---|---|---|---|---|---|---|---|
| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | | func=getAvailableResourceRealms | `277` |
## Operation: resume
None.
## Operation: suspend
None.