add: documentation
This commit is contained in:
@@ -0,0 +1,48 @@
|
||||
# Operations: nubes_http
|
||||
|
||||
| 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` | | |
|
||||
|
||||
## 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 | `212` |
|
||||
| `resourceCPU` | `integer > 0` | `ДА` | `100` | Квота ядра пода (Указывается в mili) | Квота ядра пода (Указывается в mili) | minvalue=100; maxvalue=4000 | `213` |
|
||||
| `resourceMemory` | `integer > 0` | `ДА` | `200` | Квота памяти пода (Указывается в Megabytes) | Квота памяти пода (Указывается в Megabytes) | minvalue=128; maxvalue=8192 | `214` |
|
||||
| `resourceInstances` | `integer > 0` | `ДА` | `1` | Количество узлов | Количество реплик приложения. Трафик будет распределяться между подами в режиме Round-Robin | minvalue=1; maxvalue=7 | `215` |
|
||||
| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | Наименование кластера Kubernetes для подключения | func=getAvailableResourceRealms | `216` |
|
||||
| `registryPath` | `string` | `ДА` | `nexus-sa.tst.nubes.ru/docker-nubes/jolt` | Путь до image, который будет установлен как deployment | Путь до image, который будет установлен как deployment | | `217` |
|
||||
| `jsonEnv` | `json` | `НЕТ` | `{"param": "value"}` | Массив переменных, будут переданы в env приложения | Массив переменных, будут переданы в env приложения | | `241` |
|
||||
|
||||
## Operation: delete
|
||||
|
||||
None.
|
||||
|
||||
## Operation: modify
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `resourceCPU` | `integer > 0` | `ДА` | `` | | | minvalue=100; maxvalue=4000 | `218` |
|
||||
| `resourceMemory` | `integer > 0` | `ДА` | `` | | | minvalue=128; maxvalue=8192 | `219` |
|
||||
| `resourceInstances` | `integer > 0` | `ДА` | `` | Количество узлов | | minvalue=1; maxvalue=7 | `220` |
|
||||
|
||||
## Operation: redeploy
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | | func=getAvailableResourceRealms | `272` |
|
||||
|
||||
## Operation: resume
|
||||
|
||||
None.
|
||||
|
||||
## Operation: suspend
|
||||
|
||||
None.
|
||||
Reference in New Issue
Block a user