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,61 @@
+# Operations for nubes_vcVdcGroup
+
+Service ID: `29`
+
+Service: Группа датацентров
+
+## UI description
+
+# Инструкция по развертыванию Группа виртуальных датацентров (groupvDC) через платформу<br/><br/>## 1. Общая информация<br/><br/>Сервис **Группа виртуальных датацентров (groupvDC)** предназначен для логического объединения нескольких виртуальных датацентров (vDC) в единую группу. Это позволяет растягивать SDN между разными vDC и централизованно управлять сетевой связностью. Управление инфраструктурой осуществляется через Cloud Director.<br/>Сервис применяется в случаях, когда требуется обеспечить единое сетевое пространство для распределенных виртуальных датацентров.<br/><br/>### Доступные операции<br/><br/>**create** — Создание новой группы виртуальных датацентров.<br/>**delete** — Удаление существующей группы vDC.<br/>**add_vdc** — Добавление дополнительного виртуального датацентра в группу.<br/>**remove_vdc** — Удаление ранее добавленного виртуального датацентра из группы.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры операции **create**:<br/><br/>### UUID VDC<br/>Идентификатор виртуального датацентра, который будет являться первичным в группе.<br/>Описание: требуется предварительно создать виртуальный датацентр с помощью услуги `Виртуальный датацентр (vDC)`.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>- Для тестового окружения создавать группу VDC нет необходимости, так как это создаёт дополнительный слой абстракции в Cloud Director<br/><br/>### Промышленное окружение<br/>- Для промышленного окружения, если в тенанте существуют разные VDC, создание groupvdc позволит снизить сетевые издержки (за счёт общей сети)<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>### Параметры groupvdc<br/>Набор параметров, указанных пользователем при создании<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>- Группа vDC используется для растягивания SDN между несколькими виртуальными датацентрами. Управление всеми сетевыми элементами внутри группы выполняется Cloud Director.<br/>- Удалить первичный vDC (тот, что был указан при операции **create**) невозможно. Для его удаления необходимо удалить всю группу и создать новую.<br/>- Перед добавлением любого vDC в группу он должен быть предварительно развернут через сервис `Виртуальный датацентр (vDC)`.<br/>- Сети создаются не в этой услуге, а в услуге `Сетевой шлюз периметра (Edge)`. В ней необходимо будет выбрать тип `groupvdc`
+
+## 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.
+
+- `add_vdc` (id: 192)
+- `create` (id: 191)
+- `delete` (id: 195)
+- `reconcile` (id: 251)
+- `remove_vdc` (id: 193)
+
+## Operation: add_vdc
+
+Operation ID: `192`
+
+**Не нужно** выбирать UUID VDC, который уже был добавлен в группу
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `vdcUid` | `uuid` | `true` | `` | `619` | `21` | `` | `` | `` | `` | `` | `false` | `` |
+
+## Operation: create
+
+Operation ID: `191`
+
+**VDC Группа** нужна для объединения всех VDC в организации в одну логическую группу.<br/>Это позволит, к примеру, создать **общую сеть** для всех VDC в организации<br/><br/>- Для создания группы VDC необходимо указать **инстанс** услуги VDC (`Виртуальный датацентр`)<br/>- **Важный момент** - удалить эту VDC из группы нельзя. Если такая потребность появится, необходимо будет **ПОЛНОСТЬЮ** удалить группу VDC и уже потом создать новую
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `vdcUid` | `uuid` | `true` | `` | `618` | `21` | `` | `` | `` | `` | `` | `false` | `` |
+
+## Operation: delete
+
+Operation ID: `195`
+
+No parameters.
+
+## Operation: reconcile
+
+Operation ID: `251`
+
+No parameters.
+
+## Operation: remove_vdc
+
+Operation ID: `193`
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `vdcName` | `string` | `true` | `` | `620` | `` | `` | `` | `` | `` | `` | `false` | `` |
+