updated k8s wiki to v4.0.2

dev
Tim Tkachev 2 years ago
parent 14637fbf02
commit 00846a3f63

@ -0,0 +1,47 @@
_Data source_ функция **decort_k8s_computes** служит для получения информации о виртуальных машинаъ кластера
## Аргументы
| Аргумент | Тип | Обязательный | Описание |
| -------- | --- | ------------ | -------- |
| k8s_id | int | :heavy_check_mark: | ID кластера |
## Возвращаемые значения
| Параметр | Тип | Описание |
| ------------ | ------ | -------------------------------- |
| masters | []Struct{} | Список мастер ВМ (см. ниже) |
| workers | []Struct{} | Список воркер ВМ (см.ниже) |
## Описание структуры 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_k8s_computes" "computes" {
#id кластера
#обязательный параметр
#тип - int
k8s_id = <ID>
}
```
После успешного завершения такого вызова **decort_k8s_сomputes** в переменной `data.decort_k8s_computes.computes` будут сохранены возвращаемые значения.

@ -2,6 +2,10 @@
_Resource_ функция **decort_k8s** служит для управления кластером.
## Изменения в 4.0.2
- Добавлена возможность создавать/удалять воркер-группы напрямую из ресурса k8s
- Исправлены возможные ошибки состояния при модификации воркер-групп
## Изменения в 3.4.0
- В аргументы добавлено опциональное поле labels.
- В аргументы добавлено опциональное поле taints.
@ -27,11 +31,11 @@ _Resource_ функция **decort_k8s** для создания кластер
| k8sci_id | int | :heavy_check_mark: | ID catalogue item |
| wg_name | string | :heavy_check_mark: | Имя для первой worker group, <br/> созданной в кластере |
| network_plugin | string | :heavy_check_mark: | Плагин сети для кластера. Допустимые значения: flannel, calico, weavenet |
| labels | []string | :x: | Список меток для кластера k8s |
| taints | []string | :x: | Список taints для кластера k8s |
| annotations | []string | :x: | Список аннотаций для кластера k8s |
| masters | Struct{} [см. ниже](#описание-блока-masters) | :x: | Настройка мастер node или nodes |
| workers | Struct{} [см. ниже](#описание-блока-workers) | :x: | Настройка worker node или nodes |
| labels | []string | :x: | Список меток для дефолтной worker-группы k8s |
| taints | []string | :x: | Список taints для дефолтной worker-группы k8s |
| annotations | []string | :x: | Список аннотаций дефолтной worker-группы k8s |
| masters | Struct{} [см. ниже](#описание-блока-masters) | :x: | Настройка мастер-группы |
| workers | Struct{} [см. ниже](#описание-блока-workers) | :x: | Настройка worker-групп |
| extnet_id | int | :x: | ID внешней сети для соединения workers.<br/>Если не задано,<br/>то сеть будет выбрана платформой. |
| start | bool | :x: | Старт/Стоп кластера |
@ -48,12 +52,16 @@ _Resource_ функция **decort_k8s** для создания кластер
### Описание блока workers
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :heavy_check_mark: | Наименование воркер-группы |
| num | int | :heavy_check_mark: | Количество nodes |
| cpu | int | :heavy_check_mark: | Количество cpu |
| ram | int | :heavy_check_mark: | Количество RAM в Mбайтах|
| disk | int | :heavy_check_mark: | Объем boot диска в ГБ |
| sep_id | int | :x: | Идентификатор SEP |
| sep_pool | string | :x: | Название SEP pool'а |
| labels | []string | :x: | Список labels |
| annotations | []string | :x: | Список annotations |
| taints | []string | :x: | Список taints |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_k8s** возвращает в указанную при вызове переменную следующие значения:
@ -180,9 +188,27 @@ resource "decort_k8s" "cluster" {
#имя для первой worker group, созданной в кластере
#обязательный параметр
#тип - строка
wg_name = "workers"
#настройка мастер node или nodes
wg_name = "workers_wg"
# список labels для дефолтной worker группы
# опциональный параметр
# В скором времени параметры labels, annotations, taints будут полностью перенесены в блок workers
# тип - массив строк
labels = ["key1=val1", "key2=val2"]
# список annotations для дефолтной worker группы
# опциональный параметр
# В скором времени параметры labels, annotations, taints будут полностью перенесены в блок workers
# тип - массив строк
annotations = ["key1=val1", "key2=val2"]
# список taints для дефолтной worker группы
# опциональный параметр
# В скором времени параметры labels, annotations, taints будут полностью перенесены в блок workers
# тип - массив строк
taints = ["key1=val1", "key2=val2"]
#настройка мастер node
#опциональный параметр
#максимальное кол-во элементов - 1
#тип - список нод
@ -219,11 +245,16 @@ resource "decort_k8s" "cluster" {
disk = 10
}
#настройка worker node или nodes
#опциональный параметр
#максимальное кол-во элементов - 1
#тип - список нод
# настройка worker группы
# опциональный параметр
# Первая указанная воркер-группа должна соответствовать изначально созданной вместе с кластером.
# labels, annotations, taints для дефолтной worker группы указываются в корне ресурса при создании кластера.
workers {
#наименование worker группы
#обязательный параметр
#тип - строка
name = "workers_wg"
#кол-во node
#обязательный параметр
#тип - число
@ -234,6 +265,16 @@ resource "decort_k8s" "cluster" {
#тип - число
cpu = 2
#кол-во RAM в Мбайтах
#обязательный параметр
#тип - число
ram = 2048
#размер диска в Гбайтах
#обязательный параметр
#тип - число
disk = 10
#Идентификатор SEP
#опциональный параметр
#тип - число
@ -244,20 +285,76 @@ resource "decort_k8s" "cluster" {
#тип - строка
sep_pool = "data01"
#Список лейблов
#опциональный параметр
#тип - массив строк
labels = ["label1=value1", "label2=value2"]
#Список аннотаций
#опциональный параметр
#тип - массив строк
annotations = ["key1=value1", "key2=value2"]
#Список taints
#опциональный параметр
#тип - массив строк
taints = ["key1=value1:NoSchedule", "key2=value2:NoExecute"]
}
#...Далее можно создавать произвольное кол-во дополнительных worker групп
# labels, annotations и taints для последующих групп указываются непосредственно в блоке workers
workers {
#наименование worker группы
#обязательный параметр
#тип - строка
name = "additional_wg"
#кол-во node
#обязательный параметр
#тип - число
num = 2
#кол-во cpu
#обязательный параметр
#тип - число
cpu = 2
#кол-во RAM в Мбайтах
#обязательный параметр
#тип - число
ram = 2048
ram = 4096
#размер диска в Гбайтах
#обязательный параметр
#тип - число
disk = 10
#Идентификатор SEP
#опциональный параметр
#тип - число
sep_id = 1010
#Имя SEP pool'a
#опциональный параметр
#тип - строка
sep_pool = "data01"
#Список лейблов
#опциональный параметр
#тип - массив строк
labels = ["label1=value1", "label2=value2"]
#Список аннотаций
#опциональный параметр
#тип - массив строк
annotations = ["key1=value1", "key2=value2"]
#Список taints
#опциональный параметр
#тип - массив строк
taints = ["key1=value1:NoSchedule", "key2=value2:NoExecute"]
}
}
# once the above directive completes, will be accessible
# as decort_k8s.cluster
```
После успешного завершения такого вызова **decort_k8s** в переменной `decort_k8s.cluster` будут сохранены возвращаемые значения.

Loading…
Cancel
Save