add k8ci data sources and resources

master
loskutovanl 1 year ago
parent 9868e9da52
commit 1918f0e780

@ -0,0 +1,91 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_k8ci_list** служит для получения информации о доступных k8ci (конфигурация Кластера Kubernetes).
## Аргументы
| Аргумент | Тип | Обязательный | Описание |
| -------- | --- | ------------ |-------------------------------------------------------|
| by_id | int | :x: | Фильтр по ID k8ci |
| name | string | :x: | Фильтр по имени k8ci |
| status | string | :x: | Фильтр по статусу |
| worker_driver | string | :x: | Фильтр по драйверу worker |
| master_driver | string | :x: | Фильтр по драйверу master |
| network_plugin | string | :x: | Фильтр по плагину сети (flannel, calico или weavenet) |
| include_disabled | bool | :x: | Дополнить рез-тат выключенными k8ci |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
## Возвращаемые значения (в списке items)
| Параметр | Тип | Описание |
| ------------ | ------- |--------------------------------------------------------------|
| created_time | int | Время создания |
| desc | string | Описание |
| gid | int | Grid ID |
| guid | int | ID ресурса |
| k8ci_id | int | ID k8ci |
| lb_image_id | int | ID образа балансировщика |
| master_driver | string | Драйвер master-узла |
|master_image_id|int| ID образа master-узла k8ci |
|max_master_count|int| Ограничение политики на максимальное количество master-узлов |
|max_worker_count|int| Ограничение политики на максимальное количество worker-узлов |
| name | string | Наименование k8ci |
| shared_with | []int | Список ресурсов, имеющих доступ к k8ci |
| status | string | Статус k8ci |
| version | string | Версия |
| worker_driver | string | Драйвер worker-узла |
|worker_image_id|int| ID образа worker-узла k8ci |
## Пример использования
```terraform
data "decort_cb_k8ci_list" "k8ci_list" {
#фильтр по id k8ci
#опциональный параметр
#тип - число
#by_id = 111
#фильтр по имени k8ci
#опциональный параметр
#тип - строка
#name = "name"
#фильтр по статусу k8ci
#опциональный параметр
#тип - строка
#status = "status"
#фильтр по worker driver
#опциональный параметр
#тип - строка
#worker_driver = "KVM_X86"
#фильтр по master driver
#опциональный параметр
#тип - строка
#master_driver = "KVM_X86"
#фильтр по network plugin
#опциональный параметр
#тип - строка
#network_plugin = "flannel"
#исключить из результата недоступные k8ci
#опциональный параметр
#тип - булево значение
#include_disabled = "true"
#номер страницы для отображения
#опциональный параметр
#тип - число
#page = 2
#размер страницы
#опциональный параметр
#тип - число
#size = 3
}
```
После успешного завершения такого вызова **decort_cb_k8ci_list** в переменной `data.decort_cb_k8ci_list.k8ci_list.items` будут сохранены возвращаемые значения.

@ -0,0 +1,79 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_k8ci_list_deleted** служит для получения информации об удаленных k8ci (конфигурация Кластера Kubernetes).
## Аргументы
| Аргумент | Тип | Обязательный | Описание |
| -------- | --- | ------------ |-------------------------------------------------------|
| by_id | int | :x: | Фильтр по ID k8ci |
| name | string | :x: | Фильтр по имени k8ci |
| worker_driver | string | :x: | Фильтр по драйверу worker |
| master_driver | string | :x: | Фильтр по драйверу master |
| network_plugin | string | :x: | Фильтр по плагину сети (flannel, calico или weavenet) |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
## Возвращаемые значения (в списке items)
| Параметр | Тип | Описание |
| ------------ | ------- |--------------------------------------------------------------|
| created_time | int | Время создания |
| desc | string | Описание |
| gid | int | Grid ID |
| guid | int | ID ресурса |
| k8ci_id | int | ID k8ci |
| lb_image_id | int | ID образа балансировщика |
| master_driver | string | Драйвер master-узла |
|master_image_id|int| ID образа master-узла k8ci |
|max_master_count|int| Ограничение политики на максимальное количество master-узлов |
|max_worker_count|int| Ограничение политики на максимальное количество worker-узлов |
| name | string | Наименование k8ci |
| shared_with | []int | Список ресурсов, имеющих доступ к k8ci |
| status | string | Статус k8ci |
| version | string | Версия |
| worker_driver | string | Драйвер worker-узла |
|worker_image_id|int| ID образа worker-узла k8ci |
## Пример использования
```terraform
data "decort_cb_k8ci_list_deleted" "k8ci_list_deleted" {
#фильтр по id k8ci
#опциональный параметр
#тип - число
#by_id = 111
#фильтр по имени k8ci
#опциональный параметр
#тип - строка
#name = "name"
#фильтр по worker driver
#опциональный параметр
#тип - строка
#worker_driver = "KVM_X86"
#фильтр по master driver
#опциональный параметр
#тип - строка
#master_driver = "KVM_X86"
#фильтр по network plugin
#опциональный параметр
#тип - строка
#network_plugin = "flannel"
#номер страницы для отображения
#опциональный параметр
#тип - число
#page = 2
#размер страницы
#опциональный параметр
#тип - число
#size = 3
}
```
После успешного завершения такого вызова **decort_cb_k8ci_list_deleted** в переменной `data.decort_cb_k8ci_list_deleted.k8ci_list_deleted.items` будут сохранены возвращаемые значения.

@ -0,0 +1,44 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_k8ci** служит для получения информации о k8ci (конфигурация Кластера Kubernetes).
## Аргументы
| Аргумент | Тип | Обязательный | Описание |
| -------- | --- | ------------ |------------------------------------------------------|
| k8ci_id | int | :heavy_check_mark: | ID k8ci |
## Возвращаемые значения
| Параметр | Тип | Описание |
| ------------ | ------- |--------------------------------------------------------------|
| desc | string | Описание |
| gid | int | Grid ID |
| guid | int | ID ресурса |
| k8ci_id | int | ID k8ci |
| lb_image_id | int | ID образа балансировщика |
| master_driver | string | Драйвер master-узла |
|master_image_id|int| ID образа master-узла k8ci |
|max_master_count|int| Ограничение политики на максимальное количество master-узлов |
|max_worker_count|int| Ограничение политики на максимальное количество worker-узлов |
| milestones | int | Вехи |
| name | string | Наименование k8ci |
| network_plugins | []string | Список доступных плагинов сети |
| shared_with | []int | Список ресурсов, имеющих доступ к k8ci |
| status | string | Статус k8ci |
| version | string | Версия |
| worker_driver | string | Драйвер worker-узла |
|worker_image_id|int| ID образа worker-узла k8ci |
## Пример использования
```terraform
data "decort_cb_k8ci" "k8ci" {
#id k8ci
#обязательный параметр
#тип - число
k8ci_id = 111
}
```
После успешного завершения такого вызова **decort_cb_k8ci** в переменной `data.decort_cb_k8ci.k8ci` будут сохранены возвращаемые значения.

@ -0,0 +1,127 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Resource_ функция **decort_cb_k8ci** служит для управления конфигурацией Кластера Kubernetes (K8ci).
## Аргументы
_Resource_ функция **decort_cb_k8ci** для создания кластера принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|----------------|-----------|----------------------------------------------|--------------------------------------------------------------------|
| name | string | :heavy_check_mark: | Наименование K8ci, <br/>при изменении - изменяет наименование K8ci |
| version | string | :heavy_check_mark: | Версия |
| master_driver | string | :heavy_check_mark: | Драйвер master-узла |
|master_image_id|int| :heavy_check_mark: | ID образа master-узла k8ci |
|max_master_count|int| :heavy_check_mark: | Ограничение политики на максимальное количество master-узлов |
|max_worker_count|int| :heavy_check_mark: | Ограничение политики на максимальное количество worker-узлов |
|worker_image_id|int| :heavy_check_mark: | ID образа worker-узла k8ci |
| worker_driver | string | :heavy_check_mark: | Драйвер worker-узла |
| network_plugins | []string | :heavy_check_mark: | Список доступных плагинов сети ["flannel", "calico", "weavenet"] |
| enabled | bool | :x: | Доступность k8ci |
| permanently | bool | :x: | Флаг для моментального удаления k8ci |
| desc | string | :x: | Описание k8ci |
| shared_with | []int | :x: | Список аккаунтов, имеющих доступ к k8ci |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_cb_k8ci** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| ------------ | ------- |--------------------------------------------------------------|
| desc | string | Описание |
| gid | int | Grid ID |
| guid | int | ID ресурса |
| k8ci_id | int | ID k8ci |
| lb_image_id | int | ID образа балансировщика |
| master_driver | string | Драйвер master-узла |
|master_image_id|int| ID образа master-узла k8ci |
|max_master_count|int| Ограничение политики на максимальное количество master-узлов |
|max_worker_count|int| Ограничение политики на максимальное количество worker-узлов |
| milestones | int | Вехи |
| name | string | Наименование k8ci |
| network_plugins | []string | Список доступных плагинов сети |
| shared_with | []int | Список ресурсов, имеющих доступ к k8ci |
| status | string | Статус k8ci |
| version | string | Версия |
| worker_driver | string | Драйвер worker-узла |
|worker_image_id|int| ID образа worker-узла k8ci |
## Пример использования
Пример вызова _resource_ функции **decort_cb_k8ci**:
```terraform
resource "decort_cb_k8ci" "k8ci" {
#имя k8ci
#обязательный параметр
#тип - строка
name = "test"
#тег версии
#обязательный параметр
#тип - строка
version = "1.1.1"
#тип master driver
#обязательный параметр
#тип - строка
master_driver = "KVM_X86"
#тип worker driver
#обязательный параметр
#тип - строка
worker_driver = "KVM_X86"
#максимальное число master компутов
#обязательный параметр
#тип - число
max_master_count = 1
#максимальное число worker компутов
#обязательный параметр
#тип - число
max_worker_count = 1
#id образа для master
#обязательный параметр
#тип - число
master_image_id = 4
#id образа для worker
#обязательный параметр
#тип - число
worker_image_id = 4
#network plugins
#обязательный параметр
#тип - список строк
network_plugins = ["flannel"]
#доступность k8ci
#опциональный параметр
#тип - булево значение
#enabled = false
#флаг для моментального удаления k8ci
#опциональный параметр
#тип - булевый
#permanently = true
#описание
#опциональный параметр
#тип - строка
#desc = "some"
#доступность k8ci другим аккаунтам
#опциональный параметр
#тип - список чисел
#shared_with = [1111]
}
# once the above directive completes, k8ci configuration will be accessible
# as decort_cb_k8ci.k8ci
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
После успешного завершения такого вызова **decort_cb_k8ci** в переменной `decort_cb_k8ci.k8ci` будут сохранены возвращаемые значения.

@ -193,6 +193,9 @@ Terraform провайдер для платформы DECORT с API верси
- [**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**](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_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 - [**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
- [**decort_cb_k8ci_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.79-Data-функция-decort_cb_k8ci_list-получение-информации-о-всех-k8ci) - получение информации о всех k8ci
- [**decort_cb_k8ci_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.80-Data-функция-decort_cb_k8ci_list_deleted-получение-информации-об-удаленных-k8ci) - получение информации об удаленных k8ci
- [**decort_cb_k8ci**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.81-Data-функция-decort_cb_k8ci-получение-информации-о-k8ci) - получение информации о k8ci
--> -->
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT) 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
@ -244,6 +247,7 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_cb_lb_frontend_bind**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки) - управление привязками фронтенда балансировщиком нагрузки - [**decort_cb_lb_frontend_bind**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки) - управление привязками фронтенда балансировщиком нагрузки
- [**decort_cb_vins_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.22-Resource-функция-decort_cb_vins_static_route-управление-статическим-маршрутом-для-внутренней-сети) - управление статическим маршрутом для внутренней сети - [**decort_cb_vins_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.22-Resource-функция-decort_cb_vins_static_route-управление-статическим-маршрутом-для-внутренней-сети) - управление статическим маршрутом для внутренней сети
- [**decort_cb_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска) - управление снимком диска - [**decort_cb_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска) - управление снимком диска
- [**decort_cb_k8ci**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.24-Resource-функция-decort_cb_k8ci-управление-k8ci) - управление k8ci
--> -->
8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы) 8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы)

Loading…
Cancel
Save