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,88 @@
+# Operations for nubes_k8sSthutrvalCluster
+
+Service ID: `150`
+
+Service: Kubernetes кластер Штурвал
+
+## UI description
+
+Перед разворачиванием убедиться, что в облаке есть 2 свободных невыделенных IP в пуле
+
+## Operations
+
+Non-CRUD operations are typically executed via an action resource.
+Domain operations (for example create_user, create_database) are best modeled as separate resources.
+
+- `create` (id: 108)
+- `delete` (id: 109)
+- `modify` (id: 110)
+- `reconcile` (id: 253)
+- `resume` (id: 174)
+- `suspend` (id: 173)
+- `update_secrets` (id: 179)
+
+## Operation: create
+
+Operation ID: `108`
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `nsxtUid` | `uuid` | `true` | `` | `344` | `22` | `` | `` | `` | `` | `` | `false` | `` |
+| `clusterName` | `string` | `true` | `example1` | `345` | `` | `` | `` | `(?=^.{1,63}$)^[a-z0-9]([a-z0-9-]*[a-z0-9])?$` | `` | `` | `false` | `` |
+| `controlPlaneSizingPolicy` | `string` | `true` | `` | `346` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `controlPlaneSizingDisk` | `integer &gt; 0` | `true` | `30` | `347` | `` | `` | `` | `` | `20` | `999` | `false` | `` |
+| `controlPlaneCount` | `integer &gt; 0` | `true` | `1` | `348` | `` | `` | `` | `` | `1` | `9` | `false` | `` |
+| `workersSizingPolicy` | `string` | `true` | `` | `349` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `workersSizingDisk` | `integer &gt; 0` | `true` | `40` | `350` | `` | `` | `` | `` | `20` | `999` | `false` | `` |
+| `workersCount` | `integer &gt; 0` | `true` | `2` | `351` | `` | `` | `` | `` | `1` | `99` | `false` | `` |
+| `appVersion` | `string` | `true` | `2.12.1` | `352` | `` | `2.12.1,2.11.0` | `` | `` | `` | `` | `false` | `` |
+| `needExternalAddressAPI` | `boolean` | `true` | `true` | `353` | `` | `true` | `` | `` | `` | `` | `false` | `` |
+| `accessIpListAPI` | `json` | `true` | `[]` | `354` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `needExternalAddressIngress` | `boolean` | `true` | `true` | `355` | `` | `true` | `` | `` | `` | `` | `false` | `` |
+| `accessIpListIngress` | `json` | `true` | `[]` | `356` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `vdcUid` | `uuid` | `true` | `` | `747` | `21` | `` | `` | `` | `` | `` | `false` | `` |
+
+## Operation: delete
+
+Operation ID: `109`
+
+No parameters.
+
+## Operation: modify
+
+Operation ID: `110`
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `controlPlaneCount` | `integer &gt; 0` | `false` | `` | `362` | `` | `` | `` | `` | `1` | `9` | `false` | `` |
+| `workersCount` | `integer &gt; 0` | `false` | `` | `363` | `` | `` | `` | `` | `1` | `99` | `false` | `` |
+| `accessIpListAPI` | `json` | `false` | `` | `364` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `accessIpListIngress` | `json` | `false` | `` | `365` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `appVersion` | `string` | `false` | `` | `563` | `` | `2.11.0,2.12.1` | `` | `` | `` | `` | `false` | `` |
+| `controlPlaneSizingDisk` | `integer &gt; 0` | `true` | `` | `637` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `workersSizingDisk` | `integer &gt; 0` | `true` | `` | `638` | `` | `` | `` | `` | `` | `` | `false` | `` |
+
+## Operation: reconcile
+
+Operation ID: `253`
+
+No parameters.
+
+## Operation: resume
+
+Operation ID: `174`
+
+No parameters.
+
+## Operation: suspend
+
+Operation ID: `173`
+
+No parameters.
+
+## Operation: update_secrets
+
+Operation ID: `179`
+
+No parameters.
+