add: documentation
This commit is contained in:
@@ -0,0 +1,22 @@
|
||||
# Operations: nubes_superset
|
||||
|
||||
| Operation | Kind | Action | Subresource | ID | Params | Description |
|
||||
|---|---|---|---|---|---|---|
|
||||
| `create` | `instance` | `create` | `` | `12` | domain, emails, resourceCPU, resourceMemory, resourceDisk, resourceRealm, resourceInstances | DEV-Ветка сборки Superset |
|
||||
| `delete` | `instance` | `delete` | `` | `13` | | DEV-Ветка удаления Superset |
|
||||
|
||||
## 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])?$ | `14` |
|
||||
| `emails` | `string` | `ДА` | `testuser1` | Учётная запись, которой будут выданы админские права. В формате email [ну не совсем. Для доменных учетных записей - без доменного суффикса]. Обязана находиться в Keycloak. Можно передавать несколько через пробел | Учётная запись, которой будут выданы админские права. В формате email [ну не совсем. Для доменных учетных записей - без доменного суффикса]. Обязана находиться в Keycloak. Можно передавать несколько через пробел | | `20` |
|
||||
| `resourceCPU` | `integer > 0` | `ДА` | `500` | Квота ядра пода (Указывается в mili). 1000 Mili = 1 ядро | Квота ядра пода (Указывается в mili). 1000 Mili = 1 ядро | minvalue=100; maxvalue=4000 | `96` |
|
||||
| `resourceMemory` | `integer > 0` | `ДА` | `512` | Квота памяти пода (Указывается в Megabytes) | Квота памяти пода (Указывается в Megabytes) | minvalue=128; maxvalue=8192 | `97` |
|
||||
| `resourceDisk` | `integer > 0` | `ДА` | `1` | Квота диска (Указывается в GIGAbytes) | Квота диска (Указывается в GIGAbytes) | minvalue=1; maxvalue=999 | `98` |
|
||||
| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | Наименование кластера Kubernetes для подключения | func=getAvailableResourceRealms | `109` |
|
||||
| `resourceInstances` | `integer > 0` | `ДА` | `1` | Количество узлов | | minvalue=1; maxvalue=7 | `227` |
|
||||
|
||||
## Operation: delete
|
||||
|
||||
None.
|
||||
Reference in New Issue
Block a user