Create resource decort_k8s page, add description

stSolo
2022-03-28 16:16:30 +03:00
parent 3cfaa62c82
commit 74c30e7ae8

@@ -0,0 +1,54 @@
_Resource_ функция **decort_k8s** служит для управления кластером.
## Аргументы
_Resource_ функция **decort_k8s** для создания кластера принимает следующие аргументы:
| Аргумент | Тип | Описание |
| --- | --- | --- |
| name | string | Обязательный параметр, наименование кластера, <br/>при изменении - изменяет наименование кластера |
| rg_id | int | Обязательный параметр, id ресурсной группы |
| k8sci_id | int | Обязательный параметр, id catalogue item |
| wg_name | string | Обязательный параметр, имя для первой worker group, <br/> созданной в кластере |
| masters | object{<br/>num: int, <br/>cpu: int,<br/>ram: int,<br/>disk: int} |Опциональный параметр, настройка мастер node или nodes<br/>Обязательный параметр, кол-во nodes<br/>Обязательный параметр, количество cpu<br/>Обязательный параметр, кол-во RAM в Mбайтах<br/>Обязательный параметр, размер диска в Гбайтах |
| workers | object{<br/>num: int, <br/>cpu: int,<br/>ram: int,<br/>disk: int} | Опциональный параметр, настройка worker node или nodes<br/>Обязательный параметр, кол-во nodes<br/>Обязательный параметр, количество cpu<br/>Обязательный параметр, кол-во RAM в Mбайтах<br/>Обязательный параметр, размер диска в Гбайтах |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_k8s** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| default_wg_id | int | ID рабочей группы (worker group) для этого экземпляра кластера. |
| kubeconfig | string | kubeconfig для доступа к кластеру. |
## Пример использования
Пример вызова _resource_ функции **decort_k8s**:
```terraform
resource "decort_k8s" "cluster" {
name = "tftest"
rg_id = 123
k8sci_id = 9
wg_name = "workers"
masters {
num = 1
cpu = 2
ram = 2048
disk = 10
}
workers {
num = 1
cpu = 2
ram = 2048
disk = 10
}
}
# once the above directive completes, will be accessible
# as decort_k8s.cluster
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
После успешного завершения такого вызова **decort_k8s** в переменной `decort_k8s` будут сохранены возвращаемые значения.