Updated 06.01.49 Data функция decort_k8s_wg_list получение информации о списке групп воркеров кластера k8s (markdown)

Касим
2022-12-22 17:49:01 +03:00
parent 67d6bff7b7
commit 5b95168898

@@ -1 +1,69 @@
decort_k8s_wg_list Функция доступна в провайдере версии 3.1 и выше.
_Data source_ функция **decort_k8s_wg_list** служит для получения информации о списке групп воркеров кластера Kubernetes (k8s).
## Аргументы
_Data source_ функция **decort_k8s_wg_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| k8s_id | int | :heavy_check_mark: | ID кластера |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_k8s_wg_list** возвращает следующие параметры:
| Параметр | Тип | Описание |
| --- | --- | --- |
| items | []Struct{} [см. ниже](#Описание-структуры-items) | Список кластеров k8s |
### Описание структуры items
| Параметр | Тип | Описание |
| --- | --- | --- |
| name | string | Имя группы воркеров |
| num | int | кол-во компьютов в ресурсе |
| cpu | int | Кол-во cpu на нодах |
| ram | int | Кол-во ram на нодах |
| disk | int | ID диска |
| detailed_info | []Struct{} [см. ниже](#Описание-структуры-списка-detailed_info) | Детальная информация masters |
| labels | []string | Лейблы ресурса |
| wg_id | int | ID группы воркеров кластера |
| guid | int | ID ресурса |
| annotations | []string | Аннотации ресурса |
| 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_k8s_wg_list**:
```terraform
data "decort_k8s_wg_list" "k8s_wg_list" {
#id кластера
#обязательный параметр
#тип - число
k8s_id = 49304
}
```
После успешного завершения такого вызова **decort_k8s_wg_list** в переменной `data.decort_k8s_wg_list.k8s_wg_list` будут сохранены возвращаемые значения.