From bd0416585391896373d9c3339f2cf6e618760ac4 Mon Sep 17 00:00:00 2001 From: Tim Tkachev Date: Fri, 26 May 2023 17:16:05 +0300 Subject: [PATCH] added flipgroup info and fixed some pages --- ...-Terraform-провайдера-DECORT.md | 8 +- ...ии-о-плавающей-группе.md | 50 ++++++++++ ...и-о-плавающих-группах.md | 56 +++++++++++ ...ие-плавающей-группой.md | 98 +++++++++++++++++++ 4 files changed, 208 insertions(+), 4 deletions(-) create mode 100644 06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md create mode 100644 06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md create mode 100644 07.01.20-Resource-функция-decort_flipgroup-управление-плавающей-группой.md diff --git a/04.01-Установка-Terraform-провайдера-DECORT.md b/04.01-Установка-Terraform-провайдера-DECORT.md index 66c5d53..05ff959 100644 --- a/04.01-Установка-Terraform-провайдера-DECORT.md +++ b/04.01-Установка-Terraform-провайдера-DECORT.md @@ -35,7 +35,7 @@ terraform apply Terraform провайдер DECORT имеет скомпилированные релизные версии, которые расположены по адресу: [Релизы](https://github.com/rudecs/terraform-provider-decort/releases). Установка из релизов позволяет вместо скачивания провайдера из хранилища HashiCorp Terraform, скачать провайдер со страницы, указанной выше и установить его в ручном режиме. Чтобы выполнить установку из релиза, необходимо: -1. Перейти по адресу: https://github.com/rudecs/terraform-provider-decort/releases +1. Перейти по адресу: https://repository.basistech.ru/BASIS/terraform-provider-decort/releases 2. Выбрать необходимую версию провайдера подходящую под операционную систему. 3. Скачать архив. 4. Распаковать архив. @@ -61,7 +61,7 @@ Windows: terraform { required_providers { decort = { - version = "1.2" + version = "4.1.0" source = "digitalenergy.online/decort/decort" } } @@ -104,7 +104,7 @@ terraform init 2. Скачайте и установите terraform по ссылке: [https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started](https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started) 3. Склонируйте репозиторий с провайдером, выполнив команду: ```bash -git clone https://github.com/rudecs/terraform-provider-decort.git +git clone https://repository.basistech.ru/BASIS/terraform-provider-decort.git ``` 4. Перейдите в скачанную папку с провайдером и выполните команду ```bash @@ -136,7 +136,7 @@ Windows: terraform { required_providers { decort = { - version = "1.2" + version = "4.1.0" source = "digitalenergy.online/decort/decort" } } diff --git a/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md b/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md new file mode 100644 index 0000000..323890e --- /dev/null +++ b/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md @@ -0,0 +1,50 @@ +_Data source_ функция **decort_flipgroup** служит для получения информации о плавающей группе (флипгруппы) + +## Аргументы + +| Аргумент | Тип | Обязательный | Описание | +| -------- | --- | ------------ | -------- | +| flipgroup_id | int | :heavy_check_mark: | ID флипгруппы | + +## Возвращаемые значения + +| Параметр | Тип | Описание | +| ------------ | ------- | ------------------------------------------ | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| client_ids | []int | Список ID подключенных к группе клиентов | +| client_names | []string | Список имен подключенных клиентов | +| client_type | string | Тип клиентов, подключаемых к группе | +| conn_id | int | ID подключения | +| conn_type | string | Тип подключения | +| created_by | string | Кем создана группа | +| created_time | int | Время создания | +| default_gw | string | Шлюз по умолчанию | +| deleted_by | string | Кем удалена группа | +| deleted_time | int | Время удаления | +| desc | string | Описание группы | +| gid | int | Grid ID платформы | +| guid | int | ID флипгруппы на платформе (=flipgroup_id) | +| milestones | int | Веха | +| name | string | Наименование плавающей группы | +| net_id | int | ID сети | +| net_type | string | Тип сети (EXTNET/ViNS) | +| network | string | Сеть | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Наименование ресурсной группы | +| status | string | Статус плавающей группы | +| updated_by | string | Кем обновлена группа | +| updated_time | int | Время обновления | + +## Пример использования + +```terraform +data "decort_flipgroup" "fg" { + # ID плавающей группы + # Обязательный параметр + # int + flipgroup_id = 18 +} +``` + +После успешного завершения такого вызова **decort_flipgroup** в переменной `data.decort_flipgroup.fg` будут сохранены возвращаемые значения. diff --git a/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md b/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md new file mode 100644 index 0000000..98216b6 --- /dev/null +++ b/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md @@ -0,0 +1,56 @@ +_Data source_ функция **decort_flipgroup_list** служит для получения информации о плавающих группах (флипгруппах) + +## Аргументы + +| Аргумент | Тип | Обязательный | Описание | +| -------- | --- | ------------ | -------- | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения (в списке items) + +| Параметр | Тип | Описание | +| ------------ | ------- | ------------------------------------------ | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| client_ids | []int | Список ID подключенных к группе клиентов | +| client_names | []string | Список имен подключенных клиентов | +| client_type | string | Тип клиентов, подключаемых к группе | +| conn_id | int | ID подключения | +| conn_type | string | Тип подключения | +| created_by | string | Кем создана группа | +| created_time | int | Время создания | +| default_gw | string | Шлюз по умолчанию | +| deleted_by | string | Кем удалена группа | +| deleted_time | int | Время удаления | +| desc | string | Описание группы | +| gid | int | Grid ID платформы | +| guid | int | ID флипгруппы на платформе (=flipgroup_id) | +| milestones | int | Веха | +| name | string | Наименование плавающей группы | +| net_id | int | ID сети | +| net_type | string | Тип сети (EXTNET/ViNS) | +| network | string | Сеть | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Наименование ресурсной группы | +| status | string | Статус плавающей группы | +| updated_by | string | Кем обновлена группа | +| updated_time | int | Время обновления | + +## Пример использования + +```terraform +data "decort_flipgroup_list" "fg_list" { + # Номер страницы + # Опциональный параметр + # int + page = 0 + + # Размер страницы + # Опциональный параметр + # int + size = 0 +} +``` + +После успешного завершения такого вызова **decort_flipgroup_list** в переменной `data.decort_flipgroup_list.fg` будут сохранены возвращаемые значения. diff --git a/07.01.20-Resource-функция-decort_flipgroup-управление-плавающей-группой.md b/07.01.20-Resource-функция-decort_flipgroup-управление-плавающей-группой.md new file mode 100644 index 0000000..0d84ae6 --- /dev/null +++ b/07.01.20-Resource-функция-decort_flipgroup-управление-плавающей-группой.md @@ -0,0 +1,98 @@ +Функция доступна в провайдере версии 4.1.0 и выше. + +_Resource_ функция **decort_flipgroup** служит для управления плавающими группами (флипгруппами). Функция позволяет: +- Создать флипгруппу +- Удалить флипгруппу +- Добавить/удалить клиентов + +## Аргументы +_Resource_ функция **decort_flipgroup** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | :---: | --- | +| account_id | int | :heavy_check_mark: | ID аккаунта | +| name | string | :heavy_check_mark: | Название флипгруппы | +| net_type | string | :heavy_check_mark: | Тип сети, EXTNET или ViNS | +| net_id | int | :heavy_check_mark: | ID сети | +| client_type | string | :heavy_check_mark: | Тип клиента (в данный момент поддерживается только compute) | +| ip | string | :x: | IP для ассоциации с группой | +| client_ids | []int | :x: | Список ID клиентов группы | +| desc | string | :x: | Описание плавающей группы | + +## Возвращаемые значения + +| Параметр | Тип | Описание | +| ------------ | ------- | ------------------------------------------ | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| client_ids | []int | Список ID подключенных к группе клиентов | +| client_names | []string | Список имен подключенных клиентов | +| client_type | string | Тип клиентов, подключаемых к группе | +| conn_id | int | ID подключения | +| conn_type | string | Тип подключения | +| created_by | string | Кем создана группа | +| created_time | int | Время создания | +| default_gw | string | Шлюз по умолчанию | +| deleted_by | string | Кем удалена группа | +| deleted_time | int | Время удаления | +| desc | string | Описание группы | +| gid | int | Grid ID платформы | +| guid | int | ID флипгруппы на платформе (=flipgroup_id) | +| milestones | int | Веха | +| name | string | Наименование плавающей группы | +| net_id | int | ID сети | +| net_type | string | Тип сети (EXTNET/ViNS) | +| network | string | Сеть | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Наименование ресурсной группы | +| status | string | Статус плавающей группы | +| updated_by | string | Кем обновлена группа | +| updated_time | int | Время обновления | + +## Пример использования + +```terraform +resource "decort_flipgroup" "fg" { + # ID аккаунта + # Обязательный параметр + # int + account_id = 999 + + # Наименование Flipgroup + # Обязательный параметр + # string + name = "flipgroup_name" + + # Тип сети (EXTNET, ViNS) + # Обязательный параметр + # string + net_type = "EXTNET" + + # ID сети + # Обязательный параметр + # int + net_id = 13 + + # Тип клиентов (в данный момент поддерживается только тип 'compute') + # Обязательный параметр + # string + client_type = "compute" + + # IP-адрес + # Опциональный параметр + # string + ip = "127.0.0.1" + + # Список клиентов, прикрепленных к флипгруппе + # Опциональный параметр + # []int + client_ids = [11269] + + # Описание флипгруппы + # Опциональный параметр + # string + desc = "CHANGED" +} +``` + +После успешного завершения такого вызова **decort_flipgroup** в переменной `decort_flipgroup.fg` будут сохранены возвращаемые значения.