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

Касим
2022-12-26 12:17:12 +03:00
parent cb8ffd0806
commit 08ffd7208f

@@ -1,10 +1,10 @@
Функция доступна в провайдере версии 3.1 и выше.
Функция доступна в провайдере версии 2.3 и выше.
_Data source_ функция **decort_k8s_list** служит для получения информации о списке кластеров Kubernetes (k8s).
_Data source_ функция **decort_vins_list** служит для получения списка удаленных виртуальных сетей (Vins).
## Аргументы
_Data source_ функция **decort_k8s_list** принимает следующие аргументы:
_Data source_ функция **decort_vins_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| includedeleted | bool| :x: | Включить в результат удаленные балансировщики |
@@ -13,105 +13,54 @@ _Data source_ функция **decort_k8s_list** принимает следую
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_k8s_list** возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров:
В случае успешного выполнения data source функция decort_vins_list возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | ID аккаунта |
| account_name | string | Имя аккаунта |
| acl | []string | acl |
| bservice_id | int | ID bservice |
| ci_id | int | ID образа кластера |
| config | []string | Конфиг |
| created_by | string | Кем был создан ресурс |
| created_time | int | Время создания ресурса |
| deleted_by | string | Кем был удален ресурс |
| deleted_time | int | Время удаления ресурса |
| desc | string | Описание ресурса |
| extnet_id | int | ID внешней сети |
| gid | int | Grid ID |
| guid | int | ID ресурса |
| k8s_id | int | ID кластера |
| 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 интерфейса |
| account_id | int | ID аккаунта - владельца виртуальной сети |
| account_name | string | Имя аккаунта - владельца виртуальной |
| created_by | string | Информация о создателе виртуальной сети |
| created_time | int | Время создания виртуальной сети |
| deleted_by | string | Информация о том, кто удалил виртуальную сеть |
| deleted_time | int | Время удаления виртуальной сети |
| external_ip | string | Внешний ip - адрес |
| vins_id | int | Идентификатор виртуальной сети |
| vins_name | string | Название виртуальной сети |
| network | string | Сеть |
| rg_id | int | Идентификатор ресурсной группы |
| rg_name | string | Название ресурсной группы |
| status | string | Статус виртуальной сети |
| updated_by | string | Кем виртуальная сеть была обновлена в последний раз |
| updated_time | int | Время последнего обновления |
| vxlan_id | int | Идентификатор vxlan |
## Пример использования
Пример вызова _data source_ функции **decort_k8s**:
Пример вызова _data source_ функции **decort_vins_list**:
```terraform
data "decort_k8s_list" "k8s_list" {
#включение удаленных k8s в результат
data "decort_vins_list" "vins_list" {
#включение удаленных vins в результат
#опциональный параметр
#тип - будев тип
#если не задан - выводятся все неудаленные данные
include_deleted = true
#include_deleted = true
#номер страницы для отображения
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
page = 1
#page = 1
#размер страницы
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
size = 1
#size = 1
}
```
После успешного завершения такого вызова **decort_k8s_list** в переменной `data.decort_k8s_list.k8s_list` будут сохранены возвращаемые значения.
После успешного завершения такого вызова **decort_vins_list** в переменной `data.decort_vins_list.vins_list` будут сохранены возвращаемые значения.