name: valo_tenant
service_id: 149
service_display_name: VALO Cloud
service_short_name: valoTenant
service_man: '# Инструкция по развертыванию Тенант 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 используются для временного управления доступностью сервиса без потери конфигурации.
'
lifecycle:
suspendOnDestroyDefault: true
adoptExistingOnCreateDefault: false
operations:
- svcOperationId: 202
operation: create
kind: instance
action: create
- svcOperationId: 206
operation: delete
kind: instance
action: delete
- svcOperationId: 203
operation: modify
kind: instance
action: modify
- svcOperationId: 205
operation: resume
kind: instance
action: resume
- svcOperationId: 204
operation: suspend
kind: instance
action: suspend
stateOut: {}
cfsParams:
- svcOperationCfsParamId: 655
svcOperationCfsParam: resourceRealm
dataType: string
isRequired: true
defaultValue: valo.ngcloud.ru
isModifiable: false
valueList:
- valo.ngcloud.ru
- svcOperationCfsParamId: 656
svcOperationCfsParam: domain
dataType: string
isRequired: true
defaultValue: ''
isModifiable: false
- svcOperationCfsParamId: 657
svcOperationCfsParam: valoOptions
dataType: map-fixed
isRequired: true
defaultValue: '{}'
isModifiable: true
dataDescriptor:
ffLogging:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
userCount:
dataType: integer > 0
defaultValue: '10'
isRequired: true
isModifiable: false
requestApproveMaxPeriod:
dataType: integer > 0
defaultValue: '2'
isRequired: true
isModifiable: false
ffOnlineEditor:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffWatermark:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffUserImport:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffThemes:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffPublicLink:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
- svcOperationCfsParamId: 658
svcOperationCfsParam: s3Storage
dataType: integer > 0
isRequired: true
defaultValue: '10'
isModifiable: true
- svcOperationCfsParamId: 659
svcOperationCfsParam: valoOptions
dataType: map-fixed
isRequired: true
defaultValue: ''
isModifiable: true
dataDescriptor:
requestApproveMaxPeriod:
dataType: integer > 0
defaultValue: ''
isRequired: true
isModifiable: false
ffOnlineEditor:
dataType: boolean
defaultValue: ''
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffWatermark:
dataType: boolean
defaultValue: ''
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffUserImport:
dataType: boolean
defaultValue: ''
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffThemes:
dataType: boolean
defaultValue: ''
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffPublicLink:
dataType: boolean
defaultValue: ''
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
ffLogging:
dataType: boolean
defaultValue: 'true'
isRequired: true
isModifiable: false
valueList:
- 'false'
- 'true'
userCount:
dataType: integer > 0
defaultValue: ''
isRequired: true
isModifiable: false
- svcOperationCfsParamId: 660
svcOperationCfsParam: s3Storage
dataType: integer > 0
isRequired: true
defaultValue: ''
isModifiable: true
cfsParamsByOp:
202:
- 655
- 656
- 657
- 658
206: []
203:
- 659
- 660
205: []
204: []
stateParams:
resourceRealm: valo.ngcloud.ru
domain: ''
valoOptions: '{"ffLogging": true, "userCount": 10, "requestApproveMaxPeriod": 2, "ffOnlineEditor": true, "ffWatermark": true, "ffUserImport": true, "ffThemes": true, "ffPublicLink": true}'
s3Storage: '10'