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,59 @@
+# Operations: nubes_lucee
+
+| Operation | Kind | Action | Subresource | ID | Params | Description |
+|---|---|---|---|---|---|---|
+| `create` | `instance` | `create` | `` | `49` | domain, gitPath, jsonEnv, resourceCPU, resourceMemory, resourceRealm, healthPath, resourceInstances, appVersion |  |
+| `delete` | `instance` | `delete` | `` | `50` |  |  |
+| `modify` | `instance` | `modify` | `` | `55` | gitPath, healthPath, jsonEnv, resourceCPU, resourceMemory, resourceInstances, appVersion | Если CFS оставить пустым, то при запуске джобы берётся параметр из instanceData |
+| `redeploy` | `action` | `redeploy` | `` | `53` | resourceRealm |  |
+| `restart` | `action` | `restart` | `` | `163` |  |  |
+| `resume` | `instance` | `resume` | `` | `95` |  |  |
+| `suspend` | `instance` | `suspend` | `` | `96` |  |  |
+
+## 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 | `103` |
+| `gitPath` | `string` | `ДА` | `https://github.com/xahys/testlucee` | Путь до Git, который будет webroot для сайта | Путь до Git, который будет webroot для сайта |  | `104` |
+| `jsonEnv` | `json` | `НЕТ` | `{ "param": "value" }` | Здесь вы можете задать переменные среды в формате KEY=VALUE. Они будут доступны внутри вашего приложения. |  | maxlength=2048 | `105` |
+| `resourceCPU` | `integer &gt; 0` | `ДА` | `300` | Квота ядра пода (milicores) | Квота ядра пода (milicores) | minvalue=100; maxvalue=4000 | `106` |
+| `resourceMemory` | `integer &gt; 0` | `ДА` | `512` | Квота памяти пода (MBytes) | Квота памяти пода (MBytes) | minvalue=128; maxvalue=8192 | `107` |
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | Наименование кластера Kubernetes для подключения | func=getAvailableResourceRealms | `108` |
+| `healthPath` | `string` | `НЕТ` | `` | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код |  | `132` |
+| `resourceInstances` | `integer &gt; 0` | `ДА` | `1` | Количество узлов | Количество узлов в сети | minvalue=1; maxvalue=7 | `139` |
+| `appVersion` | `string` | `ДА` | `5.4` | Версия Lucee |  | regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0 | `263` |
+
+## Operation: delete
+
+None.
+
+## Operation: modify
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `gitPath` | `string` | `НЕТ` | `` | Путь до Git, который будет webroot для сайта | Путь до Git, который будет webroot для сайта |  | `133` |
+| `healthPath` | `string` | `НЕТ` | `` | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. | Путь до healtcheck для запуска пода в Kubernetes, который отдаст 200 код. |  | `134` |
+| `jsonEnv` | `json` | `НЕТ` | `` | Массив переменных, будут переданы в env приложения | Массив переменных, будут переданы в env приложения | maxlength=2048 | `135` |
+| `resourceCPU` | `integer &gt; 0` | `НЕТ` | `` | Квота ядра пода (Указывается в mili) 1000Mili = 1 ядро | Квота ядра пода (Указывается в mili) | minvalue=100; maxvalue=4000 | `136` |
+| `resourceMemory` | `integer &gt; 0` | `НЕТ` | `` | Квота памяти пода (Указывается в Megabytes) | Квота памяти пода (Указывается в Megabytes) | minvalue=128; maxvalue=8192 | `137` |
+| `resourceInstances` | `integer &gt; 0` | `НЕТ` | `` | Количество узлов | Количество узлов в сети | minvalue=1; maxvalue=7 | `138` |
+| `appVersion` | `string` | `ДА` | `5.4` |  |  | regex=^\d+(\.\d+){1,2}(-[a-zA-Z0-9\.]+)?$; value_list=5.4, 6.0 | `264` |
+
+## Operation: redeploy
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания |  | func=getAvailableResourceRealms | `257` |
+
+## Operation: restart
+
+None.
+
+## Operation: resume
+
+None.
+
+## Operation: suspend
+
+None.