diff --git a/04.01-Установка-Terraform-провайдера-DECORT.md b/04.01-Установка-Terraform-провайдера-DECORT.md index 05ff959..dfa25e1 100644 --- a/04.01-Установка-Terraform-провайдера-DECORT.md +++ b/04.01-Установка-Terraform-провайдера-DECORT.md @@ -1,120 +1,76 @@ ## Системные требования -Для запуска провайдера вам потребуется компьютер, на котором установлен Terraform. Провайдер тестировался вместе с Terraform 1.x на системах под управлением ОС семейства Linux и персональных компьютерах под управлением Windows 10. +Для запуска провайдера вам потребуется машина, на которой установлен Terraform. Кроме того, в связи с тем, что начиная с версии 0.12 Terraform изменил алгоритм поиска и инициализации локальных провайдеров, настройка данного провайдера для работы с Terraform 0.12 или более новыми версиями потребует выполнения ряда дополнительных действий. Подробнее см. [8.3 Настройка локального провайдера для работы с новыми версиями Terraform](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#user-content-8-3-настройка-локального-провайдера-для-работы-с-новыми-версиями-terraform). ## Установка - -Terraform провайдер представляет собой бинарный исполняемый файл. Чтобы быстро начать пользоваться Terraform провайдером DECORT, поместите собранный для вашей целевой платформы исполняемый файл в ту же папку, где находится ваш файл _main.tf_. - -Обычно, провайдер устанавливается автоматически из terraform registry. -Для этого достаточно в файл _main.tf_ добавить директивы определения провайдера. -```terraform -provider "decort" { - authenticator = "oauth2" - #controller_url = - controller_url = "https://mr4.digitalenergy.online" - #oauth2_url = - oauth2_url = "https://sso.digitalenergy.online" - allow_unverified_ssl = true -} -``` - -При выполнении команды `terraform init` провайдер будет автоматически установлен. - -После этого вы можете использовать стандартные команды Terraform-а для управления ресурсами в соответствии с декларациями, содержащимися в _main.tf_, а именно: - -``` -terraform init -terraform plan -terraform apply -``` - -## Установка из релизов -Terraform провайдер DECORT имеет скомпилированные релизные версии, которые расположены по адресу: [Релизы](https://github.com/rudecs/terraform-provider-decort/releases). -Установка из релизов позволяет вместо скачивания провайдера из хранилища HashiCorp Terraform, скачать провайдер со страницы, указанной выше и установить его в ручном режиме. -Чтобы выполнить установку из релиза, необходимо: +Начиная с версии провайдера `4.3.0` в релизном архиве находятся скрипты-инсталляторы. +Чтобы выполнить установку, необходимо: 1. Перейти по адресу: https://repository.basistech.ru/BASIS/terraform-provider-decort/releases 2. Выбрать необходимую версию провайдера подходящую под операционную систему. 3. Скачать архив. 4. Распаковать архив. -5. Полученный файл необходимо поместить: -Linux: +5. Выполнить скрипт установщика, `install.sh` или `install.bat` для Windows.
+*Для запуска `install.sh` не забудьте изменить права доступа к файлу* ```bash -~/%work_dir%/terraform.d/plugins/${host_name}/${namespace}/${type}/${version}/${target} -``` -Windows: -```powershell -%APPDATA%\terraform.d\plugins\${host_name}\${namespace}\${type}\${version}\${target} +chmod u+x install.sh ``` -ВНИМАНИЕ: для ОС Windows `%APP_DATA%`, а в ОС Linux `%work_dir%` является каталогом, в котором будут помещены будущие файлы terraform. -Где: -- host_name - имя хоста, держателя провайдера, например, digitalenergy.online -- namespace - пространство имен хоста, например decort -- type - тип провайдера, может совпадать с пространством имен, например, decort -- version - версия провайдера, например 1.2 -- target - версия ОС, например windows_amd64 -6. После этого, создайте файл `main.tf`. -7. Добавьте в него следующий блок -```terraform +6. Дождаться сообщения об успешной установке. Установщик выведет актуальный блок конфигурации провайдера, скопируйте его +```bash +DECORT provider version 4.3.0 has been successfully installed + +Copy this provider configuration to main.tf file: terraform { required_providers { decort = { - version = "4.1.0" - source = "digitalenergy.online/decort/decort" + version = "4.3.0" + source = "basis/decort/decort" } } } ``` -В поле `version` указывается версия провайдера. -Обязательный параметр -Тип поля - строка -ВНИМАНИЕ: Версии в блоке и в репозитории, в который был помещен провайдер должны совпадать! - -В поле `source` помещается путь до репозитория с версией вида: +7. После этого, создайте файл `main.tf` в рабочей директории, которая может находится в любом удобном для пользователя месте. +В данном примере, рабочая директория с файлом main.tf находится по пути: ```bash -${host_name}/${namespace}/${type} +~/work/tfdir/main.tf ``` -ВНИМАНИЕ: все параметры должны совпадать с путем репозитория, в котором помещен провайдер. - -8. Добавьте в файл блок с инициализацией провайдера. +8. Вставьте в `main.tf` блок конфигурации провайдера, который был выведен на экран установщиком: +```terraform +terraform { + required_providers { + decort = { + version = "4.3.0" + source = "basis/decort/decort" + } + } +} +``` +9. Добавьте в файл блок с инициализацией провайдера. ```terraform provider "decort" { - authenticator = "oauth2" - #controller_url = - controller_url = "https://mr4.digitalenergy.online" - #oauth2_url = + authenticator = "oauth2" + controller_url = "https://mr4.digitalenergy.online" oauth2_url = "https://sso.digitalenergy.online" allow_unverified_ssl = true } ``` -9. В консоле выполнить команду +10. В консоли выполните команду ```bash terraform init ``` -10. Если все прошло хорошо - ошибок не будет. - +11. В случае успешной установки, Terraform инициализирует провайдер и будет готов к дальнейшей работе. -## Сборка из исходных кодов - -1. Скачайте и установите Go по ссылке: [https://go.dev/dl/](https://go.dev/dl/) -2. Скачайте и установите terraform по ссылке: [https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started](https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started) -3. Склонируйте репозиторий с провайдером, выполнив команду: -```bash -git clone https://repository.basistech.ru/BASIS/terraform-provider-decort.git -``` -4. Перейдите в скачанную папку с провайдером и выполните команду -```bash -go build -o terraform-provider-decort -``` -Если вы знаете как устроен _makefile_, то можно изменить в файле `Makefile` параметры под вашу ОС и выполнить команду -```bash -make build -``` -5. Полученный файл необходимо поместить: +## Установка из релизов +Terraform провайдер DECORT имеет скомпилированные релизные версии, которые расположены по адресу: [Релизы](https://repository.basistech.ru/BASIS/terraform-provider-decort/releases). +Чтобы выполнить установку из релиза, необходимо: +1. Перейти по адресу: https://repository.basistech.ru/BASIS/terraform-provider-decort/releases +2. Выбрать необходимую версию провайдера подходящую под операционную систему. +3. Скачать архив. +4. Распаковать архив. +5. Полученный файл (в директории `bin/`) необходимо поместить: Linux: ```bash ~/.terraform.d/plugins/${host_name}/${namespace}/${type}/${version}/${target} @@ -123,54 +79,72 @@ Windows: ```powershell %APPDATA%\terraform.d\plugins\${host_name}\${namespace}\${type}\${version}\${target} ``` -ВНИМАНИЕ: для ОС Windows `%APP_DATA%` является каталогом, в котором будут помещены будущие файлы terraform. Где: -- host_name - имя хоста, держателя провайдера, например, digitalenergy.online +- host_name - имя хоста, держателя провайдера, например, basis - namespace - пространство имен хоста, например decort - type - тип провайдера, может совпадать с пространством имен, например, decort -- version - версия провайдера, например 1.2 -- target - версия ОС, например windows_amd64 -6. После этого, создайте файл `main.tf`. -7. Добавьте в него следующий блок +- version - версия провайдера, например 4.3.0 +- target - архитектура операционной системы, например windows_amd64 + +В примере ниже используется путь до провайдера на машине с ОС Linux: + +```bash +~/.terraform.d/plugins/basis/decort/decort/4.3.0/linux_amd64/tf-provider + ^ ^ ^ ^ ^ ^ + host_name | | | | | | + | | | | | + namespace | | | | | + | | | | + type | | | | + | | | + version | | | + | | + target | | + | + исполняемый файл | +``` + +6. После этого, создайте файл `main.tf` в рабочей директории, которая может находится в любом удобном для пользователя месте. +В данном примере, рабочая директория с файлом main.tf находится по пути: +```bash +~/work/tfdir/main.tf +``` +7. Добавьте в `main.tf` следующий блок ```terraform terraform { required_providers { decort = { - version = "4.1.0" - source = "digitalenergy.online/decort/decort" + version = "4.3.0" + source = "basis/decort/decort" } } } ``` -В поле `version` указывается версия провайдера. -Обязательный параметр -Тип поля - строка -ВНИМАНИЕ: Версии в блоке и в репозитории, в который был помещен провайдер должны совпадать! +В поле `version` указывается версия провайдера. +
+**ВНИМАНИЕ: Версии в блоке и в пути к исполняемому файлу провайдера должны совпадать!** В поле `source` помещается путь до репозитория с версией вида: + ```bash ${host_name}/${namespace}/${type} ``` -ВНИМАНИЕ: все параметры должны совпадать с путем репозитория, в котором помещен провайдер. + +**ВНИМАНИЕ: Версии в блоке и в пути к исполняемому файлу провайдера должны совпадать!** 8. Добавьте в файл блок с инициализацией провайдера. ```terraform provider "decort" { - authenticator = "oauth2" - #controller_url = - controller_url = "https://mr4.digitalenergy.online" - #oauth2_url = + authenticator = "oauth2" + controller_url = "https://mr4.digitalenergy.online" oauth2_url = "https://sso.digitalenergy.online" allow_unverified_ssl = true } ``` -9. В консоле выполнить команду +9. В консоли выполните команду ```bash terraform init ``` -10. Если все прошло хорошо - ошибок не будет. - -Более подробно о сборке провайдера можно найти по ссылке: [https://learn.hashicorp.com/tutorials/terraform/provider-use?in=terraform/providers](https://learn.hashicorp.com/tutorials/terraform/provider-use?in=terraform/providers) - +10. В случае успешной установки, Terraform инициализирует провайдер и будет готов к дальнейшей работе. diff --git a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md index ee7116b..fbdb7db 100644 --- a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md +++ b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md @@ -1,20 +1,11 @@ _Data source_ функция **decort_kvmvm** служит для получения информации об уже существующей в облачной платформе виртуальной машине (Virtual Machine, VM), созданной на базе системы виртуализации KVM. -## Изменения в 3.5.0 -- В возвращаемые значения добавлены поля, которые соответсвуют полям decort версии 3.8.5 -- Убраны входные опциональные поля rg_id и name - -## Изменения в 3.4.0 -- В возвращаемые значения добавлено новое поле shareable -- В возвращаемые значения добавлено новое поле size_max в блоке disks -- В возвращаемые значения добавлено новое поле size_used в блоке disks - ## Аргументы _Data source_ функция **decort_kvmvm** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| compute_id | int | :heavy_check_mark: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-Обзор-облачной-платформы-DECORT)). Если задан этот параметр, то параметры `name` и `rg_id` игнорируются. | +| compute_id | int | :heavy_check_mark: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-Обзор-облачной-платформы-DECORT)). | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа. @@ -191,6 +182,7 @@ _Data source_ функция **decort_kvmvm** принимает следующ | label | string | Наименование снимка | | res_id | string | Ссылка на снимок | | snap_set_guid | string | Установленный id снимка | +| reference_id | int | Reference ID | | snap_set_time | int | Установленное время снимка | | timestamp | int | Время снимка | diff --git a/06.01.06-Data-функция-decort_image_list-получение-информации-об-образах.md b/06.01.06-Data-функция-decort_image_list-получение-информации-об-образах.md index 2f317c1..18be488 100644 --- a/06.01.06-Data-функция-decort_image_list-получение-информации-об-образах.md +++ b/06.01.06-Data-функция-decort_image_list-получение-информации-об-образах.md @@ -11,10 +11,20 @@ _Data source_ функция **decort_image_list** принимает следу | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| sep_id | int | :x: | Фильтр по storage endpoint provider ID | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по имени | +| status | string | :x: | Фильтр по статусу | +| architecture | string | :x: | Фильтр по архитектуре | +| type_image | string | :x: | Фильтр по типу | +| image_size | int | :x: | Фильтр по размеру образа | +| sep_name | string | :x: | Фильтр по имени SEP | +| pool | string | :x: | Фильтр по Pool | +| public | bool | :x: | Фильтр публичных/приватных образов | +| hot_resize | bool | :x: | Фильтр образов, разрешающих hot resize | +| bootable | bool | :x: | Фильтр загрузочных образов | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | -| sep_id | int | :x: | Фильтр результата по storage endpoint provider ID | -| shared_with | int | :x: |Фильтр результата по доступности образа различным аккаунтам | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_image_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: @@ -63,10 +73,11 @@ _Data source_ функция **decort_image_list** принимает следу Пример вызова _data source_ функции **decort_image_list**: ```terraform data "decort_image_list" "il" { + #pool = "data03" + #bootable = true #page = 2 #size = 3 #sep_id = 123 - #shared_with = 123 } # once the above directive completes, images will be accessible # as data.decort_image_list.il.items diff --git a/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md b/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md index d1e0ba9..e5b1ca2 100644 --- a/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md +++ b/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md @@ -8,6 +8,10 @@ _Data source_ функция **decort_locations_list** принимает сле | Аргумент | Тип | Обязательный | Описание | | -------- | --- | ------------ | --------------- | +| flag | string | :x: | Поиск по флагу | +| name | string | :x: | Поиск по имени | +| by_id | int | :x: | Поиск по ID | +| location_code | string | :x: | Поиск по коду локации | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | @@ -30,6 +34,8 @@ _Data source_ функция **decort_locations_list** принимает сле ```terraform data "decort_locations_list" "ll" { + #name = "mr4" + #by_id = 1 #page = 2 #size = 3 } diff --git a/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md b/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md index d1641ae..2d6a100 100644 --- a/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md +++ b/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md @@ -6,6 +6,14 @@ _Data source_ функция **decort_rg_list** служит для получе _Data source_ функция **decort_rg_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по названию | +| account_id | int | :x: | Фильтр по ID аккаунта | +| account_name | string | :x: | Фильтр по имени аккаунта | +| created_after | int | :x: | Отдает все рес. группы созданные после определенного времени (unix timstamp) | +| created_before | int | :x: | Отдает все рес. группы созданные до определенного времени (unix timstamp) | +| status | string | :x: | Фильтр по статусу | +| lock_status | string | :x: | Фильтр по локстатусу | | includedeleted | bool | :x: | Включение удаленных rg в результат поиска | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.13-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md b/06.01.13-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md index b3b7332..05ead3b 100644 --- a/06.01.13-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md +++ b/06.01.13-Data-функция-decort_disk_list-получение-информации-о-всех-дисках.md @@ -2,15 +2,16 @@ _Data source_ функция **decort_disk_list** служит для получения информации об имеющихся дисках. -## Изменения в версии 3.4.0 -- В возвращаемые значения добавлено поле shareable -- В возвращаемые значения добавлено поле present_to -- Убраны поля compute_id и compute_name и заменены на поле computes, которое представляет из себя список структур [см. ниже](#описание-структуры-computes) - ## Аргументы _Data source_ функция **decort_disk_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID диска | +| name | string | :x: | Фильтр по имени диска | +| account_name | string | :x: | Фильтр по имени аккаунта | +| disk_max_size | int | :x: | Фильтр по макс. размеру диска | +| status | string | :x: | Фильтр по статусу | +| shared | bool | :x: | Фильтр по значению shared | | account_id | int | :x: | id аккаунта для получения списка дисков | | type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk | | page | int | :x: | Номер страниц | diff --git a/06.01.14-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md b/06.01.14-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md index 5cc3ead..9c67047 100644 --- a/06.01.14-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md +++ b/06.01.14-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md @@ -7,6 +7,11 @@ _Data source_ функция **decort_vins_list** служит для получ _Data source_ функция **decort_vins_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по имени | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| ext_ip | string | :x: | Фильтр по внешнему IP адресу | | includedeleted | bool| :x: | Включить в результат удаленные балансировщики | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | @@ -40,9 +45,14 @@ _Data source_ функция **decort_vins_list** принимает следу ```terraform data "decort_vins_list" "vins_list" { + #Фильтр по ID рес. группы + #опциональный параметр + #тип - число + #rg_id = 1600 + #включение удаленных vins в результат #опциональный параметр - #тип - будев тип + #тип - bool #если не задан - выводятся все неудаленные данные #include_deleted = true diff --git a/06.01.15-Data-функция-decort_extnet_list-получение-информации-о-всех-доступных-внешних-сетях.md b/06.01.15-Data-функция-decort_extnet_list-получение-информации-о-всех-доступных-внешних-сетях.md index 4eba82b..93c6b4a 100644 --- a/06.01.15-Data-функция-decort_extnet_list-получение-информации-о-всех-доступных-внешних-сетях.md +++ b/06.01.15-Data-функция-decort_extnet_list-получение-информации-о-всех-доступных-внешних-сетях.md @@ -6,6 +6,12 @@ _Data source_ функция **decort_extnet_list** служит для полу _Data source_ функция **decort_extnet_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по extnet ID | +| name | string | :x: | Фильтр по имени extnet | +| network | string | :x: | Фильтр по сети | +| vlan_id | int | :x: | Фильтр по VLAN ID | +| vnfdev_id | int | :x: | Фильтр по VnfDEV ID | +| status | string | :x: | Фильтр по статусу | | account_id | int | :x: | ID аккаунта для фильтрации результата поиска | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | @@ -27,7 +33,12 @@ data "decort_extnet_list" "el" { #id аккаунта для фильтрации результата #необязательный параметр #тип - число - #account_id = 1111111 + #account_id = 13 + + #Фильтр по имени extnet + #необязательный параметр + #тип - строка + #name = "test" #кол-во страниц для вывода #опицональный параметр diff --git a/06.01.18-Data-функция-decort_extnet-получение-информации-о-внешней-сети.md b/06.01.18-Data-функция-decort_extnet-получение-информации-о-внешней-сети.md index e0d8eaa..c7485da 100644 --- a/06.01.18-Data-функция-decort_extnet-получение-информации-о-внешней-сети.md +++ b/06.01.18-Data-функция-decort_extnet-получение-информации-о-внешней-сети.md @@ -17,7 +17,7 @@ _Data source_ функция **decort_extnet** принимает следующ | meta | []string | Мета информация | | check_ips | []string | Список ip адресов для проверки | | default | bool | Является ли сеть сетью по-умолчанию | -| default_qos | Struct{
e_rate int
e_burst int
guid string
in_burst int
in_rate int
} | Quality of Service по-умолчанию
Минимальное кол-во потерь
id сервиса
Потери в режиме burst
Потери в режиме rate
 
| +| default_qos | Struct{
e_rate int
guid string
in_burst int
in_rate int
} | Quality of Service по-умолчанию
Минимальное кол-во потерь
id сервиса
Потери в режиме burst
Потери в режиме rate
 
| | desc | string | Описание | | dns | []string | Список dns | | excluded | []string | Список исключенных ip-адресов | @@ -37,7 +37,7 @@ _Data source_ функция **decort_extnet** принимает следующ | shared_with | []int | Список ресурсов, имеющих доступ к сети | | status | string | Статус сети | | vlan_id | int | Идентификатор vlan | -| vnfs | Struct{
dhcp int
} | Информация о vnfs
Информация о dhsp
 
| +| vnfs | Struct{
dhcp int
} | Информация о vnfs
Информация о dhcp
 
| ## Пример использования Пример вызова _data source_ функции **decort_extnet**: diff --git a/06.01.20-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes.md b/06.01.20-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes.md index bcb5b07..0084ae0 100644 --- a/06.01.20-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes.md +++ b/06.01.20-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes.md @@ -7,6 +7,14 @@ _Data source_ функция **decort_account_computes_list** принимает | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | account_id | int | :heavy_check_mark: | ID аккаунта | +| compute_id | int | :x: | Фильтр по ID компьюта | +| name | string | :x: | Фильтр по имени компьюта | +| rg_name | string | :x: | Фильтр по имени рес. группы | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| tech_status | string | :x: | Фильтр по тех. статусу | +| ip_address | string | :x: | Фильтр по IP адресу | +| extnet_name | string | :x: | Фильтр по имени extnet | +| extnet_id | int | :x: | Фильтр по ID extnet | ## Возвращаемые значения @@ -44,6 +52,11 @@ data "decort_account_computes_list" "acl" { #тип - число account_id = 1111 + #id extnet + #опциональный параметр + #тип - число + extnet_id = 3 + } # once the above directive completes, account computes list will be accessible # as data.decort_account_computes_list.acl.items diff --git a/06.01.21-Data-функция-decort_account_consumed_units-получение-информации-об-используемых-ресурсах-аккаунта.md b/06.01.21-Data-функция-decort_account_consumed_units-получение-информации-об-используемых-ресурсах-аккаунта.md index 98db5e6..6deba74 100644 --- a/06.01.21-Data-функция-decort_account_consumed_units-получение-информации-об-используемых-ресурсах-аккаунта.md +++ b/06.01.21-Data-функция-decort_account_consumed_units-получение-информации-об-используемых-ресурсах-аккаунта.md @@ -19,6 +19,7 @@ _Data source_ функция **decort_account_consumed_units** принимае | cu_d | float | Размер используемых дисков, ГБ | | cu_i | float | Кол-во используемых публичных IP-адресов | | cu_m | float | Размер используемой RAM, МБ | +| cu_dm | float | Использованный размер хранилища виртуального диска | | cu_np | float | Кол-во траффика, ГБ | | gpu_units | float | Кол-во графических ядер | diff --git a/06.01.23-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках.md b/06.01.23-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках.md index 148fbe9..4a1d806 100644 --- a/06.01.23-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках.md +++ b/06.01.23-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках.md @@ -10,6 +10,12 @@ _Data source_ функция **decort_account_disks_list** принимает с | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | account_id | int | :heavy_check_mark: | ID аккаунта | +| disk_id | int | :x: | Фильтр по ID диска | +| name | string | :x: | Фильтр по имени диска | +| disk_max_size | int | :x: | Фильтр по макс. размеру диска | +| type | string | :x: | Фильтр по типу диска | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_account_disks_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: @@ -33,6 +39,10 @@ data "decort_account_disks_list" "adl" { #тип - число account_id = 11111 + #Фильтр по максимальному размеру диска + #опциональный параметр + #тип - число + disk_max_size = 50 } # once the above directive completes, account disks list will be accessible # as data.decort_account_disks_list.adl.items diff --git a/06.01.24-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом.md b/06.01.24-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом.md index c8844e7..c79cd92 100644 --- a/06.01.24-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом.md +++ b/06.01.24-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом.md @@ -7,6 +7,14 @@ _Data source_ функция **decort_account_flipgroups_list** принимае | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | account_id | int | :heavy_check_mark: | ID аккаунта | +| name | string | :x: | Фильтр по имени флипгруппы | +| flipgroup_id | int | :x: | Фильтр по ID флипгруппы | +| vins_id | int | :x: | Фильтр по ID ViNS | +| vins_name | string | :x: | Фильтр по имени ViNS | +| extnet_id | int | :x: | Фильтр по ID extnet | +| by_ip | string | :x: | Фильтр по IP адресу | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_account_flipgroups_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: @@ -43,7 +51,13 @@ data "decort_account_flipgroups_list" "afgl" { #обязательный параметр #тип - число account_id = 1111 + + #Фильтр по имени ViNS + #опциональный параметр + #тип - строка + vins_name = "vins1" } + # once the above directive completes, account flipgroups list will be accessible # as data.decort_account_flipgroups_list.afgl.items ``` diff --git a/06.01.25-Data-функция-decort_account_reserved_units-получение-информации-о-зарезервированных-ресурсах-аккаунта.md b/06.01.25-Data-функция-decort_account_reserved_units-получение-информации-о-зарезервированных-ресурсах-аккаунта.md index cc4447f..c98ffac 100644 --- a/06.01.25-Data-функция-decort_account_reserved_units-получение-информации-о-зарезервированных-ресурсах-аккаунта.md +++ b/06.01.25-Data-функция-decort_account_reserved_units-получение-информации-о-зарезервированных-ресурсах-аккаунта.md @@ -19,6 +19,7 @@ _Data source_ функция **decort_account_reserved_units** принимае | cu_d | float | Размер диска, ГБ | | cu_i | float | Кол-во публичных ip-адресов | | cu_m | float | Размер RAM, МБ | +| cu_dm | float | Использованный размер хранилища виртуального диска | | cu_np | float | Кол-во полученного/отданного трафика, ГБ | | gpu_units | float | Кол-во графических ядер | diff --git a/06.01.26-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта.md b/06.01.26-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта.md index 8a69a0f..fd524b3 100644 --- a/06.01.26-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта.md +++ b/06.01.26-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта.md @@ -7,6 +7,13 @@ _Data source_ функция **decort_account_rg_list** принимает сл | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | account_id | int | :heavy_check_mark: | ID аккаунта | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| vins_id | int | :x: | Фильтр по ID ViNS | +| vm_id | int | :x: | Фильтр по ID вирт. машины | +| name | string | :x: | Фильтр по имени рес. группы | +| status | string | :x: | Фильтр по статусу | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | ## Возвращаемые значения @@ -36,6 +43,11 @@ data "decort_account_rg_list" "argl" { #обязательный параметр #тип - число account_id = 11111 + + #Фильтр по имени рес. группы + #опциональный параметр + #тип - строка + name = "rg1" } # once the above directive completes, account rg list will be accessible # as data.decort_account_rg_list.argl.items diff --git a/06.01.27-Data-функция-decort_account_templates_list-получение-информации-о-шаблонах-аккаунта.md b/06.01.27-Data-функция-decort_account_templates_list-получение-информации-о-шаблонах-аккаунта.md index 0bde1e6..1249c55 100644 --- a/06.01.27-Data-функция-decort_account_templates_list-получение-информации-о-шаблонах-аккаунта.md +++ b/06.01.27-Data-функция-decort_account_templates_list-получение-информации-о-шаблонах-аккаунта.md @@ -7,6 +7,7 @@ _Data source_ функция **decort_account_templates_list** принимае | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | account_id | int | :heavy_check_mark: | ID аккаунта | +| include_deleted | bool | :x: | Включить в рез-тат удаленные шаблоны | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_account_templates_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: diff --git a/06.01.28-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта.md b/06.01.28-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта.md index 035b1d5..1b77eed 100644 --- a/06.01.28-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта.md +++ b/06.01.28-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта.md @@ -7,6 +7,12 @@ _Data source_ функция **decort_account_vins_list** принимает с | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | account_id | int | :heavy_check_mark: | ID аккаунта | +| vins_ id | int | :x: | Фильтр по ID ViNS | +| name | string | :x: | Фильтр по имени ViNS | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| ext_ip | string | :x: | Фильтр по внешнему IP | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | ## Возвращаемые значения diff --git a/06.01.29-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах.md b/06.01.29-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах.md index 04435fa..e086c47 100644 --- a/06.01.29-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах.md +++ b/06.01.29-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах.md @@ -6,6 +6,10 @@ _Data source_ функция **decort_account_list** служит для пол _Data source_ функция **decort_account_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID аккаунта | +| name | string | :x: | Фильтр по имени аккаунта | +| acl | string | :x: | Фильтр по ACL | +| status | string | :x: | Фильтр по статусу | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.30-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах.md b/06.01.30-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах.md index c40e71e..09e2d3f 100644 --- a/06.01.30-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах.md +++ b/06.01.30-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах.md @@ -6,7 +6,10 @@ _Data source_ функция **decort_account_deleted_list** служит для _Data source_ функция **decort_account_deleted_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| page | int | :x: | Номер страниц | +| by_id | int | :x: | Фильтр по ID аккаунта | +| name | string | :x: | Фильтр по имени аккаунта | +| acl | string | :x: | Фильтр по ACL | +| page | int | :x: | Номер страницы | | size | int | :x: | Размер страницы | diff --git a/06.01.31-Data-функция-decort_bservice_list-получение-информации-о-всех-доступных-базовых-сервисах.md b/06.01.31-Data-функция-decort_bservice_list-получение-информации-о-всех-доступных-базовых-сервисах.md index 439b5f0..93f1f56 100644 --- a/06.01.31-Data-функция-decort_bservice_list-получение-информации-о-всех-доступных-базовых-сервисах.md +++ b/06.01.31-Data-функция-decort_bservice_list-получение-информации-о-всех-доступных-базовых-сервисах.md @@ -6,6 +6,12 @@ _Data source_ функция **decort_bservice_list** служит для пол _Data source_ функция **decort_bservice_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по имени | +| rg_name | string | :x: | Фильтр по имени ресурсной группы | +| tech_status | string | :x: | Фильтр по тех. статусу | +| status | string | :x: | Фильтр по статусу | +| account_name | string | :x: | Фильтр по имени аккаунта | | account_id | int | :x: | ID аккаунта для фильтрации результата | | rg_id | int | :x: | ID ресурсной группы для фильтрации результата | | page | int | :x: | Номер страниц | diff --git a/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки.md b/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки.md index abe7e57..4d142c2 100644 --- a/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки.md +++ b/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки.md @@ -7,6 +7,14 @@ _Data source_ функция **decort_lb_list** принимает следую | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID балансировщика | +| name | string | :x: | Фильтр по имени балансировщика | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| tech_status | string | :x: | Фильтр по тех. статусу | +| status | string | :x: | Фильтр по статусу | +| front_ip | string | :x: | Фильтр по IP фронтенда | +| back_ip | string | :x: | Фильтр по IP бэкенда | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | | includedeleted | bool| :x: | Включить в результат удаленные балансировщики | diff --git a/06.01.38-Data-функция-decort_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md b/06.01.38-Data-функция-decort_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md index 2b8ba31..6256c56 100644 --- a/06.01.38-Data-функция-decort_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md +++ b/06.01.38-Data-функция-decort_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md @@ -7,6 +7,13 @@ _Data source_ функция **decort_lb_list_deleted** принимает сл | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID балансировщика | +| name | string | :x: | Фильтр по имени балансировщика | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| tech_status | string | :x: | Фильтр по тех. статусу | +| front_ip | string | :x: | Фильтр по IP фронтенда | +| back_ip | string | :x: | Фильтр по IP бэкенда | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md b/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md index 5ad85a5..45273ba 100644 --- a/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md +++ b/06.01.41-Data-функция-decort_disk_list_deleted-получение-информации-об-удаленных-дисках.md @@ -6,6 +6,11 @@ _Data source_ функция **decort_disk_list_deleted** служит для п _Data source_ функция **decort_disk_list_deleted** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID диска | +| name | string | :x: | Фильтр по имени диска | +| account_name | string | :x: | Фильтр по имени аккаунта | +| disk_max_size | int | :x: | Фильтр по макс. размеру диска | +| shared | bool | :x: | Фильтр по shared | | account_id | int | :x: | id аккаунта для получения списка дисков | | type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk | | page | int | :x: | Номер страниц | @@ -44,6 +49,7 @@ _Data source_ функция **decort_disk_list_deleted** принимает с | sep_id | int | id sep | | sep_type | string | Тип sep | | size_max | int | Максимальный размер диска | +| shareable | bool | Разрешено ли делиться диском | | snapshots | []Struct{
guid string
label string
res_id string
snap_set_guid string
snap_set_time int
timestamp int
} | Информация о снимках состояний диска
guid снимка
Наименование снимка
id ресурса снимка
Установленный guid снимка
Установленное время снимка
Время снимка
 
| | status | string | Статус диска | tech_status | string | Технический статус диска | diff --git a/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md b/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md index 7c97969..3b42dd5 100644 --- a/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md +++ b/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md @@ -6,7 +6,15 @@ _Data source_ функция **decort_disk_list_unattached** служит для _Data source_ функция **decort_disk_list_unattached** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID диска | +| name | string | :x: | Фильтр по имени диска | +| account_name | string | :x: | Фильтр по имени аккаунта | +| disk_max_size | int | :x: | Фильтр по макс. размеру диска | +| status | string | :x: | Фильтр по статусу | | account_id | int | :x: | id аккаунта для получения списка дисков | +| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_disk_list_unattached** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: diff --git a/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md b/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md index a93d13b..6148236 100644 --- a/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md +++ b/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md @@ -7,6 +7,14 @@ _Data source_ функция **decort_k8s_list** служит для получ _Data source_ функция **decort_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 балансировщика | +| bservice_id | int | :x: | Фильтр по ID basic service | +| status | string | :x: | Фильтр по статусу | +| tech_status | string | :x: | Фильтр по тех. статусу | | includedeleted | bool| :x: | Включить в результат удаленные балансировщики | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.47-Data-функция-decort_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md b/06.01.47-Data-функция-decort_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md index dbed0c7..8167a07 100644 --- a/06.01.47-Data-функция-decort_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md +++ b/06.01.47-Data-функция-decort_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s.md @@ -7,6 +7,14 @@ _Data source_ функция **decort_k8s_list_deleted** служит для п _Data source_ функция **decort_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 балансировщика | +| bservice_id | int | :x: | Фильтр по ID basic service | +| status | string | :x: | Фильтр по статусу | +| tech_status | string | :x: | Фильтр по тех. статусу | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.53-Data-функция-decort_vins_list_deleted-получение-информации-о-удаленных-виртуальных-сетях.md b/06.01.53-Data-функция-decort_vins_list_deleted-получение-информации-о-удаленных-виртуальных-сетях.md index 6124fbf..52f3706 100644 --- a/06.01.53-Data-функция-decort_vins_list_deleted-получение-информации-о-удаленных-виртуальных-сетях.md +++ b/06.01.53-Data-функция-decort_vins_list_deleted-получение-информации-о-удаленных-виртуальных-сетях.md @@ -7,6 +7,11 @@ _Data source_ функция **decort_vins_list_deleted** служит для п _Data source_ функция **decort_vins_list_deleted** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID ViNS | +| name | string | :x: | Фильтр по имени ViNS | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID ресгруппы | +| ext_ip | string | :x: | Фильтр по внешнему IP адресу | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md b/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md index e6f52c7..96375d1 100644 --- a/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md +++ b/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md @@ -7,6 +7,16 @@ _Data source_ функция **decort_kvmvm_list** служит для полу _Data source_ функция **decort_kvmvm_list** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по имени | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID ресурсной группы | +| rg_name | string | :x: | Фильтр по имени рес. группы | +| tech_status | string | :x: | Фильтр по тех.статусу | +| status | string | :x: | Фильтр по статусу | +| ip_address | string | :x: | Фильтр по IP адресу | +| extnet_name | string | :x: | Фильтр по имени внешней сети | +| extnet_id | int | :x: | Фильтр по extnet ID | | includedeleted | bool| :x: | Включить в результат удаленные ресурсы | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md b/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md index d613949..9606005 100644 --- a/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md +++ b/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md @@ -9,6 +9,14 @@ _Data source_ функция **decort_rg_list** принимает следую | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID рес. группы | +| name | string | :x: | Фильтр по имени рес. группы | +| account_id | int | :x: | Фильтр по ID аккаунта | +| account_name | string | :x: | Фильтр по имени аккаунта | +| created_after | int | :x: | Фильтр рес. групп, созданных после опредленного момента во времени (unix timestamp) | +| created_before | int | :x: | Фильтр рес. групп, созданных перед опредленным моментом во времени (unix timestamp) | +| status | string | :x: | Фильтр по статусу | +| lock_status | string | :x: | Фильтр по lock статусу | | includedeleted | bool| :x: | Включить в результат удаленные ресурсы | | page | int | :x: | Номер страниц | | size | int | :x: | Размер страницы | diff --git a/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md b/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md index 047e9b9..e45c010 100644 --- a/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md +++ b/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md @@ -9,8 +9,17 @@ _Data source_ функция **decort_rg_list_computes** принимает сл | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | -| reason | :x: | string | Причина вызова | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы | +| compute_id | int | :x: | Фильтр по ID компьюта | +| name | string | :x: | Фильтр по имени компьюта | +| account_id | int | :x: | Фильтр по ID аккаунта | +| tech_status | string | :x: | Фильтр по тех. статусу | +| status | string | :x: | Фильтр по статусу | +| ip_address | string | :x: | Фильтр по IP адресу | +| extnet_name | string | :x: | Фильтр по имени extnet | +| extnet_id | int | :x: | Фильтр по ID extnet | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. diff --git a/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md b/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md index 4413292..498132c 100644 --- a/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md +++ b/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md @@ -9,7 +9,14 @@ _Data source_ функция **decort_rg_list_deleted** принимает сл | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| page | int | :x: | Номер страниц | +| by_id | int | :x: | Фильтр по ID рес. группы | +| name | string | :x: | Фильтр по имени рес. группы | +| account_id | int | :x: | Фильтр по ID аккаунта | +| account_name | string | :x: | Фильтр по имени аккаунта | +| created_after | int | :x: | Фильтр рес. групп, созданных после опредленного момента во времени (unix timestamp) | +| created_before | int | :x: | Фильтр рес. групп, созданных перед опредленным моментом во времени (unix timestamp) | +| lock_status | string | :x: | Фильтр по lock статусу | +| page | int | :x: | Номер страницы | | size | int | :x: | Размер страницы | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. diff --git a/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md b/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md index e979d42..c152b91 100644 --- a/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md +++ b/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md @@ -10,6 +10,15 @@ _Data source_ функция **decort_rg_list_lb** принимает следу | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| by_id | int | :x: | Фильтр по ID балансировщика | +| name | string | :x: | Фильтр по имени балансировщика | +| account_id | int | :x: | Фильтр по ID аккаунта | +| tech_status | string | :x: | Фильтр по тех. статусу | +| status | string | :x: | Фильтр по статусу | +| front_ip | string | :x: | Фильтр по IP фронтенда | +| back_ip | string | :x: | Фильтр по IP бэкенда | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. diff --git a/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md b/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md index 5f59643..b53894f 100644 --- a/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md +++ b/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md @@ -9,8 +9,13 @@ _Data source_ функция **decort_rg_list_vins** принимает след | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | -| reason | :x: | string | Причина вызова | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы | +| name | string | :x: | Фильтр по имени ViNS | +| account_id | int | :x: | Фильтр по ID аккаунта | +| ext_ip | string | :x: | Фильтр по внешнему IP | +| vins_id | int | :x: | Фильтр по ID ViNS | +| page | int | :x: | Номер страницы | +| size | int | :x: | Размер страницы | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. diff --git a/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md b/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md index 323890e..038e704 100644 --- a/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md +++ b/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md @@ -11,17 +11,12 @@ _Data source_ функция **decort_flipgroup** служит для получ | Параметр | Тип | Описание | | ------------ | ------- | ------------------------------------------ | | account_id | int | ID аккаунта | -| account_name | string | Имя аккаунта | | client_ids | []int | Список ID подключенных к группе клиентов | -| client_names | []string | Список имен подключенных клиентов | | client_type | string | Тип клиентов, подключаемых к группе | | conn_id | int | ID подключения | +| net_mask | int | Маска сети | | conn_type | string | Тип подключения | -| created_by | string | Кем создана группа | -| created_time | int | Время создания | | default_gw | string | Шлюз по умолчанию | -| deleted_by | string | Кем удалена группа | -| deleted_time | int | Время удаления | | desc | string | Описание группы | | gid | int | Grid ID платформы | | guid | int | ID флипгруппы на платформе (=flipgroup_id) | @@ -29,12 +24,7 @@ _Data source_ функция **decort_flipgroup** служит для получ | name | string | Наименование плавающей группы | | net_id | int | ID сети | | net_type | string | Тип сети (EXTNET/ViNS) | -| network | string | Сеть | -| rg_id | int | ID ресурсной группы | -| rg_name | string | Наименование ресурсной группы | | status | string | Статус плавающей группы | -| updated_by | string | Кем обновлена группа | -| updated_time | int | Время обновления | ## Пример использования diff --git a/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md b/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md index 98216b6..07d5244 100644 --- a/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md +++ b/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md @@ -4,6 +4,13 @@ _Data source_ функция **decort_flipgroup_list** служит для по | Аргумент | Тип | Обязательный | Описание | | -------- | --- | ------------ | -------- | +| by_id | int | :x: | Фильтр по ID | +| name | string | :x: | Фильтр по названию | +| vins_id | int | :x: | Фильтр по ViNS ID | +| vins_name | string | :x: | Фильтр по имени ViNS | +| extnet_id | int | :x: | Фильтр по ID extnet | +| by_ip | string | :x: | Фильтр по IP-адресу | +| rg_id | int | :x: | Фильтр по ID рес. группы | | page | int | :x: | Номер страницы | | size | int | :x: | Размер страницы | @@ -12,17 +19,12 @@ _Data source_ функция **decort_flipgroup_list** служит для по | Параметр | Тип | Описание | | ------------ | ------- | ------------------------------------------ | | account_id | int | ID аккаунта | -| account_name | string | Имя аккаунта | | client_ids | []int | Список ID подключенных к группе клиентов | -| client_names | []string | Список имен подключенных клиентов | | client_type | string | Тип клиентов, подключаемых к группе | | conn_id | int | ID подключения | +| net_mask | int | Маска сети | | conn_type | string | Тип подключения | -| created_by | string | Кем создана группа | -| created_time | int | Время создания | | default_gw | string | Шлюз по умолчанию | -| deleted_by | string | Кем удалена группа | -| deleted_time | int | Время удаления | | desc | string | Описание группы | | gid | int | Grid ID платформы | | guid | int | ID флипгруппы на платформе (=flipgroup_id) | @@ -30,12 +32,7 @@ _Data source_ функция **decort_flipgroup_list** служит для по | name | string | Наименование плавающей группы | | net_id | int | ID сети | | net_type | string | Тип сети (EXTNET/ViNS) | -| network | string | Сеть | -| rg_id | int | ID ресурсной группы | -| rg_name | string | Наименование ресурсной группы | | status | string | Статус плавающей группы | -| updated_by | string | Кем обновлена группа | -| updated_time | int | Время обновления | ## Пример использования @@ -53,4 +50,4 @@ data "decort_flipgroup_list" "fg_list" { } ``` -После успешного завершения такого вызова **decort_flipgroup_list** в переменной `data.decort_flipgroup_list.fg` будут сохранены возвращаемые значения. +После успешного завершения такого вызова **decort_flipgroup_list** в переменной `data.decort_flipgroup_list.fg_list` будут сохранены возвращаемые значения. diff --git a/06.01.76-Data-функция-decort_k8ci_list-получение-информации-о-k8ci.md b/06.01.76-Data-функция-decort_k8ci_list-получение-информации-о-k8ci.md new file mode 100644 index 0000000..a7acd2d --- /dev/null +++ b/06.01.76-Data-функция-decort_k8ci_list-получение-информации-о-k8ci.md @@ -0,0 +1,51 @@ +_Data source_ функция **decort_k8ci_list** служит для получения информации о доступных k8ci + +## Аргументы + +| Аргумент | Тип | Обязательный | Описание | +| -------- | --- | ------------ | -------- | +| by_id | int | :x: | Фильтр по ID k8ci | +| name | string | :x: | Фильтр по имени | +| 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) + +| Параметр | Тип | Описание | +| ------------ | ------- | ---------------------------------------- | +| k8ci_id | int | ID k8ci | +| name | string | Наименование k8ci | +| lb_image_id | int | ID образа балансировщика | +| network_plugins | []string | Список доступных плагинов сети | +| status | string | Статус | +| desc | string | Описание | +| created_time | int | Время создания | +| version | string | Версия | + +## Пример использования + +```terraform +data "decort_k8ci_list" "k8ci_list" { + # Фильтр по ID + # Опциональный параметр + # int + by_id = 1 + + # Номер страницы + # Опциональный параметр + # int + page = 0 + + # Размер страницы + # Опциональный параметр + # int + size = 0 +} +``` + +После успешного завершения такого вызова **decort_k8ci_list** в переменной `data.decort_k8ci_list.k8ci_list` будут сохранены возвращаемые значения. diff --git a/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md b/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md new file mode 100644 index 0000000..1c7dbd5 --- /dev/null +++ b/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md @@ -0,0 +1,88 @@ +_Data source_ функция **decort_cb_extnet** служит для получения информации о внешней сети. + +**Для того чтобы использовать данную Resource функцию требуются права администратора!** + +## Аргументы +_Data source_ функция **decort_cb_extnet** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| net_id | int | :heavy_check_mark: | Идентификатор сети | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_extnet** возвращает следующие параметры: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| ckey | string | CKey | +| meta | []string | Meta | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| desc | string | Описание внешней сети | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| ipcidr | string | IP CIDR | +| extnet_id | int | ID внешней сети | +| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | +| milestones | int | Вехи | +| network_id | int | ID сети | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| pre_reservations_num | int | Кол-во резерваций | +| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vlan_id | int | vLAN ID | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| reservations | []Struct{} [см.ниже](#описание-блока-reservations) | Резервации | + +### Описание блока default_qos + +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | Egress Rate | +| guid | string | Grid Unique ID | +| in_rate | int | Ingress Rate | +| in_burst | int | Ingress Burst | + +### Описание блока vnfs + +| Параметр | Тип | Описание | +| --- | --- | --- | +| dhcp | int | ID DHCP | + +### Описание блока excluded + +| Параметр | Тип | Описание | +| --- | --- | --- | +| client_type | string | Тип клиента | +| domain_name | string | Имя домена | +| hostname | string | Имя хоста | +| ip | string | IP адрес клиента | +| mac | string | MAC адрес клиента | +| type | string | Тип исключения | +| vm_id | int | VM ID | + +### Описание блока reservations + +| Параметр | Тип | Описание | +| --- | --- | --- | +| client_type | string | Тип клиента | +| domain_name | string | Имя домена | +| desc | string | Описание | +| hostname | string | Имя хоста | +| ip | string | IP адрес клиента | +| mac | string | MAC адрес клиента | +| type | string | Тип исключения | +| vm_id | int | VM ID | + +## Пример использования + +```terraform +data "decort_cb_extnet" "e" { + # Идентификатор сети + # Обязательный параметр + # Тип - число + net_id = 1111 +} +``` + +После успешного завершения такого вызова **decort_cb_extnet** в переменной `data.decort_cb_extnet.e` будут сохранены возвращаемые значения. diff --git a/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md b/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md new file mode 100644 index 0000000..a2971b0 --- /dev/null +++ b/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md @@ -0,0 +1,88 @@ +_Data source_ функция **decort_cb_extnet_list** служит для получения информации о внешней сети. + +**Для того чтобы использовать данную Resource функцию требуются права администратора!** + +## Аргументы +_Data source_ функция **decort_cb_extnet_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по extnet ID | +| name | string | :x: | Фильтр по имени extnet | +| network | string | :x: | Фильтр по сети | +| vlan_id | int | :x: | Фильтр по VLAN ID | +| vnfdev_id | int | :x: | Фильтр по VnfDEV ID | +| status | string | :x: | Фильтр по статусу | +| account_id | int | :x: | ID аккаунта для фильтрации результата поиска | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_extnet_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| ckey | string | CKey | +| meta | []string | Meta | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| desc | string | Описание внешней сети | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| ipcidr | string | IP CIDR | +| extnet_id | int | ID внешней сети | +| milestones | int | Вехи | +| network_id | int | ID сети | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| pre_reservations_num | int | Кол-во резерваций | +| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vlan_id | int | vLAN ID | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | + +### Описание блока default_qos + +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | Egress Rate | +| guid | string | Grid Unique ID | +| in_rate | int | Ingress Rate | +| in_burst | int | Ingress Burst | + +### Описание блока vnfs + +| Параметр | Тип | Описание | +| --- | --- | --- | +| dhcp | int | ID DHCP | + + +## Пример использования +Пример вызова _data source_ функции **decort_cb_extnet_list**: +```terraform +data "decort_cb_extnet_list" "el" { + #id аккаунта для фильтрации результата + #необязательный параметр + #тип - число + account_id = 13 + + #Фильтр по имени extnet + #необязательный параметр + #тип - строка + name = "test" + + #кол-во страниц для вывода + #опицональный параметр + #тип - число + page = 1 + + #размер страницы + #опицональный параметр + #тип - число + size = 1 +} +# once the above directive completes, extnet list will be accessible +# as data.decort_extnet_list.el.items +``` + +После успешного завершения такого вызова **decort_cb_extnet_list** в переменной `data.decort_cb_extnet_list.el` будут сохранены возвращаемые значения. diff --git a/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md b/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md index db38cdd..b70c75a 100644 --- a/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md +++ b/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md @@ -1,52 +1,5 @@ _Resource_ функция **decort_kvmvm** служит для управления виртуальными машинами, создаваемыми в платформе DECORT на базе технологии виртуализации KVM. -## Изменения в версии 3.5.2 -- Добавлен функционал, который позволяет изменять параметр size у диска в блоке disks и размер диска будет обновлен не только в стейте, но и на платформе - -## Изменения в 3.5.0 -- Обновлен блок disks, вывод в стейт сортируется -- Добавлен блок tags -- Добавлен блок port_forwarding -- Добавлен блок user_access -- Добавлен блок snapshot -- Добавлен блок rollback -- Добавлен блок cd -- Добавлено поле pin_to_stack -- Добавлено поле pause -- Добавлено поле reset -- Добавлена возможность сделать редеплой машины, при изменении поля image_id -- Добавлено поле data_disks, для редеплоя -- Добавлено поле auto_start, для редеплоя -- Добавлено поле force_stop, для редеплоя -- Добавлено возвращение не критичных ошибок при создании ресурса (warnings) -- Добавлена проверка на доступность входных параметров – rg_id, image_id, vins_id в блоке network. Проверка выполняется во время создания или обновления ресурса - -## Изменения в 3.4.1 -- Добавлено поле affinity_label -- Добавлены блоки affinity_rules -- Добавлены блоки anti_affinity_rules - -## Изменения в 3.4.0 -- В аргументы добавлено новое поле shareable -- В возвращаемые значения добавлено новое поле size_max в блок disks -- В возвращаемые значения добавлено новое поле size_used в блок disks - -## Изменения в 3.2.2 -Добавлена обработка статусов виртуальной машины. -Если статус __DELETED__, то при попытке изменения конфигурационного файла, машина будет автоматически восстановлена. -Если статус __DESTROYED__, то при попытке изменения конфигурационного файла, машина будет автоматически пересоздана. -Начиная с версии 3.2.2, в ресурсе kvmvm появляется опциональное поле `enabled`, которое принимает в себя булево значение. Поле отвечает за ручную регуляцию статуса доступности вычислительной машины, автоматическая регуляция так же имеется - восстановленная и вновь созданная виртуальная машине переводится в режим `enabled = true`. - -## Изменения в 3.2.1 -Начиная с версии 3.2.1, в ресурсе kvmvm имеется возможность задать конфигурацию сети, с которой будет происходить создание. Такой сетью является первый блок __network__ в конфигурационном файле, описывающем ресурс виртуальной машины. Все остальные блоки, если они были добавлены при создании ресурса, являются сетями, которые будут подключены с помощью вызова метода cloudapi/netAttach. -Если блоков __network__ не было задано при создании ресурса, то будет использован `net_type = NONE` - -## Изменения в 3.2.0 -Начиная с версии 3.2.0, в ресурсе kvmvm появился дополнительный блок - disks. Данный блок позволяет автоматически создавать диски и прикреплять их к виртуальной машине. Основные отличия от extra_disks заключаются в следующем: -- Диск автоматически создается, в extra_disks осуществляется присоединение уже созданных дисков. -- Диск позволяет использовать системный образ для создания. -Блоков disks может быть 0 и более. - ### Возможные затруднения при работе с блоком disks. По умолчанию, sep_id и pool в платформе выбираются те же, на которых размещается загрузочный диск (создается вместе с виртуальной машиной). Из-за этого, могут возникать ошибки следующего характера: - `Cannot add disk to Compute ID XXX: Pool xxxx does not support disk type X ` - данная ошибка означает то, что выбранный пул не поддерживает выбранные тип диска @@ -55,20 +8,84 @@ _Resource_ функция **decort_kvmvm** служит для управлен - Заполнить поля sep_id и pool подходящими полями для диска. - При удалении не последнего блока в списке, перед подтверждением Terraform не правильно отображает диск, который будет удаляться. На самом деле из состояние будет удален тот диск, который был убран из файла. Также будет нужен дополнительное выполнение terraform apply для того чтобы все блоки сейта терраформа встали на свои места и не отличались от настоящего состояния ресурса +### Работа с cloud_init +Cloud Init позволяет запустить ВМ с предустановленными настройками пользователя, группами и доступами. Подробнее про настройку cloud_init можно прочесть по [ссылке](#https://cloudinit.readthedocs.io/en/latest/reference/examples.html). + +**Пароли, указанные в cloud_init не сохраняются на платформе и не отображаются в API!** + +Для использования cloud_init конфигурации, следует: +1. Создать файл с расширением `.tftpl` в рабочей директории. +2. Описать в созданном файле конфигурацию cloud_init в формате JSON или YAML: + +### initconfig.tftpl +``` +{ + "users": [ + { + "groups": "users, wheel", + "name": "user", + "plain_text_passwd": "examplePassword", + "primary_group": "user", + "ssh_authorized_keys": [ + "ssh-rsa EXAMPLE%id_rsa.pub" + ], + "sudo": "ALL=(ALL) NOPASSWD:ALL" + } + ] +} +``` + +3. Указать путь до файла `initconfig.tftpl` в качестве значения параметра `cloud_init` в ресурсе `decort_kvmvm`: +```terraform +resource "decort_kvmvm" "compute1" { + # ... + + cloud_init = file("initconfig.tftpl") + + # ... +} +``` +4. Выполнить `terraform apply` + +**Конфигурация cloud_init применяется только при создании компьюта, во всех остальных случаях - игнорируется** + +### Работа с custom_fields + +CustomFields - это новый метод работы с XML ВМ, пришедший на замену ComputeCI начиная с версии провайдера 4.3.0. +Для описания конфигурации используется файл в формате JSON, например: + +customfields.json: +``` +{ + "title": "test", + "name": "basename", + "cpu": { + "mode": "host-model" + } +} +``` + +После этого, достаточно передать файл в качестве значения параметра: +``` +custom_fields = file("customfields.json") +``` + ## Аргументы _Resource_ функция **decort_kvmvm** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| driver | string | :heavy_check_mark: | Аппаратная архитектура виртуальной машины.
Может принимать одно из следующих значений:
* "KVM_X86" - виртуальная машина KVM на аппаратной платформе x86.
* "KVM_PPC" - виртуальная машина KVM на аппаратной платформе IBM Power. | +| driver | string | :heavy_check_mark: | Аппаратная архитектура виртуальной машины.
Может принимать одно из следующих значений:
* "KVM_X86" - stateful виртуальная машина KVM на аппаратной платформе x86.
* "SVA_KVM_X86" - stateless ВМ на аппаратной платформе x86.
* "KVM_PPC" - виртуальная машина KVM на аппаратной платформе IBM Power. | | cpu | int | :heavy_check_mark: | Количество процессоров. | | name | string | :heavy_check_mark: | Имя виртуальной машины. Обратите внимание, что имя должно быть уникальным в рамках ресурсной группы. | | rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы, которой принадлежит данная виртуальная машина. | | ram | int | :heavy_check_mark: | Объём оперативной памяти в МБ.
| | image_id | int | :heavy_check_mark: | Идентификатор образа, на базе которого создаётся загрузочный диск виртуальной машины.
| | boot_disk_size | int | :heavy_check_mark: | Размер загрузочного диска виртуальной машины в ГБ. | +| custom_fields | string (json-encoded) | :x: | Управление XML виртуальной машины | | extra_disks | []int | :x: | Список идентификаторов дополнительных дисков, которые требуется подключить к данной виртуальной машине помимо загрузочного диска. | | cloud_init | string | :x: | Используется на этапе создания вм.
Параметры для утилиты _cloud_init_, которая используется в платформе DECORT для первичного конфигурирования виртуальной машины после её создания. | +| with_default_vins | bool | :x: | При значении false ВМ создается без подключения стандартных ViNS ресурсной группы. При указании хотя бы одного блока network (см. ниже) данный параметр игнорируется. Дефолтное значение - true. | | network | []Struct [см. ниже](#описание-блока-network) | :x: | Параметры сетевого подключения. Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение.| | description | string | :x: | Текстовое описание виртуальной машины. | | started | bool | :x: | Флаг запуска машины,
по-умолчанию - true.
Если true - машина включена,
если false - выключена. | @@ -346,11 +363,14 @@ resource "decort_kvmvm" "my_new_vm" { extra_disks = [ 56789 ] image_id = data.decort_image.os_image.id description = "Test KVM VM Compute managed by Terraform" + + cloud_init = file("initconfig.tftpl") # содержание файла см. ниже network { net_type = "EXTNET" net_id = 12 } + disks { disk_name = "test_disk" size = 10 @@ -385,6 +405,24 @@ resource "decort_kvmvm" "my_new_vm" { } ``` +### initconfig.tftpl +``` +{ + "users": [ + { + "groups": "users, wheel", + "name": "user", + "plain_text_passwd": "examplePassword", + "primary_group": "user", + "ssh_authorized_keys": [ + "ssh-rsa EXAMPLE%id_rsa.pub" + ], + "sudo": "ALL=(ALL) NOPASSWD:ALL" + } + ] +} +``` + Данный пример подразумевает, что ранее по тексту tf-файла : * выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). * создан ресурс типа decort_resgroup (см. _resource_ функцию [decort_resgroup](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами)) и результат записан в переменную _decort_resgroup.my_rg_ diff --git a/07.01.11-Resource-функция-decort_account-управление-аккаунтом.md b/07.01.11-Resource-функция-decort_account-управление-аккаунтом.md index 2fb1cb5..fd4c806 100644 --- a/07.01.11-Resource-функция-decort_account-управление-аккаунтом.md +++ b/07.01.11-Resource-функция-decort_account-управление-аккаунтом.md @@ -1,7 +1,12 @@ -Функция доступна в провайдере версии 2.3 и выше. - _Resource_ функция **decort_account** служит для управления аккаунтами. Аккаунты в платформе позволяют создавать ресурсные группы, вычислительные мощности (computes), виртуальные сети, управлять ресурсами и так далее. Аккаунты создают пользователи (user). Все административное взаимодействие внутри платформы строится на аккаунтах. +**Начиная с версии провайдера 4.3.0 аккаунты могут создавать только администраторы площадок.**
+**Пользователи без административных прав могут только импортировать существующие аккаунты, используя следующую команду:** +```bash +terraform import decort_account.<наименование-ресурса> +``` +После импорта конфигурации управление аккаунтом доступно в прежнем порядке. + ## Аргументы _Resource_ функция **decort_account** принимает следующие аргументы: diff --git a/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md b/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md new file mode 100644 index 0000000..efe0830 --- /dev/null +++ b/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md @@ -0,0 +1,137 @@ +_Resource_ функция **decort_cb_extnet** служит для управления внешними сетями. + +**Для того чтобы использовать данную Resource функцию требуются права администратора!** + +## Аргументы +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| name | string | :heavy_check_mark: | Наименование внешней сети | +| gid | int | :heavy_check_mark: | ID платформы | +| ipcidr | string | :heavy_check_mark: | CIDR адресация | +| vlan_id | int | :heavy_check_mark: | ID виртуальной локальной сети | +| gateway | string | :x: | Опциональный IP шлюза | +| dns | []string | :x: | Список DNS адресов | +| ntp | []string | :x: | Список NTP адресов | +| check_ips | []string | :x: | IP адреса для проверки доступности сети | +| virtual | bool | :x: | При значении true DHCP сервер **не** будет создан | +| start_ip | string | :x: | Начало диапазона включенных IP адресов | +| end_ip | string | :x: | Конец диапазона включенных IP адресов | +| vnfdev_ip | string | :x: | IP адрес для VNFDev | +| pre_reservations_num | int | :x: | Кол-во резерваций | +| ovs_bridge | string | :x: | Наименование моста OpenvSwitch внешней сети | +| enable | bool | :x: | Включить/Выключить внешнюю сеть | +| set_default | bool | :x: | При значении true - внешняя сеть становится дефолтной на платформе (невозможно отменить) | +| excluded_ips | []string | :x: | Список исключенных IP адресов | + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_extnet** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| ckey | string | CKey | +| meta | []string | Meta | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| extnet_id | int | ID внешней сети | +| milestones | int | Вехи | +| network_id | int | ID сети | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| pre_reservations_num | int | Кол-во резерваций | +| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | +| network | string | Сеть | +| prefix | string | Префикс | +| reservations | []Struct{} [см.ниже](#описание-блока-reservations) | Резервации | + +### Описание блока default_qos + +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | Egress Rate | +| guid | string | Grid Unique ID | +| in_rate | int | Ingress Rate | +| in_burst | int | Ingress Burst | + +### Описание блока vnfs + +| Параметр | Тип | Описание | +| --- | --- | --- | +| dhcp | int | ID DHCP | + +### Описание блока excluded + +| Параметр | Тип | Описание | +| --- | --- | --- | +| client_type | string | Тип клиента | +| domain_name | string | Имя домена | +| hostname | string | Имя хоста | +| ip | string | IP адрес клиента | +| mac | string | MAC адрес клиента | +| type | string | Тип исключения | +| vm_id | int | VM ID | + +### Описание блока reservations + +| Параметр | Тип | Описание | +| --- | --- | --- | +| client_type | string | Тип клиента | +| domain_name | string | Имя домена | +| desc | string | Описание | +| hostname | string | Имя хоста | +| ip | string | IP адрес клиента | +| mac | string | MAC адрес клиента | +| type | string | Тип исключения | +| vm_id | int | VM ID | + +## Пример использования + +```terraform +resource "decort_cb_extnet" "new_extnet" { + # Наименование внешней сети + # Обязательный параметр + # Тип - строка + name = "test_extnet" + + # ID платформы + # Обязательный параметр + # Тип - число + gid = 500 + + # CIDR + # Обязательный параметр + # Тип - строка + ipcidr = "192.168.0.0/24" + + # ID виртуальной локальной сети + # Обязательный параметр + # Тип - число + vlan_id = 111 + + # Список DNS адресов + # Опциональный параметр + # Тип - массив строк + dns = ["8.8.8.8", "9.9.9.9"] + + # Описание + # Опциональный параметр + # Тип - строка + desc = "test desc" + + # Включение/Выключение внешней сети + # Опциональный параметр (default = true) + # Тип - булев + enable = true + + # Список исключенных IP адресов + # Опциональный параметр + # Тип - массив строк + excluded_ips = ["192.168.0.4", "192.168.0.5"] +} +``` + +После успешного завершения такого вызова **decort_cb_extnet** в переменной `decort_cb_extnet.new_extnet` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index 65e7fa7..f07799d 100644 --- a/Home.md +++ b/Home.md @@ -66,6 +66,7 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_k8s**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.45-Data-функция-decort_k8s-получение-информации-о-кластере-k8s) - получение информацуии о кластере k8s - [**decort_k8s_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s) - получение информации о списке кластеров k8s - [**decort_k8s_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.47-Data-функция-decort_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s) - получение информации о списке удаленных кластеров k8s + - [**decort_k8ci_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.76-Data-функция-decort_k8ci_list-получение-информации-о-k8ci) - получение информации о списке доступных K8CI - [**decort_k8s_wg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.48-Data-функция-decort_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s) - получение информации о группе воркеров кластера k8s - [**decort_k8s_wg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.49-Data-функция-decort_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s) - получение информации о списке групп воркеров кластера k8s - [**decort_k8s_computes**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.74-Data-функция-decort_k8s_computes-получение-информации-о-виртуальных-машинах-кластера) - получение информации о виртуальных машинах кластера @@ -96,11 +97,11 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе) - получение информации о плавающей группе - [**decort_flipgroup_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах) - получение информации о плавающих группах - [Административная группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02-Административная-группа-API) - - [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM) - получение информации о виртуальной машине, созданной на базе системы виртуализации KVM + + + + + - [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети) - получение информации о внешней сети + - [**decort_cb_extnet_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях) - получение информации о списке внешних сетей 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT) - [Пользовательская группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01-Пользовательская-группа-API) - [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM @@ -150,9 +153,10 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.19-Resource-функция-decort_disk_snapshot-управление-снимком-диска) - управление снимком диска - [**decort_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.20-Resource-функция-decort_flipgroup-управление-плавающей-группой) - управление плавающей группой - [Административная группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02-Административная-группа-API) - - [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.11-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM - - [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.14-Resource-функция-decort_resgroup-управление-ресурсными-группами) - управление ресурсными группами - - [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами. + + - [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями) - управление внешними сетями + 8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы) - [Как хранить авторизационную информацию отдельно от tf-файла](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#81-Как-хранить-авторизационную-информацию-отдельно-от-tf-файла) - [Если Terraform провайдер DECORT жалуется на SSL сертификаты.](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#82-Если-terraform-провайдер-жалуется-на-ssl-сертификаты)