Create resource decort_bservice page

stSolo
2022-06-07 13:26:18 +03:00
parent 5f7009f81e
commit 1bc725bd52

@@ -0,0 +1,98 @@
Функция доступна в провайдере версии 2.3 и выше.
_Resource_ функция **decort_bservice** служит для управления базовым сервисом (basic service). Базовый сервис служит шаблоном для создания вычислительных мощностей (computes) по заданным правилам.
## Аргументы
_Resource_ функция **decort_bservice** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | :---: | --- |
| service_name | string | :heavy_check_mark: | Название сервиса<br/>Используется при создании сервиса |
| rg_id | int | :heavy_check_mark: | ID ресурсной группы<br/>Используется при создании сервиса |
| ssh_key | string | :x: | Ключ пользователя для подключения по ssh<br/>Используется при создании сервиса |
| ssh_user | string | :x: | Имя пользователя для подключения по ssh<br/>Используется при создании сервиса |
| enable | bool | :x: | Флаг доступности<br/>Используется при редактировании сервиса<br/>По-умолчанию: false |
| start | bool | :x: | Флаг старта/остановки сервиса<br/>Используется при редактировании<br/>По-умолчанию: false |
| snapshots | Struct{<br/>label string<br/>rollback bool <br/>} | :x: | Снимки состояния сервиса<br/>Название снимка. Обязательное поле для создания снимка<br/>Восстановление по этому снимку. true - для активации<br/>&nbsp;<br/>&nbsp;<br/> |
| restore | bool | :x: | Флаг восстановления сервиса<br/>Используется при редактировании<br/>По-умолчанию: true |
| permanently | bool | :x: | Флаг моментального удаления сервиса<br/>Если true - сервис и все его зависимости мгновенно удаляется из платформы без возможности восстановления<br/>Если false - сервис попадает в "корзину", из которой его можно восстановить<br/>Используется при удалении<br/>По-умолчанию: false |
| service_id | int | :x: | ID сервиса, позволяет сформировать .tfstate, если сервис есть в платформе. В таким случае, все обязательные поля будут проигнорированы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_bservice** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | ID аккаунта |
| account_name | string | Название аккаунта |
| base_domain | string | Базовый домен |
| computes | []Struct{<br/>compgroup_id int<br/>compgroup_name string<br/>compgroup_role string<br/>id int<br/>name string<br/>} | Вычислительные мощности<br/>ID вычислительной группы<br/>Название вычислительной группы<br/>Роль (тег) вычислительной группы<br/>ID вычислительной мощности<br/>Название вычислительной мощности<br/>&nbsp;<br/> |
| cpu_total | int | Кол-во ядер |
| created_by | string | Кем создан сервис |
| created_time | int | Время создания сервиса |
| deleted_by | string | Кем удален сервис |
| deleted_time | int | Время удаления сервиса |
| disk_total | int | Кол-во используемого места на дисках, ГБ |
| gid | int | Grid id |
| groups | []int | Список ID вычислительных групп сервиса |
| groups_name | []string | Список вычислительных групп поименно |
| guid | int | Внутренний ID сервиса |
| milestones | int | Вехи |
| service_id | int | ID сервиса |
| service_name | string | Название сервиса |
| parent_srv_id | int | ID родительского сервисе |
| parent_srv_name | string | Название родительского сервиса |
| ram_total | int | Общее кол-во RAM, МБ |
| rg_id | int | ID ресурсной группы |
| rg_name | string | Название ресурсной группы |
| snapshots | []Struct{<br/>guid string<br/>label string<br/>timestamp int<br/>valid bool<br/>} | Список снимков состояний<br/>guid снимка<br/>Название снимка<br/>Время создания снимка<br/>Флаг, валидность снимка состояния<br/>&nbsp;<br/> |
| ssh_key | string | Ключ пользователя для подключения по ssh |
| ssh_user | string | Имя пользователя для подключения по ssh |
| status | string | Статус сервиса |
| tech_status | string | Технический статус сервиса |
| updated_by | string | Кем сервис был обновлен |
| updated_time | int | Время последнего обновления |
| user_managed | bool | Флаг, управляется ли пользователем |
## Пример использования
Пример вызова _resource_ функции **decort_bservice**:
```terraform
resource "decort_bservice" "b" {
service_name = "my_test_bservice_sn"
rg_id = 11111
#enable = true
#снимок состояния
#может быть несколько в ресурсе
/*
snapshots {
#имя снимка состояния
#обязательный параметр
#тип - строка
label = "test_snapshot"
#восстановление сервиса из снимка состояния
#необязательный параметр
#тип - булев тип
#по-умолчанию - false
#восстановление происходит только при переключении с false на true
rollback = false
}
snapshots {
label = "test_snapshot_1"
}
*/
#start = false
#restore = true
#permanently = true
#service_id = 11111
}
# once the above directive completes, bservice will be accessible
# as decort_bservice.b
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
После успешного завершения такого вызова **decort_bservice** в переменной `decort_bservice.b` будут сохранены возвращаемые значения.