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 for nubes_valoTenant
+
+Service ID: `149`
+
+Service: VALO Cloud
+
+## UI description
+
+# Инструкция по развертыванию Тенант Valo через платформу<br/><br/>## 1. Общая информация<br/>Тенант Valo — логический изолированный экземпляр сервиса VALO Cloud, предоставляющий защищённое облачное хранилище, синхронизацию данных и доступ к документам с различных устройств. При создании тенант автоматически разворачивается в тестовом режиме сроком на 2 месяца. Перевод в промышленную эксплуатацию выполняется отдельной операцией.<br/><br/>### Доступные операции<br/><br/>* **create** — создание нового тенанта в тестовом режиме сроком на 2 месяца.<br/>* **modify** — изменение настроек тенанта, включая перевод из ТЕСТ в ПРОД.<br/>* **suspend** — выключение (приостановка работы) тенанта.<br/>* **resume** — включение ранее приостановленного тенанта.<br/>* **delete** — удаление тенанта; доступно только после выполнения операции suspend.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: платформа, на которой будет создан тенант.<br/>Пример значения: `valo.ngcloud.ru`.<br/><br/>### DNS-Префикс<br/>Описание: Будет добавлено в зону valo.ngcloud.ru<br/>Пример значения: `mysimpledomain`.<br/><br/>### Параметры хранилища<br/>Описание: Сколько места будет выделено под использование в тенанте. Данные хранятся в S3. Размер указывается в Gigabytes<br/>Пример значения: `10`.<br/><br/>### Настройки тенанта<br/>Описание: Ряд конфигурации Valo-тенанта, такие как настройки пользователя и доступного функционала<br/>Пример значения: `опционально в рамках настройки`.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>Достаточно развернуть тенант в ТЕСТ. Срок предоставляется в 2 месяца. По истечению срока тенант автоматически переводится в `suspend` на стороне ресурсной платформы<br/><br/>### Промышленное окружение<br/>Для разблокировки используйте операцию `modify`<br/><br/>---<br/><br/>## 4. Выходные параметры<br/><br/>Услуга предоставляет следующие выходные параметры (формируются в процессе операций):<br/><br/>### Статус тенанта<br/>Отражает текущее состояние и параметры.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>Тенант всегда создаётся в режиме ТЕСТ и не может быть сразу переведён в ПРОД без операции modify.<br/>Удаление тенанта возможно только после его выключения с помощью операции suspend.<br/>Срок тестового режима составляет 2 месяца с момента создания.<br/>Операции suspend и resume используются для временного управления доступностью сервиса без потери конфигурации.<br/>
+
+## 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: 202)
+- `delete` (id: 206)
+- `modify` (id: 203)
+- `resume` (id: 205)
+- `suspend` (id: 204)
+
+## Operation: create
+
+Operation ID: `202`
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `resourceRealm` | `string` | `true` | `` | `655` | `` | `` | `getAvailableResourceRealms` | `` | `` | `` | `false` | `` |
+| `domain` | `string` | `true` | `` | `656` | `` | `` | `` | `^[a-z0-9](?:[a-z0-9-]{3,61}[a-z0-9])?$` | `` | `` | `false` | `` |
+| `valoOptions` | `map-fixed` | `true` | `{}` | `657` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `s3Storage` | `integer &gt; 0` | `true` | `10` | `658` | `` | `` | `` | `` | `1` | `999` | `false` | `` |
+
+## Operation: delete
+
+Operation ID: `206`
+
+No parameters.
+
+## Operation: modify
+
+Operation ID: `203`
+
+| Code | Type | Required | Default | ID | RefSvcId | ValueList | Func | Regex | Min | Max | Sensitive | DependsOn |
+|---|---|---|---|---|---|---|---|---|---|---|---|---|
+| `valoOptions` | `map-fixed` | `true` | `` | `659` | `` | `` | `` | `` | `` | `` | `false` | `` |
+| `s3Storage` | `integer &gt; 0` | `true` | `` | `660` | `` | `` | `` | `` | `` | `` | `false` | `` |
+
+## Operation: resume
+
+Operation ID: `205`
+
+No parameters.
+
+## Operation: suspend
+
+Operation ID: `204`
+
+No parameters.
+