BASIS/terraform-provider-decort
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 69 Wiki Activity

Updated 06.01.14 Data функция decort_vins_list получение информации о всех виртуальных сетях (markdown)

Касим
2022-12-26 12:15:12 +03:00
parent 808763880c
commit cb8ffd0806
1 changed files with 81 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
06.01.14-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md

@@ -1,10 +1,10 @@
Функция доступна в провайдере версии 2.3 и выше. Функция доступна в провайдере версии 3.1 и выше.
_Data source_ функция **decort_vins_list** служит для получения списка удаленных виртуальных сетей (Vins). _Data source_ функция **decort_k8s_list** служит для получения информации о списке кластеров Kubernetes (k8s).
## Аргументы ## Аргументы
_Data source_ функция **decort_vins_list** принимает следующие аргументы: _Data source_ функция **decort_k8s_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание | | Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| includedeleted | bool| :x: | Включить в результат удаленные балансировщики | | includedeleted | bool| :x: | Включить в результат удаленные балансировщики |
@@ -13,53 +13,105 @@ _Data source_ функция **decort_vins_list** принимает следу
## Возвращаемые значения ## Возвращаемые значения
В случае успешного выполнения data source функция decort_vins_list возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров: В случае успешного выполнения _data source_ функция **decort_k8s_list** возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание | | Параметр | Тип | Описание |
| --- | --- | --- | | --- | --- | --- |
| account_id | int | ID аккаунта - владельца виртуальной сети | | account_id | int | ID аккаунта |
| account_name | string | Имя аккаунта - владельца виртуальной | | account_name | string | Имя аккаунта |
| created_by | string | Информация о создателе виртуальной сети | | acl | []string | acl |
| created_time | int | Время создания виртуальной сети | | bservice_id | int | ID bservice |
| deleted_by | string | Информация о том, кто удалил виртуальную сеть | | ci_id | int | ID образа кластера |
| deleted_time | int | Время удаления виртуальной сети | | config | []string | Конфиг |
| external_ip | string | Внешний ip - адрес | | created_by | string | Кем был создан ресурс |
| vins_id | int | Идентификатор виртуальной сети | | created_time | int | Время создания ресурса |
| vins_name | string | Название виртуальной сети | | deleted_by | string | Кем был удален ресурс |
| network | string | Сеть | | deleted_time | int | Время удаления ресурса |
| rg_id | int | Идентификатор ресурсной группы | | desc | string | Описание ресурса |
| rg_name | string | Название ресурсной группы | | extnet_id | int | ID внешней сети |
| status | string | Статус виртуальной сети | | gid | int | Grid ID |
| updated_by | string | Кем виртуальная сеть была обновлена в последний раз | | guid | int | ID ресурса |
| updated_time | int | Время последнего обновления | | k8s_id | int | ID кластера |
| vxlan_id | int | Идентификатор vxlan | | lb_id | int | ID балансировщика нагрзуки |
| milestones | int | Milestones |
| k8s_name | string | Имя кластера k8s |
| rg_id | int | ID ресурсной группы |
| rg_name | string | Имя ресурсной группы |
| service_account | Struct{} [см. ниже](#Описание-структуры-service_account)| информация о аккаунте кластера |
| status | string | Статус ресурса |
| tech_status | string | Технический статус ресурса |
| updated_by | string | Кем был обновлен ресурс |
| updated_time | int | Время последнего обновления ресурса |
| vins_id | int | ID виртуальной сети |
| workers_groups | []Struct{} [см. ниже](#Описание-структуры-workers_groups)| группы воркеров кластера |
### Описание-структуры-service_account
| Параметр | Тип | Описание |
| --- | --- | --- |
| guid | int | ID ресурса |
| password | string | Пароль аккаунта |
| username | string | Username аккаунта |
### Описание-структуры-workers_groups
| Параметр | Тип | Описание |
| --- | --- | --- |
| annotations | []string | Аннотации группы workers |
| cpu | int | Кол-во cpu на компьютах workers |
| detailed_info | []Struct{} [см. ниже](#Описание-структуры-списка-detailed_info) | Детальная информация о группе |
| disk | int | ID диска |
| guid | string | ID ресурса |
| detailed_info_id | int | ID группы workers |
| labels | []string | Лейблы группы workers |
| name | string | Имя ресурса |
| num | int | Кол-во компьютов в группе workers |
| ram | int | Кол-во Ram на компьютах группы workers |
| taints | []string | огранечители группы workers |
### Описание структуры списка detailed_info
| Параметр | Тип | Описание |
| --- | --- | --- |
| compute_id | int | ID компьюта в составе группы |
| name | string | Имя компьюта в составе группы |
| status | string | Статус компьюта в составе группы |
| tech_status | string | Статус компьюта в составе группы |
| interfaces | []Struct{} [см. ниже](#Описание-структуры-списка-interfaces) | Список интерфейсов группы |
| natable_vins_ip | string | IP NAT |
| natable_vins_network | string | IP виртуальной сети |
### Описание структуры списка interfaces
| Параметр | Тип | Описание |
| --- | --- | --- |
| def_gw | string | Шлюз по умолчанию |
| ip_address | string | IP интерфейса |
## Пример использования ## Пример использования
Пример вызова _data source_ функции **decort_vins_list**: Пример вызова _data source_ функции **decort_k8s**:
```terraform ```terraform
data "decort_vins_list" "vins_list" { data "decort_k8s_list" "k8s_list" {
#включение удаленных vins в результат #включение удаленных k8s в результат
#опциональный параметр #опциональный параметр
#тип - будев тип #тип - будев тип
#если не задан - выводятся все неудаленные данные #если не задан - выводятся все неудаленные данные
#include_deleted = true include_deleted = true
#номер страницы для отображения #номер страницы для отображения
#опциональный параметр #опциональный параметр
#тип - число #тип - число
#если не задан - выводятся все доступные данные #если не задан - выводятся все доступные данные
#page = 1 page = 1
#размер страницы #размер страницы
#опциональный параметр #опциональный параметр
#тип - число #тип - число
#если не задан - выводятся все доступные данные #если не задан - выводятся все доступные данные
#size = 1 size = 1
} }
``` ```
После успешного завершения такого вызова **decort_vins_list** в переменной `data.decort_vins_list.vins_list` будут сохранены возвращаемые значения. После успешного завершения такого вызова **decort_k8s_list** в переменной `data.decort_k8s_list.k8s_list` будут сохранены возвращаемые значения.