From 1c03c6ab4f4d12fa9130881842245d1a0ace630b Mon Sep 17 00:00:00 2001 From: KasimBaybikov Date: Mon, 13 Mar 2023 01:56:09 +0300 Subject: [PATCH] added all new articles and updated old ones --- ...ьной-машине-на-базе-KVM.md | 221 +++++++++++++++--- ...ии-о-ресурсной-группе.md | 60 ++++- ...ии-о-аудитах-компьюта.md | 32 +++ ...ии-о-аудитах-компьюта.md | 29 +++ ...е-url-консоли-компьюта.md | 27 +++ ...гов-по-заданному-пути.md | 28 +++ ...ии-о-списке-компьютов.md | 152 ++++++++++++ ...орвардингов-компьюта.md | 34 +++ ...льзователях-компьюта.md | 40 ++++ ...писке-ресурных-групп.md | 86 +++++++ ...ютах-аффинити-группы.md | 44 ++++ ...ии-о-аффинити-группах.md | 38 +++ ...ции-о-аффинити-группе.md | 38 +++ ...тах-ресурсной-группы.md | 42 ++++ ...тах-ресурсной-группы.md | 70 ++++++ ...нных-ресурсных-групп.md | 85 +++++++ ...информации-о-списке-lb.md | 85 +++++++ ...нформации-о-списке-pfw.md | 44 ++++ ...нформации-о-списке-vins.md | 53 +++++ ...ии-об-использовании-rg.md | 51 ++++ ...ми-машинами-на-базе-KVM.md | 201 ++++++++++++++-- ...-ресурсными-группами.md | 63 ++++- 22 files changed, 1463 insertions(+), 60 deletions(-) create mode 100644 06.01.55-Data-функция-decort_kvmvm_audits-получения-информации-о-аудитах-компьюта.md create mode 100644 06.01.56-Data-функция-decort_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md create mode 100644 06.01.57-Data-функция-decort_kvmvm_get_console_url-получение-url-консоли-компьюта.md create mode 100644 06.01.58-Data-функция-decort_kvmvm_get_log-получение-логов-по-заданному-пути.md create mode 100644 06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md create mode 100644 06.01.60-Data-функция-decort_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md create mode 100644 06.01.61-Data-функция-decort_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md create mode 100644 06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md create mode 100644 06.01.63-Data-функция-decort_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md create mode 100644 06.01.64-Data-функция-decort_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md create mode 100644 06.01.65-Data-функция-decort_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md create mode 100644 06.01.66-Data-функция-decort_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md create mode 100644 06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md create mode 100644 06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md create mode 100644 06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md create mode 100644 06.01.70-Data-функция-decort_rg_list_pfw-получение-информации-о-списке-pfw.md create mode 100644 06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md create mode 100644 06.01.72-Data-функция-decort_rg_usage-получение-информации-об-использовании-rg.md diff --git a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md index b3cf386..e94c44c 100644 --- a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md +++ b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md @@ -1,5 +1,9 @@ _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 @@ -10,8 +14,6 @@ _Data source_ функция **decort_kvmvm** принимает следующ | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| name | string | :x: | Имя виртуальной машины. Для идентификации виртуальной машины по её имени также необходимо указать идентификатор ресурсной группы, которой она принадлежит (`rg_id`).
Обратите внимание, что имя виртуальной машины уникально только в рамках одной и той же ресурсной группы и не может быть пустым.
Альтернативным способом идентификации виртуальной машины является задание параметра `compute_id`. | -| rg_id | int | :x: | Идентификатор ресурсной группы, которой принадлежит данный виртуальный сервер.
Данный аргумент является обязательным, если идентификация виртуальной машины выполняется по её имени. | | compute_id | int | :x: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). Если задан этот параметр, то параметры `name` и `rg_id` игнорируются. | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа. @@ -23,41 +25,207 @@ _Data source_ функция **decort_kvmvm** принимает следующ | Параметр | Тип | Описание | | --- | --- | --- | +| acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | | account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | | account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| affinity_label | string | Лейбл аффинити | +| affinity_rules | []Struct [см. ниже](#Описание-структуры-affinity-rules) | Правила аффинити для компьютов | +| affinity_weight | int | weight аффинити | +| arch | string | Архитектура | +| boot_order | []string | Boot order | | boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. | -| boot_disk_size | int | Размер загрузочного диска в ГБ. | -| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | -| cloud_init | string | Параметры cloud_init | -| cpu | int | Количество виртуальных CPU, выделенных данному серверу. | -| description | string | Текстовое описание виртуальной машины. | +| bootdisk_size | int | Размер загрузочного диска в ГБ. | +| clone_reference | int | кол-во клонов | +| clones | []int | id клонов | +| computeci_id | int | Id computeci | +| cpus | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кем создан ресурс | +| created_time | int | Время создания ресурса | +| custom_fields | []Struct [см. ниже](#Описание-структуры-custom-fields) | Кастомные поля | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Текстовое описание виртуальной машины. | +| devices | string | Девайсы | +| disks | []Struct [см. ниже](#Описание-структуры-disks)| информация о дисках компьюта | | driver | string | Аппаратная архитектура данной виртуальной машины. | -| extra_disks | list of ints | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. | -| id | int | Уникальный идентификатор этой виртуальной машины в облачной платформе. Всегда совпадает с `compute_id`. | +| gid | int | GID | +| guid | int | GUID | | image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | -| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | -| name | string | Имя виртуального сервера.
Возвращаемое значение `name` совпадает со значением соответствующего аргумента, переданного при вызове функции. | -| network | list of dicts | Характеристики сетевых сегментов, к которым подключен данный сервер. Формат структуры:
* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.
* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`
* (string) `ip_address` - IP адрес, выделенный данному подключению.
* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины. | -| os_users | list of dicts | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:
* (string) `login` - учётная запись в гостевой ОС.
* (string) `password` - пароль к этой учётной записи. | +| interfaces | []Struct [см. ниже](#Описание-структуры-interfaces) | Информация о интерфейсах компьюта | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type manager | +| migrationjob | int | Migrationjob | +| milestones | int | Вехи | +| name | string | Имя виртуального сервера | +| natable_vins_id | int | NAT vins id | +| natable_vins_ip | string | NAT vins ip | +| natable_vins_name | string | NAT vins name | +| natable_vins_network | string | NAT vins network | +| natable_vins_network_name | string | NAT vins network name | +| os_users | []Struct [см. ниже](#Описание-структуры-os-users) | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:
* (string) `login` - учётная запись в гостевой ОС.
* (string) `password` - пароль к этой учётной записи. | +| pinned | bool | добавлен ли компьют на стек | | ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| reference_id | string | ID reference | +| registered | bool | Компьют зарегестрирован | +| res_name | string | Res name | | rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | | rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | -| disks | см. ниже | :x: | Описание диска. Таких может быть любое кол-во, либо не быть вообще | +| snap_sets | []Struct [см. ниже](#Описание-структуры-snap-sets) | Snap sets | +| status | string | Cтатус | +| tags | map[string]string | Тэги | +| tech_status | string | Технический статус | +| updated_by | string | Кем обновлен ресурс | +| updated_time | int | Время обновления ресурса | +| user_managed | bool | User managed | +| userdata | string | Параметры cloud_init | +| vgpus | []int| Список vgpu | +| virtual_image_id | int | ID виртуального образа | +| virtual_image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_acl | []Struct [см. ниже](#Описание-структуры-List-acl) | Информация о списке пользователей аккаунтов | +| compute_acl | []Struct [см. ниже](#Описание-структуры-List-acl) | Информация о списке пользователей компьютов | +| rg_acl | []Struct [см. ниже](#Описание-структуры-List-acl) | Информация о списке пользователей ресурной группы | -### Описание блока disks -| Аргумент | Тип | Описание | +### Описание структуры affinity rules +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | guid | +| key | string | Ключ | +| mode | string | Режим сравнения | +| policy | string | Степень "строгости" этого правила | +| topology | string | Топология | +| value | string | Значение | + +### Описание структуры List acl +| Параметр | Тип | Описание | | --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры custom fields +| Параметр | Тип | Описание | +| key | string | Ключ | +| val | string | Значение | + +### Описание структуры os users +| Параметр | Тип | Описание | +| guid | string | GUID | +| login | string | Логин | +| password | string | Пароль | +| public_key | string | Публичный ssh ключ | + +### Описание структуры disks +| Параметр | Тип | Описание | +| \_ckey | string | ckey | +| acl | string | Acces Control List | +| account_id | int | ID аккаунта | +| boot_partition | int | Загрузочный раздел | +| created_time | int | Время создания диска | +| deleted_time | int | Время удаления диска | +| description | string | Описание | +| destruction_time | int | Время удаления | +| disk_path | string | Путь диска | +| gid | int | GID | +| guid | int | GUID | | disk_id | int | ID диска | -| disk_name | string | Наименование диска | -| size | int | Размер диска, GB | -| disk_type | string | Тип диска. Возможные значения: "D" - диск с данными, "B" - загрузочный диск | -| sep_id | int | ID storage endpoint | -| shareable | bool | Флаг, отвечающий за доступность диска дургим ресурсам | -| size_max | int | Размер диска | -| size_used | float | Размер занимаемого на диске места | -| pool | string | Наименование пула для размещения диска | -| desc | string | Описание диска | | image_id | int | ID образа | +| images | []int | Список образов | +| iotune | []Struct [см. ниже](#Описание-структуры-iotune)| Ограничения диска | +| iqn | string | iqn диска | +| login | string | Логин для доступа к диску | +| milestones | int | Вехи | +| name | string | Наименование диска | +| order | int | Номер диска | +| params | string | Параметры диска | +| parent_id | int | id родительского диска | +| passwd | string | Пароль для доступа к диску | +| pci_slot | int | id pci слота, к которому подключен диск | +| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск | +| present_to | []int | Список ID ресурсов, которым предоставлен диск | +| purge_time | int | Время последней попытки | +| reality_device_number | int | Реальный номер устройства | +| res_id | int | id ресурса | +| role | string | Роль диска | +| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | +| shareable | bool | Флаг, отвечающий за доступность диска дургим ресурсам | +| size_max | int | Размер диска в ГБ | +| size_used | float | Кол-во используемого места, в ГБ | +| snapshots | []Struct{}[см. ниже](#Описание-структуры-snapshots)| Снимки состояния диска| +| status | string | Статус диска | +| tech_status | string | Технический статус диска | +| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | +| vmid | int | Идентификатор виртуальной машины (устаревшее) | + +### Описание структуры iotune +| Параметр | Тип | Описание | +| read_bytes_sec | int | Кол-во байт для чтения в секунду | +| read_bytes_sec_max | int | Максимальное кол-во байт для чтения | +| read_iops_sec | int | Кол-во операций чтения io в секунду | | +| read_iops_sec_max | int | Максимальное число io операций чтения | +| size_iops_sec | int | Размер io операций | +| total_bytes_sec | int | Общий размер байт в секунду | +| total_bytes_sec_max | int | Максимальный общий размер байт в секунду | +| total_iops_sec | int | Общее кол-во io операций в секунду | +| total_iops_sec_max | int | Максимальное общее кол-во io операций в секунду | +| write_bytes_sec | int | Кол-во байт для записи в секунду | +| write_bytes_sec_max | int | Максимальное кол-во байт для записи в секунду | +| write_iops_sec | int | Кол-во операций записи в секунду | +| write_iops_sec_max | int | Максимальное число операций записей | + +### Описание структуры snapshots +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | id снимка | +| label | string | Наименование снимка | +| res_id | string | Ссылка на снимок | +| snap_set_guid | string | Установленный id снимка | +| snap_set_time | int | Установленное время снимка | +| timestamp | int | Время снимка | + +### Описание структуры interfaces +| Параметр | Тип | Описание | +| --- | --- | --- | +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| def_gw | string | Шлюз по умолчанию | +| flip_group_id | int | id flip group | +| guid | string | GUID | +| ip_address | string | IP адрес | +| listen_ssh | bool | открыт ли ssh connect | +| mac | string | MAC адрес устройства | +| name | string | Имя | +| net_id | int | ID сети | +| netmask | int | Маска сети | +| net_type | string | Тип сети | +| pci_slot | int | Pci Slot | +| qos | []Struct{}[см. ниже](#Описание-структуры-qos)| QOS | +| target | string | Цель сети | +| type | string | Тип | +| vnfs | []int | VNFS | + +### Описание структуры qos +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | E rate | +| guid | string | ID ресурса | +| in_brust | int | In brust | +| in_rate | int | In rate | + +### Описание структуры snap sets +| Параметр | Тип | Описание | +| --- | --- | --- | +| disks | []int | Список id дисков | +| guid | string | GUID | +| label | string | Лейбл | +| timestamp | int | Время | ## Пример использования В нижеприведённом примере посредством вызова _data source_ функции **decort_kvmvm** извлекается информация об уже существующем в платформе виртуальном сервере со следующими характеристиками: @@ -66,8 +234,7 @@ _Data source_ функция **decort_kvmvm** принимает следующ ```terraform data "decort_kvmvm" "existing_vm" { - name = "MyOldVM" # this is the name of pre-existing virtual machine - rg_id = 123 # this is the ID of resource group, where VM named "MyOldVM" is found + compute_id = 123 # this is the ID of compute } # Once the above directive completes, VM ID will be accessible # as data.decort_kvmvm.existing_vm.id diff --git a/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md b/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md index 09b0b72..f3a150f 100644 --- a/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md +++ b/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md @@ -4,6 +4,11 @@ _Data source_ функция **decort_resgroup** служит для получ Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_resgroup**. +## Изменения в 3.5.0 +- Убраны опциональные поля account_id и name +- Опциональное поле rg_id стало обязательным +- Возвращаемые значения приведены в соответвие с версией платформы 3.8.5 + ## Изменения в 3.4.0 - В возвращаемые значения добавлено новое поле gid - В возвращаемые значения добавлено новое поле resources @@ -17,9 +22,8 @@ _Data source_ функция **decort_resgroup** принимает следую | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| account_id | int | :x: | Идентификатор подписчика (aka "account"), которому принадлежит данная ресурсная группа. | -| name | string | :x: | Имя ресурсной группы, по которой требуется получить информацию. Имя ресурсной группы не может быть пустым. Обратите внимание, что имя ресурсной группы должно быть уникальным только в рамках одного и того же подписчика.
Ресурсная группа идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени самой группы или по её идентификатору (`rg_id`).
Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. | -| rg_id | int | :x: | Идентификатор ресурсной группы, по которой требуется получить информацию. Идентификатор не может быть нулевым.
Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы, по которой требуется получить информацию. Идентификатор не может быть нулевым.
Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. | +| reason | string | :x: | Причина исполнения | Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. @@ -30,20 +34,44 @@ _Data source_ функция **decort_resgroup** принимает следую | Параметр | Тип | Описание | | --- | --- | --- | +| resources | Struct{} [см. ниже](#Описание-структуры-resources)| Информация о занимаемых ресурсах | | account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. | | account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. | +| acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| created_by | string | Кем создан ресурс | +| created_time | int | Время создания ресурса | | def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | | def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | -| description | string | Текстовое описание данной ресурсной группы. | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Текстовое описание данной ресурсной группы. | +| dirty | bool | Dirty | | gid | int | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. | -| id | int | Идентификатор данной ресурсной группы. | +| guid | int | GUID | +| lock_status | string | Lock статус | +| milestones | int | Milestones | | name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). | -| quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу. | -| resources | Struct{} [см. ниже](#Описание-структуры-resources)| Информация о занимаемых ресурсах | -| rg_id | int | Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. | +| register_computes | bool | Флаг отвечающий за то зарегестрированы ли компьюты | +| resource_limits | [см. ниже](#Описание-структуры-resource-limits) | Лимиты ресурсов | +| secret | string | Секрет | | status | string | Статус resgroup | +| updated_by | string | Кем был сделан апдейт | +| updated_time | int | Время апдейта | | vins | []int | Список id виртуальных сетей | -| vms | []int | Список id виртуальных машин | +| computes | []int | Список id компьютов | +| res_types | []string | Res types | +| uniq_pools | []string | Uniq pools | +| id | int | Идентификатор данной ресурсной группы. | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | ### Описание структуры resources | Параметр | Тип | Описание | @@ -55,7 +83,8 @@ _Data source_ функция **decort_resgroup** принимает следую | Параметр | Тип | Описание | | --- | --- | --- | | cpu | int | Количество CPU | -| disksize | int | Размер диска | +| disk_size | int | Размер диска | +| disk_size_max | int | Максимальный размер диск | | extips | int | Внешние IPs | | exttraffic | int | Внешний Traffic | | gpu | int | Количество GPU | @@ -70,14 +99,21 @@ _Data source_ функция **decort_resgroup** принимает следую | disk_size | int | Количество занятого места | | disk_size_max | int | Размер диска | +### Описание структуры resources limits +| Параметр | Тип | Описание | +| --- | --- | --- | +| cu_c | float | Количество ядер CPU | +| cu_d | float | Размер диска | +| cu_i | float | Количество публичных IP адресов | +| cu_m | float | размер RAM | +| cu_np | float | Хранилище траффика | +| gpu_units | float | количество GPU ядер | ## Пример использования Пример вызова _data source_ функции **decort_resgroup**: ```terraform data "decort_resgroup" "target_rg" { - name = "test" # this is the name of pre-existing resource group - account_id = 100 # this is the ID of the account, where resource group named "test" is found rg_id = 123 } # Once the above directive completes, resource group ID will be accessible as diff --git a/06.01.55-Data-функция-decort_kvmvm_audits-получения-информации-о-аудитах-компьюта.md b/06.01.55-Data-функция-decort_kvmvm_audits-получения-информации-о-аудитах-компьюта.md new file mode 100644 index 0000000..d7a2e28 --- /dev/null +++ b/06.01.55-Data-функция-decort_kvmvm_audits-получения-информации-о-аудитах-компьюта.md @@ -0,0 +1,32 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_audits** служит для получения аудитов компьюта. + +## Аргументы + +_Data source_ функция **decort_kvmvm_audits** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_audits** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| call | string | Какая команда была выполнена | +| responsetime | float | Время выполнения | +| statuscode | int | Статус выполнения | +| timestamp | float | Точное время исполнения | +| user | string | Кем была выполнена команда | + +## Пример использования +```terraform +``data "decort_kvmvm_audits" "kvmvm_audits" { + compute_id = 10154 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_audits** в переменной `data.decort_kvmvm_audits.kvmvm_audits` будут сохранены возвращаемые значения. diff --git a/06.01.56-Data-функция-decort_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md b/06.01.56-Data-функция-decort_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md new file mode 100644 index 0000000..61b5972 --- /dev/null +++ b/06.01.56-Data-функция-decort_kvmvm_get_audits-получения-информации-о-аудитах-компьюта.md @@ -0,0 +1,29 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_get_audits** служит для получения аудитов компьюта. + +## Аргументы + +_Data source_ функция **decort_kvmvm_get_audits** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_get_audits** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| epoch | float | Время | +| message | string | Сообщение, которое несет в себе информацию о команде и том, кто ее исполнил | + +## Пример использования +```terraform +``data "decort_kvmvm_get_audits" "kvmvm_get_audits" { + compute_id = 10154 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_get_audits** в переменной `data.decort_kvmvm_get_audits.kvmvm_get_audits` будут сохранены возвращаемые значения. diff --git a/06.01.57-Data-функция-decort_kvmvm_get_console_url-получение-url-консоли-компьюта.md b/06.01.57-Data-функция-decort_kvmvm_get_console_url-получение-url-консоли-компьюта.md new file mode 100644 index 0000000..90e81d0 --- /dev/null +++ b/06.01.57-Data-функция-decort_kvmvm_get_console_url-получение-url-консоли-компьюта.md @@ -0,0 +1,27 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_get_console_url** служит для получения url консоли компьюта. + +## Аргументы + +_Data source_ функция **decort_kvmvm_get_console_url** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_get_console_url** возвращает в указанную при вызове переменную следующие значения: +| Параметр | Тип | Описание | +| --- | --- | --- | +| console_url | string | url консоли компьюта | + +## Пример использования +```terraform +``data "decort_kvmvm_get_console_url" "console_url" { + compute_id = 10154 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_get_console_url** в переменной `data.decort_kvmvm_get_console_url.console_url` будут сохранены возвращаемые значения. diff --git a/06.01.58-Data-функция-decort_kvmvm_get_log-получение-логов-по-заданному-пути.md b/06.01.58-Data-функция-decort_kvmvm_get_log-получение-логов-по-заданному-пути.md new file mode 100644 index 0000000..c17bbc6 --- /dev/null +++ b/06.01.58-Data-функция-decort_kvmvm_get_log-получение-логов-по-заданному-пути.md @@ -0,0 +1,28 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_get_log** служит для получения логов по заданному пути компьюта. + +## Аргументы + +_Data source_ функция **decort_kvmvm_get_log** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | +| path | string | :heavy_check_mark: | путь до файла | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_get_log** возвращает в указанную при вызове переменную следующие значения: +| Параметр | Тип | Описание | +| --- | --- | --- | +| log | string | логи | + +## Пример использования +```terraform +``data "decort_kvmvm_get_log" "get_log" { + compute_id = 10154 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_get_log** в переменной `data.decort_kvmvm_get_log.get_log` будут сохранены возвращаемые значения. diff --git a/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md b/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md new file mode 100644 index 0000000..3bdbfcd --- /dev/null +++ b/06.01.59-Data-функция-decort_kvmvm_list-получение-информации-о-списке-компьютов.md @@ -0,0 +1,152 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_list** служит для получения информации о списке компьютов. + +## Аргументы + +_Data source_ функция **decort_kvmvm_list** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| includedeleted | bool| :x: | Включить в результат удаленные ресурсы | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | +| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| affinity_label | string | Лейбл аффинити | +| affinity_rules | []Struct [см. ниже](#Описание-структуры-affinity-rules) | Правила аффинити для компьютов | +| affinity_weight | int | weight аффинити | +| anti_affinity_rules | []Struct [см. ниже](#Описание-структуры-affinity-rules) | Правила анти аффинити для компьютов | +| arch | string | Архитектура | +| boot_order | []string | Boot order | +| bootdisk_size | int | Размер загрузочного диска в ГБ. | +| clone_reference | int | кол-во клонов | +| clones | []int | id клонов | +| cpus | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кес создан ресурс | +| created_time | int | Время создания ресурса | +| custom_fields | string | Кастомные поля | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Текстовое описание виртуальной машины. | +| devices | string | Девайсы | +| disks | []Struct [см. ниже](#Описание-структуры-disks)| информация о дисках компьюта | +| driver | string | Аппаратная архитектура данной виртуальной машины. | +| gid | int | GID | +| guid | int | GUID | +| compute_id | int | ID компьюта | +| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| interfaces | []Struct [см. ниже](#Описание-структуры-interfaces) | Информация о интерфейсах компьюта | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type manager | +| migrationjob | int | Migrationjob | +| milestones | int | Вехи | +| name | string | Имя виртуального сервера | +| pinned | bool | добавлен ли компьют на стек | +| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| reference_id | string | ID reference | +| registered | bool | Компьют зарегестрирован | +| res_name | string | Res name | +| rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | +| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| snap_sets | []Struct [см. ниже](#Описание-структуры-snap-sets) | Snap sets | +| stateless_sep_id | int | ID сеп | +| stateless_sep_type | string | Тип сеп | +| status | string | Статус диска | +| tags | []Struct [см. ниже](#Описание-структуры-tags) | Тэги | +| tech_status | string | Технический статус диска | +| total_disk_size | int | Размер диска | +| updated_by | string | Кем обновлен ресурс | +| updated_time | int | Время обновления ресурса | +| user_managed | bool | User managed | +| userdata | string | Параметры cloud_init | +| vgpus | []int | Список vgpu | +| vins_connected | int | Кол-во присоединенных винсов | +| virtual_image_id | int | ID виртуального образа | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры affinity rules +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | guid | +| key | string | Ключ | +| mode | string | Режим сравнения | +| policy | string | Степень "строгости" этого правила | +| topology | string | Топология | +| value | string | Значение | + +### Описание структуры disks +| Параметр | Тип | Описание | +| disk_id | int | ID диска | +| pci_slot | int | id pci слота, к которому подключен диск | + +### Описание структуры interfaces +| Параметр | Тип | Описание | +| --- | --- | --- | +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| def_gw | string | Шлюз по умолчанию | +| flip_group_id | int | id flip group | +| guid | string | GUID | +| ip_address | string | IP адрес | +| listen_ssh | bool | открыт ли ssh connect | +| mac | string | MAC адрес устройства | +| name | string | Имя | +| net_id | int | ID сети | +| netmask | int | Маска сети | +| net_type | string | Тип сети | +| pci_slot | int | Pci Slot | +| qos | []Struct{}[см. ниже](#Описание-структуры-qos)| QOS | +| target | string | Цель сети | +| type | string | Тип | +| vnfs | []int | VNFS | + +### Описание структуры qos +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | E rate | +| guid | string | ID ресурса | +| in_brust | int | In brust | +| in_rate | int | In rate | + +### Описание структуры snap sets +| Параметр | Тип | Описание | +| --- | --- | --- | +| disks | []int | Список id дисков | +| guid | string | GUID | +| label | string | Лейбл | +| timestamp | int | Время | + +### Описание структуры tags +| Параметр | Тип | Описание | +| --- | --- | --- | +| key | string | Ключ тэга | +| val | string | Значение тэга | + +## Пример использования +```terraform +``data "decort_kvmvm_list" "kvmvm_list" { + includedeleted = false + page = 1 + size = 10 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_list** в переменной `data.decort_kvmvm_list.kvmvm_list` будут сохранены возвращаемые значения. diff --git a/06.01.60-Data-функция-decort_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md b/06.01.60-Data-функция-decort_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md new file mode 100644 index 0000000..8d78cbf --- /dev/null +++ b/06.01.60-Data-функция-decort_kvmvm_pfw_list-получение-информации-о-списке-порт-форвардингов-компьюта.md @@ -0,0 +1,34 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_pfw_list** служит для получения списка pfw компьюта. + +## Аргументы + +_Data source_ функция **decort_kvmvm_pfw_list** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_pfw_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| pfw_id | int | ID pfw | +| local_ip | string | Локальный ip адрес | +| local_port | int | Локальный порт | +| protocol | string | Протокол tcp/udp | +| public_port_end | int | Конец диапазона внешних портов | +| public_port_start | int | Начало диапазона внешних портов | +| vm_id | int | ID компьюта| + +## Пример использования +```terraform +``data "decort_kvmvm_pfw_list" "pfw_list" { + compute_id = 10154 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_pfw_list** в переменной `data.decort_kvmvm_pfw_list.pfw_list` будут сохранены возвращаемые значения. diff --git a/06.01.61-Data-функция-decort_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md b/06.01.61-Data-функция-decort_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md new file mode 100644 index 0000000..7277534 --- /dev/null +++ b/06.01.61-Data-функция-decort_kvmvm_user_list-получение-информации-о-пользователях-компьюта.md @@ -0,0 +1,40 @@ +Функция доступна в провайдере версии 3.5.0 и выше. + +_Data source_ функция **decort_kvmvm_user_list** служит для получения информации о Access Control List компьюта. + +## Аргументы + +_Data source_ функция **decort_kvmvm_user_list** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| compute_id | int | :heavy_check_mark: | ID компьюта | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_kvmvm_user_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_acl | []Struct [см. ниже](#Описание-структуры-List-acl) | Информация о списке пользователей аккаунтов | +| compute_acl | []Struct [см. ниже](#Описание-структуры-List-acl) | Информация о списке пользователей компьютов | +| rg_acl | []Struct [см. ниже](#Описание-структуры-List-acl) | Информация о списке пользователей ресурной группы | + +### Описание структуры List acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +## Пример использования +```terraform +``data "decort_kvmvm_user_list" "user_list" { + compute_id = 10154 +} +` + +Данный пример подразумевает, что ранее по тексту 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.)). + +После успешного завершения такого вызова _data source_ функции **decort_kvmvm_user_list** в переменной `data.decort_kvmvm_user_list.user_list` будут сохранены возвращаемые значения. diff --git a/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md b/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md new file mode 100644 index 0000000..7a8a0d6 --- /dev/null +++ b/06.01.62-Data-функция-decort_rg_list-получение-информации-о-списке-ресурных-групп.md @@ -0,0 +1,86 @@ +_Data source_ функция **decort_rg_list** служит для получения информации о списке ресурных групп. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_list**. + +## Аргументы +_Data source_ функция **decort_rg_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| includedeleted | bool| :x: | Включить в результат удаленные ресурсы | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. | +| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. | +| acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| created_by | string | Кем создан ресурс | +| created_time | int | Время создания ресурса | +| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | +| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Текстовое описание данной ресурсной группы. | +| dirty | bool | Dirty | +| gid | int | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. | +| guid | int | GUID | +| rg_id | int | Идентификатор данной ресурсной группы. | +| lock_status | string | Lock статус | +| milestones | int | Milestones | +| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). | +| register_computes | bool | Флаг отвечающий за то зарегестрированы ли компьюты | +| resource_limits | [см. ниже](#Описание-структуры-resource-limits) | Лимиты ресурсов | +| secret | string | Секрет | +| status | string | Статус resgroup | +| updated_by | string | Кем был сделан апдейт | +| updated_time | int | Время апдейта | +| vins | []int | Список id виртуальных сетей | +| vms | []int | Список id компьютов | +| resource_types | []string | Res types | +| uniq_pools | []string | Uniq pools | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры resources limits +| Параметр | Тип | Описание | +| --- | --- | --- | +| cu_c | float | Количество ядер CPU | +| cu_d | float | Размер диска | +| cu_i | float | Количество публичных IP адресов | +| cu_m | float | размер RAM | +| cu_np | float | Хранилище траффика | +| gpu_units | float | количество GPU ядер | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list**: + +```terraform +data "decort_rg_list" "rg_list" { + included = false +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_list.rg_list.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_list** в переменной `data.decort_rg_list.rg_list` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_list.rg_list.id` diff --git a/06.01.63-Data-функция-decort_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md b/06.01.63-Data-функция-decort_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md new file mode 100644 index 0000000..63dac5b --- /dev/null +++ b/06.01.63-Data-функция-decort_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md @@ -0,0 +1,44 @@ +_Data source_ функция **decort_rg_affinity_group_computes** служит для получения информации о компьютах аффинити группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_affinity_group_computes**. + +## Аргументы +_Data source_ функция **decort_rg_affinity_group_computes** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| affinity_group | :heavy_check_mark: | string | Аффинити группа | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_affinity_group_computes** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| compute_id | int | Идентификатор компьюта | +| other_node | []int | Спсиок other node | +| other_node_indirect | []int | Список other node indirect | +| other_node_indirect_soft | []int | Список other node indirect soft | +| other_node_soft | []int | Список other node soft| +| same_node | []int | Список same node| +| same_node_soft | []int | Список same node soft| + +## Пример использования +Пример вызова _data source_ функции **decort_rg_affinity_group_computes**: + +```terraform +data "decort_rg_affinity_group_computes" "rg_affinity_group_computes" { + included = false +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_affinity_group_computes.rg_affinity_group_computes.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_affinity_group_computes** в переменной `data.decort_rg_affinity_group_computes.rg_affinity_group_computes` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_affinity_group_computes.rg_affinity_group_computes.id` diff --git a/06.01.64-Data-функция-decort_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md b/06.01.64-Data-функция-decort_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md new file mode 100644 index 0000000..4870ff4 --- /dev/null +++ b/06.01.64-Data-функция-decort_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md @@ -0,0 +1,38 @@ +_Data source_ функция **decort_rg_affinity_groups_list** служит для получения информации о списке аффинити групп ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_affinity_groups_list**. + +## Аргументы +_Data source_ функция **decort_rg_affinity_groups_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_affinity_groups_list** возвращает в указанную при вызове переменную, в поле _affinity_groups_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| label | string | Лейбл аффинити группы | +| ids | []int | Список ID компьютов | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_affinity_groups_list**: + +```terraform +data "decort_rg_affinity_groups_list" "rg_affinity_groups_list" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_affinity_groups_list.rg_affinity_groups_list.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_affinity_groups_list** в переменной `data.decort_rg_affinity_groups_list.rg_affinity_groups_list` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_affinity_groups_list.rg_affinity_groups_list.id` diff --git a/06.01.65-Data-функция-decort_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md b/06.01.65-Data-функция-decort_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md new file mode 100644 index 0000000..2850e5e --- /dev/null +++ b/06.01.65-Data-функция-decort_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md @@ -0,0 +1,38 @@ +_Data source_ функция **decort_rg_affinity_groups_get** служит для получения информации о аффинити группе ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_affinity_groups_get**. + +## Аргументы +_Data source_ функция **decort_rg_affinity_groups_get** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| affinity_group | :heavy_check_mark: | string | Аффинити группа | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_affinity_groups_get** возвращает следующие параметры: +| Параметр | Тип | Описание | +| --- | --- | --- | +| ids | []int | Список ID | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_affinity_groups_get**: + +```terraform +data "decort_rg_affinity_groups_get" "rg_affinity_groups_get" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_affinity_groups_get.rg_affinity_groups_get.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_affinity_groups_get** в переменной `data.decort_rg_affinity_groups_get.rg_affinity_groups_get` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_affinity_groups_get.rg_affinity_groups_get.id` diff --git a/06.01.66-Data-функция-decort_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md b/06.01.66-Data-функция-decort_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md new file mode 100644 index 0000000..fec2b6b --- /dev/null +++ b/06.01.66-Data-функция-decort_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md @@ -0,0 +1,42 @@ +_Data source_ функция **decort_rg_audits** служит для получения информации о аудитах ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_audits**. + +## Аргументы +_Data source_ функция **decort_rg_audits** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| affinity_group | :heavy_check_mark: | string | Аффинити группа | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_audits** возвращает следующие параметры: +| Параметр | Тип | Описание | +| --- | --- | --- | +| call | string | Какая команда была выполнена | +| responsetime | float | Время выполнения | +| statuscode | int | Статус выполнения | +| timestamp | float | Точное время исполнения | +| user | string | Кем была выполнена команда | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_audits**: + +```terraform +data "decort_rg_audits" "rg_audits" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_audits.rg_audits.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_audits** в переменной `data.decort_rg_audits.rg_audits` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_audits.rg_audits.id` diff --git a/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md b/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md new file mode 100644 index 0000000..210ac46 --- /dev/null +++ b/06.01.67-Data-функция-decort_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md @@ -0,0 +1,70 @@ +_Data source_ функция **decort_rg_list_computes** служит для получения информации о компьютах ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_list_computes**. + +## Аргументы +_Data source_ функция **decort_rg_list_computes** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| reason | :x: | string | Причина вызова | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list_computes** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | +| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| affinity_label | string | Лейбл аффинити | +| affinity_rules | []Struct [см. ниже](#Описание-структуры-affinity-rules) | Правила аффинити для компьютов | +| affinity_weight | int | weight аффинити | +| anti_affinity_rules | []Struct [см. ниже](#Описание-структуры-affinity-rules) | Правила анти аффинити для компьютов | +| cpus | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кес создан ресурс | +| created_time | int | Время создания ресурса | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| id | int | Идентификатор компьюта | +| name | string | Имя виртуального сервера | +| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| registered | bool | Компьют зарегестрирован | +| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| status | string | Статус диска | +| tech_status | string | Технический статус диска | +| total_disk_size | int | Размер диска | +| updated_by | string | Кем обновлен ресурс | +| updated_time | int | Время обновления ресурса | +| user_managed | bool | User managed | +| vins_connected | int | Кол-во присоединенных винсов | + +### Описание структуры affinity rules +| Параметр | Тип | Описание | +| --- | --- | --- | +| guid | string | guid | +| key | string | Ключ | +| mode | string | Режим сравнения | +| policy | string | Степень "строгости" этого правила | +| topology | string | Топология | +| value | string | Значение | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list_computes**: + +```terraform +data "decort_rg_list_computes" "list_computes" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_list_computes.list_computes.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_list_computes** в переменной `data.decort_rg_list_computes.list_computes` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_list_computes.list_computes.id` diff --git a/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md b/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md new file mode 100644 index 0000000..c6f3f30 --- /dev/null +++ b/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md @@ -0,0 +1,85 @@ +_Data source_ функция **decort_rg_list_deleted** служит для получения информации о удаленных ресурсных группах. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_list_deleted**. + +## Аргументы +_Data source_ функция **decort_rg_list_deleted** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list_deleted** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. | +| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. | +| acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| created_by | string | Кем создан ресурс | +| created_time | int | Время создания ресурса | +| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | +| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Текстовое описание данной ресурсной группы. | +| dirty | bool | Dirty | +| gid | int | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. | +| guid | int | GUID | +| rg_id | int | Идентификатор данной ресурсной группы. | +| lock_status | string | Lock статус | +| milestones | int | Milestones | +| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). | +| register_computes | bool | Флаг отвечающий за то зарегестрированы ли компьюты | +| resource_limits | [см. ниже](#Описание-структуры-resource-limits) | Лимиты ресурсов | +| secret | string | Секрет | +| status | string | Статус resgroup | +| updated_by | string | Кем был сделан апдейт | +| updated_time | int | Время апдейта | +| vins | []int | Список id виртуальных сетей | +| vms | []int | Список id компьютов | +| resource_types | []string | Res types | +| uniq_pools | []string | Uniq pools | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры resources limits +| Параметр | Тип | Описание | +| --- | --- | --- | +| cu_c | float | Количество ядер CPU | +| cu_d | float | Размер диска | +| cu_i | float | Количество публичных IP адресов | +| cu_m | float | размер RAM | +| cu_np | float | Хранилище траффика | +| gpu_units | float | количество GPU ядер | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list_deleted**: + +```terraform +data "decort_rg_list_deleted" "list_deleted" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_list_deleted.list_deleted.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_list_deleted** в переменной `data.decort_rg_list_deleted.list_deleted` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_list_deleted.list_deleted.id` diff --git a/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md b/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md new file mode 100644 index 0000000..6003cf2 --- /dev/null +++ b/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md @@ -0,0 +1,85 @@ +_Data source_ функция **decort_rg_list_lb** служит для получения информации о списке lb ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_list_lb**. + +## Аргументы +_Data source_ функция **decort_rg_list_lb** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list_lb** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | +| acl | []Struct [см. ниже](#Описание-структуры-acl)| Cписок Acces Control | +| backends | []Struct{} [см. ниже](https://github.com/rudecs/terraform-provider-decort/wiki/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-backend) | Список бекендов | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | + +### Описание структуры backend +| Параметр | Тип | Описание | +| --- | --- | --- | +| algorithm | string | Алгоритм работы бекенда | +| name | string | Имя бекенда | +| server_default_settings | Struct{} [см. ниже](https://github.com/rudecs/terraform-provider-decort/wiki/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-настроек) | Описание настроек серверов бекенда по умолчанию | +| servers | []Struct{} [см. ниже](https://github.com/rudecs/terraform-provider-decort/wiki/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-сервера) | Список серверов | + +### Описание структуры сервера +| Параметр | Тип | Описание | +| --- | --- | --- | +| address | string | Адрес сервера | +| check | string | Включены ли проверки | +| name | string | Имя сервера | +| port | int | Порт сервера | +| server_settings | [см. Описание структуры настроек](https://github.com/rudecs/terraform-provider-decort/wiki/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-настроек) | Настройки сервера | + +### Описание структуры привязки фронтенда +| Параметр | Тип | Описание | +| --- | --- | --- | +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| port | int | Порт привязки | + +### Описание структуры настроек +| Параметр | Тип | Описание | +| --- | --- | --- | +| downinter | int | Интервал между проверками на недоступность сервера | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list_lb**: + +```terraform +data "decort_rg_list_lb" "list_lb" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_list_lb.list_lb.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_list_lb** в переменной `data.decort_rg_list_lb.list_lb` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_list_lb.list_lb.id` diff --git a/06.01.70-Data-функция-decort_rg_list_pfw-получение-информации-о-списке-pfw.md b/06.01.70-Data-функция-decort_rg_list_pfw-получение-информации-о-списке-pfw.md new file mode 100644 index 0000000..b6183b4 --- /dev/null +++ b/06.01.70-Data-функция-decort_rg_list_pfw-получение-информации-о-списке-pfw.md @@ -0,0 +1,44 @@ +_Data source_ функция **decort_rg_list_pfw** служит для получения информации о списке pfw ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_list_pfw**. + +## Аргументы +_Data source_ функция **decort_rg_list_pfw** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list_pfw** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| public_port_end | int | Конец диапазона внешних портов | +| public_port_start | int | Начало диапазона внешних портов | +| vm_id | int | ID компьюта| +| vm_ip | string | Локальный ip адрес vm | +| vm_name | string | Имя vm | +| vm_port | int | Порт vm | +| vins_id | int | Идентификатор vins | +| vins_name | string | Имя vins | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list_pfw**: + +```terraform +data "decort_rg_list_pfw" "list_pfw" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_list_pfw.list_pfw.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_list_pfw** в переменной `data.decort_rg_list_pfw.list_pfw` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_list_pfw.list_pfw.id` diff --git a/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md b/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md new file mode 100644 index 0000000..ffdc0b7 --- /dev/null +++ b/06.01.71-Data-функция-decort_rg_list_vins-получение-информации-о-списке-vins.md @@ -0,0 +1,53 @@ +_Data source_ функция **decort_rg_list_vins** служит для получения информации о списке vins ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_list_vins**. + +## Аргументы +_Data source_ функция **decort_rg_list_vins** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| reason | :x: | string | Причина вызова | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list_vins** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. | +| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | +| computes | []int | Список компьютов | +| created_by | int | Кем создан ресурс | +| created_time | int | Время создания | +| deleted_by | string | Кем удален | +| deleted_time | int | Время удаления | +| external_ip | string | Внешний ip | +| id | int | идентификатор ресурса | +| name | string | Имя ресурса | +| network | string | Сеть | +| pri_vnf_dev_id | int | ID vnf dev | +| rg_name | string | Имя ресурсной группы | +| status | string | Статус | +| updated_by | string | Кем обновлен ресрус | +| updated_time | int | Время обнавления ресурса | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list_vins**: + +```terraform +data "decort_rg_list_vins" "list_vins" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_list_vins.list_vins.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_list_vins** в переменной `data.decort_rg_list_vins.list_vins` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_list_vins.list_vins.id` diff --git a/06.01.72-Data-функция-decort_rg_usage-получение-информации-об-использовании-rg.md b/06.01.72-Data-функция-decort_rg_usage-получение-информации-об-использовании-rg.md new file mode 100644 index 0000000..2d0b5b7 --- /dev/null +++ b/06.01.72-Data-функция-decort_rg_usage-получение-информации-об-использовании-rg.md @@ -0,0 +1,51 @@ +_Data source_ функция **decort_rg_usage** служит для получения информации о списке vins ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_rg_usage**. + +## Аргументы +_Data source_ функция **decort_rg_usage** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| reason | :x: | string | Причина вызова | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_usage** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: +| Параметр | Тип | Описание | +| --- | --- | --- | +| cpu | int | Количество виртуальных CPU, выделенных данному серверу. | +| disk_size | int | Размер диска | +| disk_size_max | int | Максимальный размер диска | +| extips | int | Extips | +| exttraffic | int | Exttraffic| +| gpu | int | Количество GPU | +| ram | int | Количество RAM | +| seps | []Struct [см. ниже](#Описание-структуры-seps) | Информация о сепах | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| sep_id | string | Идентификатор сепа | +| map | map[string]string | Информация хранящаяяся внутри сепа | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_usage**: + +```terraform +data "decort_rg_usage" "rg_usage" { + rg_id = 1234 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_rg_usage.rg_usage.id +``` + +Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). + +После успешного завершения такого вызова **decort_rg_usage** в переменной `data.decort_rg_usage.rg_usage` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_rg_usage.rg_usage.id` diff --git a/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md b/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md index 187f9bd..7807c7f 100644 --- a/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md +++ b/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md @@ -1,5 +1,23 @@ _Resource_ функция **decort_kvmvm** служит для управления виртуальными машинами, создаваемыми в платформе DECORT на базе технологии виртуализации KVM. +## Изменения в 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 @@ -32,7 +50,7 @@ _Resource_ функция **decort_kvmvm** служит для управлен Пути решения: - Выполнить **decort_disk_list_types_detailed**. Результатом выполнения этой функции станет список доступных пулов хранилища вместе с их идентификаторами (sep_id). - Заполнить поля sep_id и pool подходящими полями для диска. - +- При удалении не последнего блока в списке, перед подтверждением Terraform не правильно отображает диск, который будет удаляться. На самом деле из состояние будет удален тот диск, который был убран из файла. Также будет нужен дополнительное выполнение terraform apply для того чтобы все блоки сейта терраформа встали на свои места и не отличались от настоящего состояния ресурса ## Аргументы _Resource_ функция **decort_kvmvm** принимает следующие аргументы: @@ -48,7 +66,7 @@ _Resource_ функция **decort_kvmvm** принимает следующие | boot_disk_size | int | :heavy_check_mark: | Размер загрузочного диска виртуальной машины в ГБ. | | extra_disks | []int | :x: | Список идентификаторов дополнительных дисков, которые требуется подключить к данной виртуальной машине помимо загрузочного диска. | | cloud_init | string | :x: | Используется на этапе создания вм.
Параметры для утилиты _cloud_init_, которая используется в платформе DECORT для первичного конфигурирования виртуальной машины после её создания. | -| network | dict | :x: | Параметры сетевого подключения. Структура словаря:
* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.
* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`
* (string) `ip_address` - IP адрес, выделенный данному подключению.
* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины.
Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение. | +| network | []Struct [см. ниже](#Описание-блока-network) | :x: | Параметры сетевого подключения. Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение.| | description | string | :x: | Текстовое описание виртуальной машины. | | started | bool | :x: | Флаг запуска машины,
по-умолчанию - true.
Если true - машина включена,
если false - выключена. | | sep_id | int | :x: | Идентификатор sep | @@ -57,11 +75,23 @@ _Resource_ функция **decort_kvmvm** принимает следующие | ipa_type | string | :x: | Тип аутентификатора | | permanently | bool | :x: | Мгновенное удаление виртуальной машины, минуя корзину. Параметр считывается только при использовании команды `terraform destroy`, то есть только при удалении ресурса | | detach_disks | bool | :x: | Отсоединение прикрепленных к виртуальной машине дисков перед ее удалением. Параметр считывается только при использовании команды `terraform destroy`, то есть только при удалении ресурса | -| disks | см. ниже | :x: | Описание диска. Таких может быть любое кол-во, либо не быть вообще | +| disks | []Struct [см. ниже](#Описание-блока-disks)| :x: | Описание диска. Таких может быть любое кол-во, либо не быть вообще | | enabled | bool | :x: | Доступность вычислительной машины | | affinity_label | string | :x: | Метка для правил affinity | -| affinity_rules | [см. ниже](#блок-affinity_rules) | :x: | Блок описания правил affinity. Блоков может быть несколько, один или отсутствовать. | -| anti_affinity_rules | [см. ниже](#блок-anti_affinity_rules) | :x: | Блок описания правил anti-affinity. Блоков может быть несколько, один или отсутствовать. | +| affinity_rules | []Struct [см. ниже](#Описание-блока-affinity_rules) | :x: | Блок описания правил affinity. Блоков может быть несколько, один или отсутствовать. | +| anti_affinity_rules | []Struct [см. ниже](#Описание-блока-anti_affinity_rules) | :x: | Блок описания правил anti-affinity. Блоков может быть несколько, один или отсутствовать. | +| tags | []Struct [см. ниже](#Описание-блока-tags) | :x: | Задание тэгов компьюта | +| port_forwarding | []Struct [см. ниже](#Описание-блока-port_forwarding) | :x: | Настройка порт форвардинга для компьюта | +| user_access | []Struct [см. ниже](#Описание-блока-user_access) | :x: | Предоставление доступов к компьюту | +| snapshot | []Struct [см. ниже](#Описание-блока-snapshot) | :x: | Создание мнапшотов | +| rollback | []Struct [см. ниже](#Описание-блока-rollback) | :x: | Rollback на определенный снапшот | +| cd | []Struct [см. ниже](#Описание-блока-cd) | :x: | Добавление диска cd rom | +| pin_to_stack | bool | :x: | Флаг, отвечающий за добавление кмпьюта в стэк | +| pause | bool | :x: | Флаг, отвкчающий за pause/resume компьюта | +| reset | bool | :x: | Флаг, отвкчающий за reset компьюта | +| auto_start | bool | :x: | Флаг, отвечающий за авто старт при редеплое компьюта | +| force_stop | bool | :x: | Флаг, отвечающий за стоп при редеплое компьюта | +| data_disks | string | :x: | Указание того, что делать с дисками при редеплое. Возможные значения: "KEEP", "DETACH" и "DESTROY" | ### Описание блока disks @@ -76,7 +106,14 @@ _Resource_ функция **decort_kvmvm** принимает следующие | image_id | int | :x: | ID образа | | permanently | bool | :x: | Флаг для удаления диска. Если выставлен в true - диск будет моментально удален с платформы, иначе будет добавлен в корзину и его можно будет восстановить. Значение поля считывается только при операции `terraform destroy`. По умолчанию - false | -### Блок affinity_rules +### Описание блока network +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| net_type | string | :heavy_check_mark: | тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment. | +| net_id | int | :heavy_check_mark: | идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"` | +| ip_address | string | :x: | IP адрес, выделенный данному подключению. | + +### Описание блока affinity_rules | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | topology | string | :heavy_check_mark: | Тип правила. Возможные значения - node, compute | @@ -85,7 +122,7 @@ _Resource_ функция **decort_kvmvm** принимает следующие | key | string | :heavy_check_mark: | Ключ правила | | value | string | :heavy_check_mark: | Значение правила | -### Блок anti_affinity_rules +### Описание блока anti_affinity_rules | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | topology | string | :heavy_check_mark: | Тип правила. Возможные значения - node, compute | @@ -94,6 +131,41 @@ _Resource_ функция **decort_kvmvm** принимает следующие | key | string | :heavy_check_mark: | Ключ правила | | value | string | :heavy_check_mark: | Значение правила | +### Описание блока tags +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| key | string | :heavy_check_mark: | Ключ тэга | +| val | string | :heavy_check_mark: | Значение тэга | + +### Описание блока port_forwarding +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| public_port_start | int | :heavy_check_mark: | Начало диапазона внешних портов для данного правила pfw | +| public_port_end | int | :x: | Конец диапазона внешних портов для данного правила pfw | +| local_port | int | :heavy_check_mark: | Локальный порт для данного правила pfw | +| proto | string | :heavy_check_mark: | Протокол создания правила pfw. Возможные значения: "tcp" или "udp" | + +### Описание блока user_access +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| username | string | :heavy_check_mark: | Юзер, которому необходимо выдать определенные права на компьют | +| access_type | string |:heavy_check_mark: | Права, которые выдадутся юзеру на компьют. Возможные значения: "R", "RCX" или "ARCXDU" | + +### Описание блока snapshot +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| label | string | :heavy_check_mark: | Лейбл снапшота | + +### Описание блока rollback +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| label | string | :heavy_check_mark: | Лейбл снапшота на который нужно сделать rollback | + +### Описание блока cd +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| cdrom_id | int | :heavy_check_mark: | Идентификатор образа cdrom диска | + ## Возвращаемые значения В случае успешного выполнения _resource_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения: @@ -101,31 +173,122 @@ _Resource_ функция **decort_kvmvm** принимает следующие | --- | --- | --- | | account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | | account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | -| driver | string | Аппаратная архитектура данной виртуальной машины. | +| affinity_label | string | Метка для правил affinity | +| affinity_weight | int | weight аффинити | +| arch | string | Архитектура | +| boot_order | []string | Boot order | | boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. | | boot_disk_size | int | Размер загрузочного диска в ГБ. | -| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | +| driver | string | Аппаратная архитектура данной виртуальной машины. | +| disks | [см. ниже](#описание-блока-disks) | Описание диска. Таких может быть любое кол-во, либо не быть вообще | +| clone_reference | int | кол-во клонов | +| clones | []int | id клонов | +| computeci_id | int | Id computeci | | cpu | int | Количество виртуальных CPU, выделенных данному серверу. | +| created_by | string | Кем создан ресурс | +| created_time | int | Время создания ресурса | +| custom_fields | []Struct [см. ниже](#Описание-структуры-custom-fields) | Кастомные поля | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | | description | string | Текстовое описание виртуальной машины. | +| detach_disks | bool | Отсоединение прикрепленных к виртуальной машине дисков перед ее удалением. Параметр считывается только при использовании команды `terraform destroy`, то есть только при удалении ресурса | +| devices | string | Девайсы | +| enabled | bool | Доступность вычислительной машины | | extra_disks | list of ints | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. | +| gid | int | GID | +| guid | int | GUID | +| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. | | id | int | Уникальный идентификатор этой виртуальной машины в облачной платформе. Всегда совпадает с `compute_id`. | | image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | -| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| interfaces | []Struct [см. ниже](#Описание-структуры-interfaces) | Информация о интерфейсах компьюта | +| ipa_type | string | Тип аутентификатора | +| is | string | Наименование системы | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type manager | +| migrationjob | int | Migrationjob | +| milestones | int | Вехи | | name | string | Имя виртуального сервера.
Возвращаемое значение `name` совпадает со значением соответствующего аргумента, переданного при вызове функции. | +| natable_vins_id | int | NAT vins id | +| natable_vins_ip | string | NAT vins ip | +| natable_vins_name | string | NAT vins name | +| natable_vins_network | string | NAT vins network | +| natable_vins_network_name | string | NAT vins network name | | network | list of dicts | Характеристики сетевых сегментов, к которым подключен данный сервер. Формат структуры:
* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.
* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`
* (string) `ip_address` - IP адрес, выделенный данному подключению.
* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины. | -| os_users | list of dicts | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:
* (string) `login` - учётная запись в гостевой ОС.
* (string) `password` - пароль к этой учётной записи. | +| os_users | []Struct [см. ниже](#Описание-структуры-os-users) | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:
* (string) `login` - учётная запись в гостевой ОС.
* (string) `password` - пароль к этой учётной записи. | +| permanently | bool | Мгновенное удаление виртуальной машины, минуя корзину. Параметр считывается только при использовании команды `terraform destroy`, то есть только при удалении ресурса | +| pinned | bool | добавлен ли компьют на стек | +| pool | string | Наименование пула для размещения | | ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. | +| reference_id | string | ID reference | +| registered | bool | Компьют зарегестрирован | +| res_name | string | Res name | +| reset | bool | Флаг отвкчающий за reset компьюта | | rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. | | rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. | -| started | bool | Опциональный параметр, флаг запуска машины,
по-умолчанию - true.
Если true - машина включена,
если false - выключена. | | sep_id | int | Идентификатор sep | -| pool | string | Наименование пула для размещения | -| is | string | Наименование системы | -| ipa_type | string | Тип аутентификатора | -| permanently | bool | Мгновенное удаление виртуальной машины, минуя корзину. Параметр считывается только при использовании команды `terraform destroy`, то есть только при удалении ресурса | -| detach_disks | bool | Отсоединение прикрепленных к виртуальной машине дисков перед ее удалением. Параметр считывается только при использовании команды `terraform destroy`, то есть только при удалении ресурса | -| disks | [см. ниже](#описание-блока-disks) | Описание диска. Таких может быть любое кол-во, либо не быть вообще | -| enabled | bool | Доступность вычислительной машины | +| snap_sets | []Struct [см. ниже](#Описание-структуры-snap-sets) | Snap sets | +| started | bool | Опциональный параметр, флаг запуска машины,
по-умолчанию - true.
Если true - машина включена,
если false - выключена. | +| stateless_sep_id | int | ID сепа | +| stateless_sep_type | string | Тип сепа | +| status | string | Cтатус | +| tech_status | string | Технический статус | +| updated_by | string | Кем обновлен ресурс | +| updated_time | int | Время обновления ресурса | +| user_managed | bool | User managed | +| cloud_init | string | Параметры cloud_init | +| vgpus | []int| Список vgpu | +| virtual_image_id | int | ID виртуального образа | +| virtual_image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | + +### Описание структуры custom fields +| Параметр | Тип | Описание | +| key | string | Ключ | +| val | string | Значение | + +### Описание структуры interfaces +| Параметр | Тип | Описание | +| --- | --- | --- | +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| def_gw | string | Шлюз по умолчанию | +| flip_group_id | int | id flip group | +| guid | string | GUID | +| ip_address | string | IP адрес | +| listen_ssh | bool | открыт ли ssh connect | +| mac | string | MAC адрес устройства | +| name | string | Имя | +| net_id | int | ID сети | +| netmask | int | Маска сети | +| net_type | string | Тип сети | +| pci_slot | int | Pci Slot | +| qos | []Struct{}[см. ниже](#Описание-структуры-qos)| QOS | +| target | string | Цель сети | +| type | string | Тип | +| vnfs | []int | VNFS | + +### Описание структуры qos +| Параметр | Тип | Описание | +| --- | --- | --- | +| e_rate | int | E rate | +| guid | string | ID ресурса | +| in_brust | int | In brust | +| in_rate | int | In rate | + +### Описание структуры os users +| Параметр | Тип | Описание | +| guid | string | GUID | +| login | string | Логин | +| password | string | Пароль | +| public_key | string | Публичный ssh ключ | + +### Описание структуры snap sets +| Параметр | Тип | Описание | +| --- | --- | --- | +| disks | []int | Список id дисков | +| guid | string | GUID | +| label | string | Лейбл | +| timestamp | int | Время | ### Описание блока disks | Аргумент | Тип | Описание | diff --git a/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md b/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md index b52aa1d..af586bc 100644 --- a/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md +++ b/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md @@ -1,5 +1,13 @@ _Resource_ функция **decort_resgroup** служит для управления ресурсными группами в облачной платформе DECORT. +## Изменения в 3.5.0 +- Обновлено поведение ресруса, в случае изменения блока quota – Если блок убирается, то значения Лимитов становяться дефолтными +- Добавлен опциональный блок access +- Добавлен опциональный блок def_net +- Добавлено опциональное поле enable +- Добавлена обработка входных идентификаторов значений при создании и обновлении ресурса +- В дальнейших версиях поля def_net_type, ext_ip, ext_net_id будут убраны и все взаисодействие с сетью ресурсной группы будет присходить с помощью блока def_net + ## Изменения в 3.4.0 - В аргументы добавлено опциональное поле force - В аргументы добавлено опциональное поле permanently @@ -23,10 +31,37 @@ _Resource_ функция **decort_resgroup** принимает следующ | permanently | bool | :x: | Безвозвратное удаление ресурса. Используется при удалении| | force | bool | :x: | Удаление ресурса, в случае если он к чему-то присоединен произойдет отсоединение его от других ресурсов и удаление| | resaon | string | :x: | Причина по которой ресурс удаляется | +| enable | bool | :x: | Поле флаг, отвечающее за enable/disable ресурса | | ext_ip | string | :x: | IP адрес из диапазона, принадлежащего внешней сети, который будет присвоен подключению ViNS во внешнюю сеть в случае, когда `def_net_type = "PRIVATE"` и ненулевом `ext_net_id`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не указан явно, то платформа автоматически выберет свободный IP адрес.
Если заданный `ext_ip` уже используется, платформа вернёт ошибку. | | ext_net_id | int | :x: | Идентификатор внешней сети, в которую будет подключён ViNS, автоматически создаваемый платформой для данной ресурсной группы в случае, когда `def_net_type = "PRIVATE"`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не задан явно при `def_net_type = "PRIVATE"`, то платформа выберет первую из доступных данному пользователю внешних сетей. | | ipcidr | string | :x: | Адрес сети внутри ViNS для случая `def_net_type = "PRIVATE"`
Если данный параметр явно не задан, то платформа назначит адрес сети автоматически. | -| quota | dict | :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу.
Данный параметр не является обязательным, значение по умолчанию - отсутствие лимитов на потребление ресурсов. | +| quota | Struct [см. ниже](#Описание-структуры-quota)| :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Максмальное количество: 1 | +| access | []Struct [см. ниже](#Описание-структуры-access)| :x: | Юзеры которым выдется доступ к данной ресурсной группе | +| def_net | Struct [см. ниже](#Описание-структуры-def_net)| :x: | Параметры сети ресурсной группы. Максмальное количество: 1| + +### Описание структуры quota +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| cpu | int | :x: | лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы | +| ram | int | :x: | лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы | +| disk | int | :x: | лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы | +| ext_ips | int | :x: | лимит на суммарное количество внешних ip адресов в рамках данной ресрсной группы | +| ext_ips | int | :x: | лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы | +| gpu_units | int | :x: | лимит на суммарное количество GPU юнитов в рамках данной ресурсной группы | + +### Описание структуры access +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| user | string | :heavy_check_mark: | Юзер которому предоставляется доступ | +| right | string | :heavy_check_mark: | Права, которые будут выдаваться данному юзеру. Возможные значения: "R", "RCX" или "ARCXDU"| +| reason | string | :x: | Причина | + +### Описание структуры def_net +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| net_type | string | :heavy_check_mark: | Тип сети, которая будет присоединена к ресурсной группе. Возможные значения: "PRIVATE" - vins, "PUBLIC"- external network | +| net_id | int | :x: | Идентификатор сети. Если не указан, будет задан тот, к которому есть доступ по умолчанию | +| reason | string | :x: | Причина | Для создания ресурсной группы пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь как минимум доступ на запись к указанному подписчику. В противном случае возникнет ошибка доступа. @@ -37,8 +72,14 @@ _Resource_ функция **decort_resgroup** принимает следующ | Параметр | Тип | Описание | | --- | --- | --- | +| acl | Struct{} [см. ниже](#Описание-структуры-acl) | Cписок Acces Control List | | account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. | | account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. | +| created_by | string | Кес создан ресурс | +| created_time | int | Время создания ресурса | +| deleted_by | string | Кем удален ресурс | +| deleted_time | int | Время удаления ресурса | +| resources | Struct{} [см. ниже](#Описание-структуры-resources)| Информация о занимаемых ресурсах | | def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | | def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | | description | string | Текстовое описание данной ресурсной группы. | @@ -46,11 +87,29 @@ _Resource_ функция **decort_resgroup** принимает следующ | id | int | Идентификатор данной ресурсной группы. | | name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). | | quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу. | -| resources | Struct{} [см. ниже](#Описание-структуры-resources)| Информация о занимаемых ресурсах | | rg_id | int | Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. | +| guid | int | GUID | +| dirty | bool | Dirty | +| lock_status | string | Lock статус | +| milestones | int | Milestones | +| secret | string | Секрет | | status | string | Статус resgroup | +| updated_by | string | Кем был сделан апдейт | +| updated_time | int | Время апдейта | | vins | []int | Список id виртуальных сетей | | vms | []int | Список id виртуальных машин | +| res_types | []string | Resource Types | +| uniq_pools | []string | Uniq pools | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | ### Описание структуры resources | Параметр | Тип | Описание |