5.8 KiB
5.8 KiB
Operations for nubes_valoTenant
Service ID: 149
Service: VALO Cloud
UI description
Инструкция по развертыванию Тенант Valo через платформу
## 1. Общая информация
Тенант Valo — логический изолированный экземпляр сервиса VALO Cloud, предоставляющий защищённое облачное хранилище, синхронизацию данных и доступ к документам с различных устройств. При создании тенант автоматически разворачивается в тестовом режиме сроком на 2 месяца. Перевод в промышленную эксплуатацию выполняется отдельной операцией.
### Доступные операции
* create — создание нового тенанта в тестовом режиме сроком на 2 месяца.
* modify — изменение настроек тенанта, включая перевод из ТЕСТ в ПРОД.
* suspend — выключение (приостановка работы) тенанта.
* resume — включение ранее приостановленного тенанта.
* delete — удаление тенанта; доступно только после выполнения операции suspend.
---
## 2. Параметры развертывания
Параметры входных данных операции create:
### Платформа для развертывания
Описание: платформа, на которой будет создан тенант.
Пример значения: valo.ngcloud.ru.
### DNS-Префикс
Описание: Будет добавлено в зону valo.ngcloud.ru
Пример значения: mysimpledomain.
### Параметры хранилища
Описание: Сколько места будет выделено под использование в тенанте. Данные хранятся в S3. Размер указывается в Gigabytes
Пример значения: 10.
### Настройки тенанта
Описание: Ряд конфигурации Valo-тенанта, такие как настройки пользователя и доступного функционала
Пример значения: опционально в рамках настройки.
---
## 3. Рекомендованные характеристики
### Тестовое окружение
Достаточно развернуть тенант в ТЕСТ. Срок предоставляется в 2 месяца. По истечению срока тенант автоматически переводится в suspend на стороне ресурсной платформы
### Промышленное окружение
Для разблокировки используйте операцию modify
---
## 4. Выходные параметры
Услуга предоставляет следующие выходные параметры (формируются в процессе операций):
### Статус тенанта
Отражает текущее состояние и параметры.
---
## 5. Дополнительная информация
Тенант всегда создаётся в режиме ТЕСТ и не может быть сразу переведён в ПРОД без операции modify.
Удаление тенанта возможно только после его выключения с помощью операции suspend.
Срок тестового режима составляет 2 месяца с момента создания.
Операции suspend и resume используются для временного управления доступностью сервиса без потери конфигурации.
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 > 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 > 0 |
true |
`` | 660 |
`` | `` | `` | `` | `` | `` | false |
`` |
Operation: resume
Operation ID: 205
No parameters.
Operation: suspend
Operation ID: 204
No parameters.