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,133 @@
+# Cloud Director Organization Service
+
+## Обнаружено из HAR: director.har
+Дата: 2026-01-23
+
+## Основная информация
+- **Service ID**: 19
+- **Service Name**: "Организация в Cloud Director" (Cloud Director Organization)
+- **Operation create ID**: 136
+
+## Параметры операции create
+
+### Параметр 418: Платформа для развертывания
+- **svcOperationCfsParamId**: 418
+- **Описание**: Платформа, на которой будет создана организация
+- **Пример значения**: "ngcloud.ru"
+- **Тип**: String
+- **Обязательный**: Да
+
+### Параметр 556: Тип организации
+- **svcOperationCfsParamId**: 556
+- **Описание**: Тип создаваемой организации
+- **Значения**:
+  - `iaas` - организация с прямым доступом к облаку и авторизацией через Keycloak
+  - `saas` - организация под управлением Nubes, без прямого доступа к облаку
+- **Тип**: String (enum)
+- **Обязательный**: Да
+- **Пример**: "iaas"
+
+## Архитектура
+
+Cloud Director Organization - корневая сущность для всей инфраструктуры:
+
+```
+Organization (serviceId=19)
+  └─ VDC - Virtual Data Center (serviceId=21)
+      └─ Edge Gateway (serviceId=22)
+          └─ vApp (serviceId=26)
+              └─ VM (serviceId=28)
+```
+
+## Типы организаций
+
+### IaaS (Infrastructure as a Service)
+- Прямой доступ к Cloud Director
+- Авторизация через Keycloak
+- Полный контроль над инфраструктурой
+- Рекомендуется для тестовых окружений
+
+### SaaS (Software as a Service)
+- Управляется Nubes
+- Без прямого доступа к облаку
+- Упрощённая модель использования
+- Рекомендуется для промышленных окружений
+
+## Операции
+
+### create (ID: 136)
+Создание новой организации с заданными характеристиками и типом доступа.
+
+**Параметры**:
+- 418: platform (ngcloud.ru)
+- 556: organizationType (iaas/saas)
+
+### delete
+Удаление организации после перехода в состояние suspend.
+- Возможно только через 14 дней после suspend
+- Удаляет все связанные сущности: VDC, Edge, vApp, VM
+
+### modify
+Изменение параметров организации (поддерживается изменение ipSpaces).
+
+### suspend
+Заморозка организации:
+- Не останавливает VM
+- Блокирует любые изменения инфраструктуры
+
+### resume
+Разморозка организации, восстановление функций управления.
+
+## Выходные параметры
+
+- **URL организации**: для быстрого доступа в тенант
+- **Статус организации**: текущее состояние и параметры
+
+## Зависимости
+
+Для конфигурации внешних IP внутри организации необходимо:
+1. Создать хотя бы один VDC, привязанный к организации
+2. Создать хотя бы один Edge Gateway, привязанный к VDC
+
+## Примечания
+
+- Для iaas-организаций доступ к Keycloak предоставляется пользователю, который создаёт услугу
+- Для saas-организаций доступ к Keycloak отсутствует
+- Удаление организации приводит к удалению всех связанных сущностей
+
+## Пример из HAR
+
+```json
+// POST /instances
+{
+  "serviceId": 19,
+  "displayName": "f12",
+  "descr": "for f12 record"
+}
+
+// POST /instanceOperations
+{
+  "instanceUid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "operation": "create"
+}
+
+// POST /instanceOperationCfsParams (для каждого параметра)
+{
+  "svcOperationCfsParamId": 418,
+  "paramValue": "ngcloud.ru",
+  "instanceOperationUid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}
+{
+  "svcOperationCfsParamId": 556,
+  "paramValue": "iaas",
+  "instanceOperationUid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}
+```
+
+## Ошибки
+
+Из лога операции UUID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx:
+- Этап "Работа с сервисом" завершился с ошибкой
+- Ошибка удаления: "Не удалось удалить организацию WZ01325-iaas. Ошибка: script returned exit code 1"
+- Операция выполнялась 70.322 секунды
+- Результат подтверждения: 201 (Created)