Create data source decort_sep_config page

stSolo
2022-05-04 14:13:33 +03:00
parent 5383b0de64
commit d154e46f90

@@ -0,0 +1,67 @@
Функция доступна в провайдере версии 2.2 и выше.
**Внимание:** необходимы права администратора.
_Data source_ функция **decort_sep_config** служит для получения информации о конфигурации переданного storage endpoint. Storage endpoint (sep) - точка доступа к хранилищу данных. Sep бывает четырех типов:
- des
- hitachi
- dorado
- tatlin
Каждый тип отличается возможной конфигурацией.
Конфигурация представляет собой json - объект, который можно сохранить в файл с расширением .json для дальнейшего использования.
## Аргументы
_Data source_ функция **decort_sep_config** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| sep_id | int | :heavy_check_mark: | ID storage endpoint |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_sep_config** возвращает в указанную при вызове переменную элемент который состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| sep_id | int | id storage endpoint |
| config | json string | Конфигурация sep |
## Пример использования
Пример вызова _data source_ функции **decort_sep_config**:
```terraform
data "decort_sep_config" "sc" {
sep_id = 1111
}
# once the above directive completes, sep will be accessible
# as data.decort_sep_config.sc
# and config will be accessible
# as data.decort_sep_config.sc.config
```
Данный пример подразумевает, что ранее по тексту 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_sep_config** в переменной `data.decort_sep_config.sc` будут сохранены возвращаемые значения.
Чтобы получить доступ к конфигурации и сохранить ее в файл .json, необходимо:
1. определить в .tf - файле дополнительный output с любым именем, в который запишется информация о конфигурации sep и обернуть ее в вызов функции jsondecode для декодирования информации.
```terraform
output "sep_config" {
value = jsondecode(data_sep_config.sc.config)
}
```
2. Применить изменения в терраформе.
```bash
terraform apply
```
3. Сохранить данные из output в .json - файл.
```bash
terraform output -json sep_config >> config.json
```
В общем случае это будет выглядеть как указано ниже.
```bash
terraform output -json <output-name> >> <file-name>.json
```