From 5868deb4c454ae80439d826778f6c771cd4119ad Mon Sep 17 00:00:00 2001 From: loskutovanl Date: Fri, 24 Nov 2023 17:01:05 +0300 Subject: [PATCH] add k8s data sources --- ...ормации-о-кластере-k8s.md | 143 ++++++++++++++++++ ...ных-машинах-кластера.md | 49 ++++++ ...-о-списке-кластеров-k8s.md | 98 ++++++++++++ ...даленных-кластеров-k8s.md | 117 ++++++++++++++ ...-воркеров-кластера-k8s.md | 70 +++++++++ ...керов-кластера-Kubernetes.md | 41 +++++ ...-воркеров-кластера-k8s.md | 63 ++++++++ Home.md | 7 + 8 files changed, 588 insertions(+) create mode 100644 06.02.72-Data-функция-decort_cb_k8s-получение-информации-о-кластере-k8s.md create mode 100644 06.02.73-Data-функция-decort_cb_k8s_computes-получение-информации-о-виртуальных-машинах-кластера.md create mode 100644 06.02.74-Data-функция-decort_cb_k8s_list-получение-информации-о-списке-кластеров-k8s.md create mode 100644 06.02.75-Data-функция-decort_cb_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md create mode 100644 06.02.76-Data-функция-decort_cb_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s.md create mode 100644 06.02.77-Data-функция-decort_cb_k8s_wg_cloud_init-получение-информации-об-предустановленных-настройках-группы-воркеров-кластера-Kubernetes.md create mode 100644 06.02.78-Data-функция-decort_cb_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s.md diff --git a/06.02.72-Data-функция-decort_cb_k8s-получение-информации-о-кластере-k8s.md b/06.02.72-Data-функция-decort_cb_k8s-получение-информации-о-кластере-k8s.md new file mode 100644 index 0000000..52d5f61 --- /dev/null +++ b/06.02.72-Data-функция-decort_cb_k8s-получение-информации-о-кластере-k8s.md @@ -0,0 +1,143 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s** служит для получения информации о кластере Kubernetes (k8s). Кластер позволяет построить распределенную отказоустойчивую систему. + +## Аргументы + +_Data source_ функция **decort_cb_k8s** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| k8s_id | int | :heavy_check_mark: | ID кластера | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_k8s** возвращает следующие параметры: + +| Параметр | Тип | Описание | +| --- | --- |-------------------------------------| +| acl | Struct{} [см. ниже](#описание-структуры-acl) | acl | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| bservice_id | int | ID bservice | +| k8sci_id | int | ID образа кластера | +| 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_ci_name | string | Имя образа кластера | +|k8s_groups| []Struct{} [см. ниже](#описание-структуры-k8s_groups) | Стурктура компьютов | +| kubeconfig | string | Конфиг | +| lb_id | int | ID балансировщика нагрузки | +| milestones | int | Вехи | +| lb_ip | string | IP балансировщика нагрузки | +| name | string | Имя ресурса | +| network_plugin | string | Сетевой плагин | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| service_account | Struct{} [см. ниже](#описание-структуры-service_account)| информация о аккаунте кластера | +| ssh_key | string | Публичный SSH ключ | +| status | string | Статус ресурса | +| tech_status | string | Технический статус ресурса | +| updated_by | string | Кем был обновлен ресурс | +| updated_time | int | Время последнего обновления ресурса | +| vins_id | int | ID виртуальной сети | + +### Описание структуры service_account + +| Параметр | Тип | Описание | +| --- |--------| --- | +| guid | string | ID ресурса | +| password | string | Пароль аккаунта | +| username | string | Username аккаунта | + +### Описание структуры acl + +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_acl | []Struct{} [см. ниже](#описание-структуры-списка-acl) | account_acl | +| k8s_acl| []Struct{} [см. ниже](#описание-структуры-списка-acl) | k8s_acl | +| rg_acl | []Struct{} [см. ниже](#описание-структуры-списка-acl) | rg_acl | + +### Описание структуры списка acl + +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | explicit | +| guid | string | ID ресурса | +| right | string | right | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID группы | + +### Описание структуры k8s_groups + +| Параметр | Тип | Описание | +| --- | --- | --- | +| masters | []Struct{} [см. ниже](#описание-структуры-masters) | Структура компьютов мастеров | +| workers | []Struct{} [см. ниже](#описание-структуры-workers) | Структура компьютов воркеров | + +### Описание структуры masters + +| Параметр | Тип | Описание | +| --- | --- | --- | +| cpu | int | Кол-во cpu на компьютах master | +| detailed_info | []Struct{} [см. ниже](#описание-структуры-списка-detailed_info) | Детальная информация masters | +| disk | int | ID диска | +| master_id | int | ID группы master | +| name | string | Имя группы master | +| num | int | Кол-во компьютов в группе master | +| ram | int | Кол-во Ram на компьютах группы master| + +### Описание структуры workers + +| Параметр | Тип | Описание | +| --- | --- | --- | +| annotations | []string | Аннотации группы workers | +| cpu | int | Кол-во cpu на компьютах workers | +| detailed_info | []Struct{} [см. ниже](#описание-структуры-списка-detailed_info) | Детальная информация masters | +| disk | int | ID диска | +| guid | string | ID ресурса | +| id | int | ID группы workers | +| labels | []string | Лейблы группы workers | +| name | string | Имя ресурса | +| num | int | Кол-во компьютов в группе workers | +| ram | int | Кол-во Ram на компьютах группы workers | +| taints | []string | огранечители группы workers | + +### Описание структуры списка detailed_info + +| Параметр | Тип | Описание | +| --- | --- | --- | +| external_ip | string | Внешний ip | +| compute_id | int | ID компьюта в составе группы | +| name | string | Имя компьюта в составе группы | +| status | string | Статус компьюта в составе группы | +| tech_status | string | Статус компьюта в составе группы | +| interfaces | []Struct{} [см. ниже](#описание-структуры-списка-interfaces) | Список интерфейсов группы | + +### Описание структуры списка interfaces + +| Параметр | Тип | Описание | +| --- | --- | --- | +| def_gw | string | Шлюз по умолчанию | +| ip_address | string | IP интерфейса | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_k8s**: + +```terraform +data "decort_cb_k8s" "k8s" { + #id кластера + #обязательный параметр + #тип - число + k8s_id = 49304 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s** в переменной `data.decort_cb_k8s.k8s` будут сохранены возвращаемые значения. diff --git a/06.02.73-Data-функция-decort_cb_k8s_computes-получение-информации-о-виртуальных-машинах-кластера.md b/06.02.73-Data-функция-decort_cb_k8s_computes-получение-информации-о-виртуальных-машинах-кластера.md new file mode 100644 index 0000000..4b58934 --- /dev/null +++ b/06.02.73-Data-функция-decort_cb_k8s_computes-получение-информации-о-виртуальных-машинах-кластера.md @@ -0,0 +1,49 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s_computes** служит для получения информации о виртуальных машинах кластера + +## Аргументы + +| Аргумент | Тип | Обязательный | Описание | +| -------- | --- | ------------ | -------- | +| k8s_id | int | :heavy_check_mark: | ID кластера | + +## Возвращаемые значения + +| Параметр | Тип | Описание | +| ------------ |-------------| -------------------------------- | +| masters | []Struct{} [см. ниже](#описание-структуры-masters) | Список мастер ВМ (см. ниже) | +| workers | []Struct{} [см. ниже](#описание-структуры-workers) | Список воркер ВМ (см.ниже) | + +## Описание структуры masters + +| Параметр | Тип | Описание | +| ------------ | ------ | -------------------------------- | +| id | int | ID виртуальной машины | +| name | string | Наименование виртуальной машины | +| group_name | string | Наименование мастер-группы, к которой принадлежит ВМ | +| status | string | Статус ВМ | +| tech_status | string | Тех. статус ВМ | + +## Описание структуры workers + +| Параметр | Тип | Описание | +| ------------ | ------ | -------------------------------- | +| id | int | ID виртуальной машины | +| name | string | Наименование виртуальной машины | +| group_name | string | Наименование воркер-группы, к которой принадлежит ВМ | +| status | string | Статус ВМ | +| tech_status | string | Тех. статус ВМ | + +## Пример использования + +```terraform +data "decort_cb_k8s_computes" "computes" { + #id кластера + #обязательный параметр + #тип - int + k8s_id = 1234 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s_computes** в переменной `data.decort_cb_k8s_computes.computes` будут сохранены возвращаемые значения. diff --git a/06.02.74-Data-функция-decort_cb_k8s_list-получение-информации-о-списке-кластеров-k8s.md b/06.02.74-Data-функция-decort_cb_k8s_list-получение-информации-о-списке-кластеров-k8s.md new file mode 100644 index 0000000..2470c7d --- /dev/null +++ b/06.02.74-Data-функция-decort_cb_k8s_list-получение-информации-о-списке-кластеров-k8s.md @@ -0,0 +1,98 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s_list** служит для получения информации о списке кластеров Kubernetes (k8s). + +## Аргументы + +_Data source_ функция **decort_cb_k8s_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID кластера | +| name | string | :x: | Фильтр по имени кластера | +| ip_address | string | :x: | Фильтр по IP адресу | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| lb_id | int | :x: | Фильтр по ID балансировщика | +| basic_service_id | int | :x: | Фильтр по ID basic service | +| status | string | :x: | Фильтр по статусу | +| tech_status | string | :x: | Фильтр по тех. статусу | +| include_deleted | bool| :x: | Включить в результат удаленные балансировщики | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_k8s_list** возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |---------------------------------------------------------|---------------------------------| +| acl | []string | acl | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| bservice_id | int | ID bservice | +| k8sci_id | int | ID образа кластера | +| 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 кластера | +| k8s_name | string | Имя кластера | +| kubeconfig | string | Конфиг | +| lb_id | int | ID балансировщика нагрузки | +| milestones | int | Вехи | +| lb_ip | string | IP балансировщика нагрузки | +| network_plugin | string | Сетевой плагин | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| service_account | Struct{} [см. ниже](#описание-структуры-service_account) | информация о аккаунте кластера | +| ssh_key | string | Публичный SSH ключ | +| status | string | Статус ресурса | +| tech_status | string | Технический статус ресурса | +| updated_by | string | Кем был обновлен ресурс | +| updated_time | int | Время последнего обновления ресурса | +| vins_id | int | ID виртуальной сети | +| workers_groups | []Struct{} [см. ниже](#описание-структуры-workers_groups) | Структура компьютов воркеров | + +### Описание структуры service_account + +| Параметр | Тип | Описание | +| --- |--------| --- | +| guid | string | ID ресурса | +| password | string | Пароль аккаунта | +| username | string | Username аккаунта | + +### Описание структуры workers_groups + +| Параметр | Тип | Описание | +| --- | --- | --- | +| annotations | []string | Аннотации группы workers | +| guid | string | ID ресурса | +| id | int | ID группы workers | +| labels | []string | Лейблы группы workers | +| taints | []string | огранечители группы workers | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_k8s_list**: + +```terraform +data "decort_cb_k8s_list" "k8s_list" { + #by_id = 100 + #name = "test" + #ip_address = "test" + #rg_id = 100 + #lb_id = 100 + #bservice_id = 100 + #status = "ENABLED" + #tech_status = "STOPPED" + #include_deleted = true + # page = 1 + # size = 1 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s_list** в переменной `data.decort_cb_k8s_list.k8s_list` будут сохранены возвращаемые значения. diff --git a/06.02.75-Data-функция-decort_cb_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md b/06.02.75-Data-функция-decort_cb_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md new file mode 100644 index 0000000..939f290 --- /dev/null +++ b/06.02.75-Data-функция-decort_cb_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md @@ -0,0 +1,117 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s_list_deleted** служит для получения информации о списке удаленных кластеров Kubernetes (k8s). + +## Аргументы + +_Data source_ функция **decort_cb_k8s_list_deleted** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID кластера | +| name | string | :x: | Фильтр по имени кластера | +| ip_address | string | :x: | Фильтр по IP адресу | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| lb_id | int | :x: | Фильтр по ID балансировщика | +| basic_service_id | int | :x: | Фильтр по ID basic service | +| tech_status | string | :x: | Фильтр по тех. статусу | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_k8s_list_deleted** возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |---------------------------------------------------------|---------------------------------| +| acl | []string | acl | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| bservice_id | int | ID bservice | +| k8sci_id | int | ID образа кластера | +| 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 кластера | +| name | string | Имя кластера | +| kubeconfig | string | Конфиг | +| lb_id | int | ID балансировщика нагрузки | +| milestones | int | Вехи | +| network_plugin | string | Сетевой плагин | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| service_account | Struct{} [см. ниже](#описание-структуры-service_account) | информация о аккаунте кластера | +| ssh_key | string | Публичный SSH ключ | +| status | string | Статус ресурса | +| tech_status | string | Технический статус ресурса | +| updated_by | string | Кем был обновлен ресурс | +| updated_time | int | Время последнего обновления ресурса | +| vins_id | int | ID виртуальной сети | +| workers_groups | []Struct{} [см. ниже](#описание-структуры-workers_groups) | Структура компьютов воркеров | + +### Описание структуры service_account + +| Параметр | Тип | Описание | +| --- |--------| --- | +| guid | string | ID ресурса | +| password | string | Пароль аккаунта | +| username | string | Username аккаунта | + +### Описание структуры workers_groups + +| Параметр | Тип | Описание | +| --- | --- | --- | +| annotations | []string | Аннотации группы workers | +| cpu | int | Кол-во cpu на компьютах workers | +| detailed_info | []Struct{} [см. ниже](#описание-структуры-списка-detailed_info) | Детальная информация masters | +| disk | int | ID диска | +| guid | string | ID ресурса | +| id | int | ID группы workers | +| labels | []string | Лейблы группы workers | +| name | string | Имя ресурса | +| num | int | Кол-во компьютов в группе workers | +| ram | int | Кол-во Ram на компьютах группы workers | +| taints | []string | огранечители группы workers | + +### Описание структуры списка detailed_info + +| Параметр | Тип | Описание | +| --- | --- | --- | +| external_ip | string | Внешний ip | +| compute_id | int | ID компьюта в составе группы | +| name | string | Имя компьюта в составе группы | +| status | string | Статус компьюта в составе группы | +| tech_status | string | Статус компьюта в составе группы | +| interfaces | []Struct{} [см. ниже](#описание-структуры-списка-interfaces) | Список интерфейсов группы | + +### Описание структуры списка interfaces + +| Параметр | Тип | Описание | +| --- | --- | --- | +| def_gw | string | Шлюз по умолчанию | +| ip_address | string | IP интерфейса | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_k8s_list_deleted**: + +```terraform +data "decort_cb_k8s_list_deleted" "k8s_list_deleted" { + #by_id = 100 + #name = "test" + #ip_address = "1.1.1.1" + #rg_id = 100 + #lb_id = 100 + #bservice_id = 100 + #tech_status = "STOPPED" + #page = 1 + #size = 1 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s_list_deleted** в переменной `data.decort_cb_k8s_list_deleted.k8s_list_deleted` будут сохранены возвращаемые значения. diff --git a/06.02.76-Data-функция-decort_cb_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s.md b/06.02.76-Data-функция-decort_cb_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s.md new file mode 100644 index 0000000..e23b674 --- /dev/null +++ b/06.02.76-Data-функция-decort_cb_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s.md @@ -0,0 +1,70 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s_wg** служит для получения информации о группе воркеров кластера Kubernetes (k8s). + +## Аргументы + +_Data source_ функция **decort_cb_k8s_wg** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| k8s_id | int | :heavy_check_mark: | ID кластера | +| wg_id | int | :heavy_check_mark: | ID группы воркеров | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_k8s_wg** возвращает следующие параметры: + +| Параметр | Тип | Описание | +| --- |-----------------------------------------------------------------| --- | +| k8s_id | int | ID кластера | +| wg_id | int | ID группы воркеров | +| name | string | Имя группы воркеров | +| num | int | кол-во компьютов в ресурсе | +| cpu | int | Кол-во cpu на нодах | +| ram | int | Кол-во ram на нодах | +| disk | int | ID диска | +| detailed_info | []Struct{} [см. ниже](#описание-структуры-списка-detailed_info) | Детальная информация masters | +| labels | []string | Лейблы ресурса | +| guid | string | ID ресурса | +| annotations | []string | Аннотации ресурса | +| taints | []string | ограничители группы workers | + +### Описание структуры списка detailed_info + +| Параметр | Тип | Описание | +| --- | --- | --- | +| external_ip | string | Внешний ip | +| compute_id | int | ID компьюта в составе группы | +| name | string | Имя компьюта в составе группы | +| status | string | Статус компьюта в составе группы | +| tech_status | string | Технический статус компьюта в составе группы | +| interfaces | []Struct{} [см. ниже](#описание-структуры-списка-interfaces) | Список интерфейсов группы | + +### Описание структуры списка interfaces + +| Параметр | Тип | Описание | +| --- | --- | --- | +| def_gw | string | Шлюз по умолчанию | +| ip_address | string | IP интерфейса | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_k8s_wg**: + +```terraform +data "decort_cb_k8s_wg" "k8s_wg" { + #id кластера + #обязательный параметр + #тип - число + k8s_id = 49304 + + #id группы воркеров + #обязательный параметр + #тип - число + wg_id = 43329 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s_wg** в переменной `data.decort_cb_k8s_wg.k8s_wg` будут сохранены возвращаемые значения. + diff --git a/06.02.77-Data-функция-decort_cb_k8s_wg_cloud_init-получение-информации-об-предустановленных-настройках-группы-воркеров-кластера-Kubernetes.md b/06.02.77-Data-функция-decort_cb_k8s_wg_cloud_init-получение-информации-об-предустановленных-настройках-группы-воркеров-кластера-Kubernetes.md new file mode 100644 index 0000000..a44ed10 --- /dev/null +++ b/06.02.77-Data-функция-decort_cb_k8s_wg_cloud_init-получение-информации-об-предустановленных-настройках-группы-воркеров-кластера-Kubernetes.md @@ -0,0 +1,41 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s_wg_cloud_init** служит для получения информации об предустановленных настройках группы воркеров кластера Kubernetes (k8s) + +## Аргументы + +_Data source_ функция **decort_cb_k8s_wg_cloud_init** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| k8s_id | int | :heavy_check_mark: | ID кластера | +| wg_id | int | :heavy_check_mark: | ID группы воркеров | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_k8s_wg_cloud_init** возвращает следующие параметры: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| cloud_init | string | Предустановленные настройки группы воркеров кластера Kubernetes (k8s) | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_k8s_wg_cloud_init**: + +```terraform +data "decort_cb_k8s_wg_cloud_init" "wg_cloud_init" { + #id кластера + #обязательный параметр + #тип - число + k8s_id = 977 + + #id группы воркеров + #обязательный параметр + #тип - число + wg_id = 2110 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s_wg_cloud_init** в переменной `data.decort_cb_k8s_wg_cloud_init.wg_cloud_init` будут сохранены возвращаемые значения. + diff --git a/06.02.78-Data-функция-decort_cb_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s.md b/06.02.78-Data-функция-decort_cb_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s.md new file mode 100644 index 0000000..a370b82 --- /dev/null +++ b/06.02.78-Data-функция-decort_cb_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s.md @@ -0,0 +1,63 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_k8s_wg_list** служит для получения информации о списке групп воркеров кластера Kubernetes (k8s). + +## Аргументы + +_Data source_ функция **decort_cb_k8s_wg_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| k8s_id | int | :heavy_check_mark: | ID кластера | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_k8s_wg_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| annotations | []string | Аннотации ресурса | +| cpu | int | Кол-во cpu на нодах | +| detailed_info | []Struct{} [см. ниже](#описание-структуры-списка-detailed_info) | Детальная информация masters | +| disk | int | ID диска | +| guid | string | ID ресурса | +| wg_id | int | ID группы воркеров кластера | +| labels | []string | Лейблы ресурса | +| name | string | Имя группы воркеров | +| num | int | кол-во компьютов в ресурсе | +| ram | int | Кол-во ram на нодах | +| taints | []string | ограничители группы workers | + +### Описание структуры списка detailed_info + +| Параметр | Тип | Описание | +| --- | --- | --- | +| external_ip | string | Внешний ip - адрес | +| compute_id | int | ID компьюта в составе группы | +| name | string | Имя компьюта в составе группы | +| status | string | Статус компьюта в составе группы | +| tech_status | string | Технический статус компьюта в составе группы | +| interfaces | []Struct{} [см. ниже](#описание-структуры-списка-interfaces) | Список интерфейсов группы | + +### Описание структуры списка interfaces + +| Параметр | Тип | Описание | +| --- | --- | --- | +| def_gw | string | Шлюз по умолчанию | +| ip_address | string | IP интерфейса | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_k8s_wg_list**: + +```terraform +data "decort_cb_k8s_wg_list" "k8s_wg_list" { + #id кластера + #обязательный параметр + #тип - число + k8s_id = 49304 +} +``` + +После успешного завершения такого вызова **decort_cb_k8s_wg_list** в переменной `data.decort_cb_k8s_wg_list.k8s_wg_list` будут сохранены возвращаемые значения. + diff --git a/Home.md b/Home.md index 0f87311..95ef70e 100644 --- a/Home.md +++ b/Home.md @@ -186,6 +186,13 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_audit**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.69-Data-функция-decort_cb_audit-получение-информации-о-событии-системы) - получение информации о событии системы - [**decort_cb_audit_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.70-Data-функция-decort_cb_audit_list-получение-информации-о-всех-событиях-системы) - получение информации о всех событиях системы - [**decort_cb_audit_linked_jobs**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.71-Data-функция-decort_cb_audit_linked_jobs-получение-списка-заданий-связанных-с-указанным-событием-системы) - получение списка заданий связанных с указанным событием системы + - [**decort_cb_k8s**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.72-Data-функция-decort_cb_k8s-получение-информации-о-кластере-k8s) - получение информации о кластере k8s + - [**decort_cb_k8s_computes**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.73-Data-функция-decort_cb_k8s_computes-получение-информации-о-виртуальных-машинах-кластера) - получение информации о виртуальных машинах кластера + - [**decort_cb_k8s_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.74-Data-функция-decort_cb_k8s_list-получение-информации-о-списке-кластеров-k8s) - получение информации о списке кластеров k8s + - [**decort_cb_k8s_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.75-Data-функция-decort_cb_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s) - получение информации о списке удаленных кластеров k8s + - [**decort_cb_k8s_wg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.76-Data-функция-decort_cb_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s) - получение информации о группе воркеров кластера k8s + - [**decort_cb_k8s_wg_cloud_init**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.77-Data-функция-decort_cb_k8s_wg_cloud_init-получение-информации-об-предустановленных-настройках-группы-воркеров-кластера-Kubernetes) - получение информации об предустановленных настройках группы воркеров кластера Kubernetes + - [**decort_cb_k8s_wg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.78-Data-функция-decort_cb_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s) - получение информации о списке группворкеров кластера k8s --> 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)