diff --git a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md index 2f9da72..d143a1f 100644 --- a/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md +++ b/06.01.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM.md @@ -14,65 +14,66 @@ _Data source_ функция **decort_kvmvm** принимает следующ ## Возвращаемые значения В случае успешного выполнения _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 | Идентификатор загрузочного диска виртуальной машины. | -| 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 | Аппаратная архитектура данной виртуальной машины. | -| gid | int | GID | -| guid | int | GUID | -| 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 | Имя виртуального сервера | -| 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 | Имя ресурсной группы, к которой принадлежит виртуальная машина. | -| 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 | []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 | Идентификатор загрузочного диска виртуальной машины. | +| 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 | Аппаратная архитектура данной виртуальной машины. | +| gid | int | GID | +| guid | int | GUID | +| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| 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 | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| 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 | Параметр | Тип | Описание | @@ -187,25 +188,26 @@ _Data source_ функция **decort_kvmvm** принимает следующ | 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 | +| Параметр | Тип | Описание | +| --- | --- |-------------------------| +| conn_id | int | ID connect | +| conn_type | string | Тип connect | +| enabled | bool | Доступность подключения | +| 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 | Параметр | Тип | Описание | diff --git a/06.01.05-Data-функция-decort_account-получение-информации-об-аккаунте.md b/06.01.05-Data-функция-decort_account-получение-информации-об-аккаунте.md index 1bf6224..12c2fdc 100644 --- a/06.01.05-Data-функция-decort_account-получение-информации-об-аккаунте.md +++ b/06.01.05-Data-функция-decort_account-получение-информации-об-аккаунте.md @@ -63,6 +63,7 @@ _Data source_ функция **decort_account** принимает следую | --- | --- | --- | | cu_c | float | Количество ядер CPU | | cu_d | float | Размер диска | +| cu_dm | float | Использованный размер хранилища виртуального диска | | cu_i | float | Количество публичных IP адресов | | cu_m | float | размер RAM | | cu_np | float | Хранилище траффика | diff --git a/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md b/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md index e5b1ca2..59725a6 100644 --- a/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md +++ b/06.01.08-Data-функция-decort_locations_list-получение-списка-доступных-площадок.md @@ -19,14 +19,15 @@ _Data source_ функция **decort_locations_list** принимает сле В случае успешного выполнения _data source_ функция **decort_locations_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: -| Параметр | Тип | Описание | -| ------------- | ------ | --------------------- | -| flag | string | Флаг | -| gid | int | ID grid | -| guid | int | Внутренний id | -| id | int | ID | -| location_code | string | Код расположения grid | -| name | string | Наименование grid | +| Параметр | Тип | Описание | +|---------------|----------|-----------------------| +| auth_broker | []string | auth broker | +| flag | string | Флаг | +| gid | int | ID grid | +| guid | int | Внутренний id | +| id | int | ID | +| location_code | string | Код расположения grid | +| name | string | Наименование grid | ## Пример использования diff --git a/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md b/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md index 2d6a100..829f905 100644 --- a/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md +++ b/06.01.12-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md @@ -27,6 +27,8 @@ _Data source_ функция **decort_rg_list** принимает следую | account_id | int | ID аккаунта - владельца ресурсной группы | | account_name | string | Имя аккаунта - владельца ресурсной группы | | acl | []Struct{
explicit bool
guid string
right string
status string
type string
user_group_id string
} | Более подробная информация об аккаунтах, имеющих доступ к ресурсной группе
Явно ли указан доступ
guid аккаунта
Права доступа
Статус аккаунта
Тип аккаунта
Идентификатор пользователя-владельца аккаунта
 
| +| cpu_allocation_parameter | string | Параметр выделения CPU | +| cpu_allocation_ratio | float | Отношение выделения CPU | | created_by | string | Информация о создателе группы | | created_time | int | Время создания группы | | def_net_id | int | id сети по-умолчанию | diff --git a/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md b/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md index f9843e7..c8b2167 100644 --- a/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md +++ b/06.01.42-Data-функция-decort_disk_list_unattached-получение-информации-о-неподключенных-дисках.md @@ -58,6 +58,7 @@ _Data source_ функция **decort_disk_list_unattached** принимает | role | string | Роль диска | | sep_id | int | id sep | | sep_type | string | Тип sep | +| shareable | bool | Флаг, говорящий о том, является ли диск общим | | size_max | int | Максимальный размер диска | | snapshots | []Struct{}[см. ниже](#описание-структуры-snapshots)| Снимки состояния диска| | status | string | Статус диска | diff --git a/06.01.45-Data-функция-decort_k8s-получение-информации-о-кластере-k8s.md b/06.01.45-Data-функция-decort_k8s-получение-информации-о-кластере-k8s.md index a09d858..81ccc82 100644 --- a/06.01.45-Data-функция-decort_k8s-получение-информации-о-кластере-k8s.md +++ b/06.01.45-Data-функция-decort_k8s-получение-информации-о-кластере-k8s.md @@ -13,32 +13,33 @@ _Data source_ функция **decort_k8s** принимает следующи В случае успешного выполнения _data source_ функция **decort_k8s** возвращает следующие параметры: -| Параметр | Тип | Описание | -| --- | --- | --- | -| acl | Struct{} [см. ниже](#описание-структуры-acl) | acl | -| account_id | int | ID аккаунта | -| account_name | string | Имя аккаунта | -| bservice_id | int | ID bservice | -| k8sci_id | int | ID образа кластера | -| created_by | string | Кем был создан ресурс | -| created_time | int | Время создания ресурса | -| deleted_by | string | Кем был удален ресурс | -| deleted_time | int | Время удаления ресурса | -| extnet_id | int | ID внешней сети | -| k8s_ci_name | string | Имя образа кластера | -| masters | []Struct{} [см. ниже](#описание-структуры-masters) | Структура компьютов мастеров | -| workers | []Struct{} [см. ниже](#описание-структуры-workers) | Структура компьютов воркеров | -| lb_id | int | ID балансировщика нагрзуки | -| lb_ip | string | IP балансировщика нагрзуки | -| name | string | Имя ресурса | -| rg_id | int | ID ресурсной группы | -| rg_name | string | Имя ресурсной группы | -| status | string | Статус ресурса | -| tech_status | string | Технический статус ресурса | -| updated_by | string | Кем был обновлен ресурс | -| updated_time | int | Время последнего обновления ресурса | -| kubeconfig | string | Конфиг | -| vins_id | int | ID виртуальной сети | +| Параметр | Тип | Описание | +|----------------|----------------------------------------------------|-------------------------------------| +| acl | Struct{} [см. ниже](#описание-структуры-acl) | acl | +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| bservice_id | int | ID bservice | +| k8sci_id | int | ID образа кластера | +| created_by | string | Кем был создан ресурс | +| created_time | int | Время создания ресурса | +| deleted_by | string | Кем был удален ресурс | +| deleted_time | int | Время удаления ресурса | +| extnet_id | int | ID внешней сети | +| k8s_ci_name | string | Имя образа кластера | +| masters | []Struct{} [см. ниже](#описание-структуры-masters) | Структура компьютов мастеров | +| network_plugin | string | Сетевой плагин | +| workers | []Struct{} [см. ниже](#описание-структуры-workers) | Структура компьютов воркеров | +| lb_id | int | ID балансировщика нагрзуки | +| lb_ip | string | IP балансировщика нагрзуки | +| name | string | Имя ресурса | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| status | string | Статус ресурса | +| tech_status | string | Технический статус ресурса | +| updated_by | string | Кем был обновлен ресурс | +| updated_time | int | Время последнего обновления ресурса | +| kubeconfig | string | Конфиг | +| vins_id | int | ID виртуальной сети | ### Описание структуры acl diff --git a/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md b/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md index 6148236..88c066e 100644 --- a/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md +++ b/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s.md @@ -5,6 +5,7 @@ _Data source_ функция **decort_k8s_list** служит для получ ## Аргументы _Data source_ функция **decort_k8s_list** принимает следующие аргументы: + | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | | by_id | int | :x: | Фильтр по ID кластера | @@ -23,35 +24,36 @@ _Data source_ функция **decort_k8s_list** принимает следую В случае успешного выполнения _data source_ функция **decort_k8s_list** возвращает в указанную при вызове переменную, в поле items массив, каждый элемент которого состоит из следующих параметров: -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | ID аккаунта | -| account_name | string | Имя аккаунта | -| acl | []string | acl | -| bservice_id | int | ID bservice | -| ci_id | int | ID образа кластера | -| config | []string | Конфиг | -| created_by | string | Кем был создан ресурс | -| created_time | int | Время создания ресурса | -| deleted_by | string | Кем был удален ресурс | -| deleted_time | int | Время удаления ресурса | -| desc | string | Описание ресурса | -| extnet_id | int | ID внешней сети | -| gid | int | Grid ID | -| guid | int | ID ресурса | -| k8s_id | int | ID кластера | -| lb_id | int | ID балансировщика нагрзуки | -| milestones | int | Milestones | -| k8s_name | string | Имя кластера k8s | -| rg_id | int | ID ресурсной группы | -| rg_name | string | Имя ресурсной группы | -| service_account | Struct{} [см. ниже](#описание-структуры-service_account)| информация о аккаунте кластера | -| status | string | Статус ресурса | -| tech_status | string | Технический статус ресурса | -| updated_by | string | Кем был обновлен ресурс | -| updated_time | int | Время последнего обновления ресурса | -| vins_id | int | ID виртуальной сети | -| workers_groups | []Struct{} [см. ниже](#описание-структуры-workers_groups)| группы воркеров кластера | +| Параметр | Тип | Описание | +|-----------------|-----------------------------------------------------------|-------------------------------------| +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| acl | []string | acl | +| bservice_id | int | ID bservice | +| ci_id | int | ID образа кластера | +| config | []string | Конфиг | +| created_by | string | Кем был создан ресурс | +| created_time | int | Время создания ресурса | +| deleted_by | string | Кем был удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Описание ресурса | +| extnet_id | int | ID внешней сети | +| gid | int | Grid ID | +| guid | int | ID ресурса | +| k8s_id | int | ID кластера | +| lb_id | int | ID балансировщика нагрзуки | +| milestones | int | Milestones | +| k8s_name | string | Имя кластера k8s | +| network_plugin | string | Сетевой плагин | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| service_account | Struct{} [см. ниже](#описание-структуры-service_account) | информация о аккаунте кластера | +| status | string | Статус ресурса | +| tech_status | string | Технический статус ресурса | +| updated_by | string | Кем был обновлен ресурс | +| updated_time | int | Время последнего обновления ресурса | +| vins_id | int | ID виртуальной сети | +| workers_groups | []Struct{} [см. ниже](#описание-структуры-workers_groups) | группы воркеров кластера | ### Описание-структуры-service_account diff --git a/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md b/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md index 498132c..76c2a16 100644 --- a/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md +++ b/06.01.68-Data-функция-decort_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md @@ -31,6 +31,8 @@ _Data source_ функция **decort_rg_list_deleted** принимает сл | account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. | | account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. | | acl | []Struct [см. ниже](#описание-структуры-acl)| Cписок Acces Control | +| cpu_allocation_parameter | string | Параметр выделения CPU | +| cpu_allocation_ratio | float | Отношение выделения CPU | | created_by | string | Кем создан ресурс | | created_time | int | Время создания ресурса | | def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | diff --git a/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md b/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md index c152b91..7e7f77d 100644 --- a/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md +++ b/06.01.69-Data-функция-decort_rg_list_lb-получение-информации-о-списке-lb.md @@ -26,11 +26,62 @@ _Data source_ функция **decort_rg_list_lb** принимает следу ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_rg_list_lb** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| backends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки#Oписание-структуры-backend) | Список бекендов | +| backend_haip | string | Backend highly available ip | +| created_by | string | Кем был создан ресурс | +| created_time | int | Время создания ресурса | +| deleted_by | string | Кем был удален ресурс | +| deleted_time | int | Время удаления ресурса | +| desc | string | Описание | +| dp_api_user | string | Имя пользователя для работы | +| extnet_id | int | ID внешней сети | +| frontend_haip | string | Frontend highly available ip | +| frontends | []Struct{} [см. ниже](#описание-структуры-фронтенда) | Список фронтендов | +| gid | int | Grid ID балансировщика | +| guid | int | ID балансировщика | +| id | int | ID балансировщика | +| image_id | int | ID образа | +| milestones | int | Вехи | +| name | string | Имя балансировщика | +| primary_node | Struct{} [см. описание узлов](#описание-структуры-узлов) | Главный узел | +| rg_name | string | Имя ресурсной группы | +| secondary_node | Struct{} [см. описание узлов](#описание-структуры-узлов) | Второй узел | +| status | string | Статус | +| tech_status | string | Технический статус | +| updated_by | string | Кем балансировщик был обновлен | +| updated_time | string | Время последнего обновления | +| vins_id | int | ID виртуальной сети | + +### Описание структуры узлов +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +### Описание структуры фронтенда +| Параметр | Тип | Описание | +| --- | --- | --- | +| backend | string | Имя бекенда, к которому подключен фронтенд | +| guid | string | ID ресурса | +| name | string | Имя фронтенда | +| bindings | []Struct{} [см. ниже](#описание-структуры-привязки-фронтенда) | Привязки фронтенда | + +### Описание структуры привязки фронтенда | Параметр | Тип | Описание | | --- | --- | --- | -| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | -| acl | []Struct [см. ниже](#описание-структуры-acl)| Cписок Acces Control | -| backends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.37-Data-функция-decort_lb_list-получение-информации-о-балансировщиках-нагрузки#Oписание-структуры-backend) | Список бекендов | +| address | string | Адрес, к которому привязан фронтенд | +| guid | string | ID ресурса | +| name | string | Имя привязки | +| port | int | Порт привязки | ### Описание структуры acl | Параметр | Тип | Описание | diff --git a/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md b/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md index 038e704..df90534 100644 --- a/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md +++ b/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе.md @@ -8,23 +8,32 @@ _Data source_ функция **decort_flipgroup** служит для получ ## Возвращаемые значения -| Параметр | Тип | Описание | -| ------------ | ------- | ------------------------------------------ | -| account_id | int | ID аккаунта | -| client_ids | []int | Список ID подключенных к группе клиентов | -| client_type | string | Тип клиентов, подключаемых к группе | -| conn_id | int | ID подключения | -| net_mask | int | Маска сети | -| conn_type | string | Тип подключения | -| default_gw | string | Шлюз по умолчанию | -| desc | string | Описание группы | -| gid | int | Grid ID платформы | -| guid | int | ID флипгруппы на платформе (=flipgroup_id) | -| milestones | int | Веха | -| name | string | Наименование плавающей группы | -| net_id | int | ID сети | -| net_type | string | Тип сети (EXTNET/ViNS) | -| status | string | Статус плавающей группы | +| Параметр | Тип | Описание | +|--------------|--------|--------------------------------------------| +| account_id | int | ID аккаунта | +| account_name | string | Имя аккаунта | +| client_ids | []int | Список ID подключенных к группе клиентов | +| client_type | string | Тип клиентов, подключаемых к группе | +| conn_id | int | ID подключения | +| created_by | string | Кем была создана флипгруппа | +| created_time | int | Время создания флипгруппы | +| deleted_by | string | Кем удалена флипгруппа | +| deleted_time | int | Время удаления флипгруппы | +| conn_type | string | Тип подключения | +| default_gw | string | Шлюз по умолчанию | +| desc | string | Описание группы | +| gid | int | Grid ID платформы | +| guid | int | ID флипгруппы на платформе (=flipgroup_id) | +| milestones | int | Веха | +| name | string | Наименование плавающей группы | +| net_id | int | ID сети | +| net_type | string | Тип сети (EXTNET/ViNS) | +| network | string | Информация о сети | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| status | string | Статус плавающей группы | +| updated_by | string | Кем была обновлена флипгруппа | +| updated_time | int | Время последнего обновления флипгруппы | ## Пример использования diff --git a/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md b/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md index 07d5244..8981e5f 100644 --- a/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md +++ b/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах.md @@ -17,7 +17,7 @@ _Data source_ функция **decort_flipgroup_list** служит для по ## Возвращаемые значения (в списке items) | Параметр | Тип | Описание | -| ------------ | ------- | ------------------------------------------ | +| ------------ |----------| ------------------------------------------ | | account_id | int | ID аккаунта | | client_ids | []int | Список ID подключенных к группе клиентов | | client_type | string | Тип клиентов, подключаемых к группе | @@ -28,6 +28,7 @@ _Data source_ функция **decort_flipgroup_list** служит для по | desc | string | Описание группы | | gid | int | Grid ID платформы | | guid | int | ID флипгруппы на платформе (=flipgroup_id) | +| meta | []string | Мета информация | | milestones | int | Веха | | name | string | Наименование плавающей группы | | net_id | int | ID сети | diff --git a/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md b/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md index 2f01b31..5cec815 100644 --- a/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md +++ b/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM.md @@ -150,6 +150,7 @@ _Resource_ функция **decort_kvmvm** принимает следующие | auto_start | bool | :x: | Флаг, отвечающий за авто старт при редеплое компьюта | | force_stop | bool | :x: | Флаг, отвечающий за стоп при редеплое компьюта | | data_disks | string | :x: | Указание того, что делать с дисками при редеплое. Возможные значения: "KEEP", "DETACH" и "DESTROY" | +| restore | bool | :x: | Восстановить удаленный компьют из корзины | ### Описание блока disks @@ -237,78 +238,78 @@ _Resource_ функция **decort_kvmvm** принимает следующие В случае успешного выполнения _resource_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -| ------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | -| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | -| affinity_label | string | Метка для правил affinity | -| affinity_weight | int | weight аффинити | -| arch | string | Архитектура | -| boot_order | []string | Boot order | -| boot_disk | []Struct [см. ниже](#описание-структуры-boot_disk) | Полная информация о бутдиске | -| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. | -| boot_disk_size | int | Размер загрузочного диска в ГБ. | -| 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 | string | Кастомные поля | -| 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 | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | -| 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 | +| Параметр | Тип | Описание | +|--------------------------| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. | +| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. | +| affinity_label | string | Метка для правил affinity | +| affinity_weight | int | weight аффинити | +| arch | string | Архитектура | +| boot_order | []string | Boot order | +| boot_disk | []Struct [см. ниже](#описание-структуры-boot_disk) | Полная информация о бутдиске | +| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. | +| boot_disk_size | int | Размер загрузочного диска в ГБ. | +| 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 | string | Кастомные поля | +| 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 | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| 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 | []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 | Имя ресурсной группы, к которой принадлежит виртуальная машина. | -| sep_id | int | Идентификатор sep | -| 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 | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | +| 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 | []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 | Имя ресурсной группы, к которой принадлежит виртуальная машина. | +| sep_id | int | Идентификатор sep | +| 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 | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. | ### Описание структуры interfaces @@ -317,6 +318,7 @@ _Resource_ функция **decort_kvmvm** принимает следующие | conn_id | int | ID connect | | conn_type | string | Тип connect | | def_gw | string | Шлюз по умолчанию | +| enabled | bool | Доступность подключения | | flip_group_id | int | id flip group | | guid | string | GUID | | ip_address | string | IP адрес | @@ -453,6 +455,7 @@ resource "decort_kvmvm" "my_new_vm" { #enabled = true #is="" #ipa_type = "" + #retore = true } ``` diff --git a/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md b/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md index 5e860e2..76852a5 100644 --- a/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md +++ b/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md @@ -24,24 +24,26 @@ _Resource_ функция **decort_resgroup** служит для управле ## Аргументы _Resource_ функция **decort_resgroup** принимает следующие аргументы: -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. | -| gid | int | :heavy_check_mark: | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. | -| name | string | :heavy_check_mark: | Имя ресурсной группы. Должно быть уникальным в рамках одного и того же подписчика ("account"), не может быть пустым. | -| def_net_type | string | :x: | Тип сети, которая будет установлена по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* "PUBLIC" - создаваемые в данной ресурсной группе экземпляры _compute_ по умолчанию будут подключаться во внешнюю сеть с идентификатором, который задаётся параметром `ext_net_id`
* "PRIVATE" - экземпляры _compute_ по умолчанию будут подключаться в новый виртуальный сетевой сегмент (ViNS ), который платформа автоматически создаст для данной ресурсной группы.
* "NONE" - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | -| description | string | :x: | Текстовое описание данной ресурсной группы.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | -| 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 | Struct [см. ниже](#описание-структуры-quota)| :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Максмальное количество: 1 | -| access | []Struct [см. ниже](#описание-структуры-access)| :x: | Юзеры которым выдется доступ к данной ресурсной группе | -| def_net | Struct [см. ниже](#описание-структуры-def_net)| :x: | Параметры сети ресурсной группы. Максмальное количество: 1| -| register_computes | bool | :x: | Параметр используется при создании rg | +| Аргумент | Тип | Обязательный | Описание | +|-------------------|-------------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. | +| gid | int | :heavy_check_mark: | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. | +| name | string | :heavy_check_mark: | Имя ресурсной группы. Должно быть уникальным в рамках одного и того же подписчика ("account"), не может быть пустым. | +| def_net_type | string | :x: | Тип сети, которая будет установлена по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* "PUBLIC" - создаваемые в данной ресурсной группе экземпляры _compute_ по умолчанию будут подключаться во внешнюю сеть с идентификатором, который задаётся параметром `ext_net_id`
* "PRIVATE" - экземпляры _compute_ по умолчанию будут подключаться в новый виртуальный сетевой сегмент (ViNS ), который платформа автоматически создаст для данной ресурсной группы.
* "NONE" - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | +| description | string | :x: | Текстовое описание данной ресурсной группы.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | +| 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 | Struct [см. ниже](#описание-структуры-quota) | :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Максмальное количество: 1 | +| access | []Struct [см. ниже](#описание-структуры-access) | :x: | Юзеры которым выдется доступ к данной ресурсной группе | +| def_net | Struct [см. ниже](#описание-структуры-def_net) | :x: | Параметры сети ресурсной группы. Максмальное количество: 1 | +| register_computes | bool | :x: | Параметр используется при создании rg | +| owner | string | :x: | Имя пользователя – владелец этой РГ. Оставьте поле пустым, чтобы назначить текущего пользователя владельцем. | +| restore | bool | :x: | Восстановить ресурсную из корзины. | ### Описание структуры quota | Аргумент | Тип | Обязательный | Описание | @@ -156,6 +158,8 @@ resource "decort_resgroup" "my_new_rg" { permanently = false force = false reason = "some reason" + #owner = "new_owner" + #restore=true } ``` diff --git a/07.01.04-Resource-функция-decort_vins-управление-виртуальными-сетевыми-сегментами.md b/07.01.04-Resource-функция-decort_vins-управление-виртуальными-сетевыми-сегментами.md index f0ac720..b47466d 100644 --- a/07.01.04-Resource-функция-decort_vins-управление-виртуальными-сетевыми-сегментами.md +++ b/07.01.04-Resource-функция-decort_vins-управление-виртуальными-сетевыми-сегментами.md @@ -4,7 +4,7 @@ _Resource_ функция **decort_vins** служит для управлени Добавлена обработка статусов виртуальной сети. Если статус __DELETED__, то при попытке изменения конфигурационного файла, сеть будет автоматически восстановлена. Если статус __DESTROYED__, то при попытке изменения конфигурационного файла, сеть будет автоматически пересоздана. -Начиная с версии 3.3.0, в ресурсе kvmvm появляется опциональное поле `enabled`, которое принимает в себя булево значение. Поле отвечает за ручную регуляцию статуса доступности виртуальной сети, автоматическая регуляция так же имеется - восстановленная и вновь созданная виртуальная сеть переводится в режим `enabled = true`. +Начиная с версии 3.3.0, в ресурсе vins появляется опциональное поле `enabled`, которое принимает в себя булево значение. Поле отвечает за ручную регуляцию статуса доступности виртуальной сети, автоматическая регуляция так же имеется - восстановленная и вновь созданная виртуальная сеть переводится в режим `enabled = true`. Добавлена возможность добалять NAT правила через блок nat_rule. Добавлена возможность резервировать и освобождать IP адреса для виртуальной сети с помощью блока ip. Добавлена возможность ручного рестарта виртуальной сети, через опциональное поле `restore` которое принимает в себя булево значение. @@ -17,25 +17,25 @@ _Resource_ функция **decort_vins** служит для управлени ## Аргументы _Resource_ функция **decort_vins** принимает следующие аргументы: -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.
ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).
Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. | -| rg_id | int | :x: | Идентификатор ресурсной группы, в которой должен находиться данный ViNS.
Если требуется создать ViNS на уровне подписчика ("account"), то необходимо указать `rg_id = 0`.
Обратите внимание, что попытка изменить `rg_id` у существующего ресурса приведёт к его пересозданию.| -| account_id | int | :x: | Данный параметр является обязательным независимо от того, создаётся ли ViNS на уровне подписчика или на уровне ресурсной группы.
Идентификатор подписчика ("account"), в котором должен находиться данный ViNS.
Обратите внимание, что попытка изменить `account_id` у существующего ресурса приведёт к его пересозданию. | -| ext_net_id | int | :x: | Идентификатор внешней сети, в которую должен быть подключён ViNS. Если подключение во внешнюю сеть не требуется, то необходимо задать `ext_net_id = 0`.
Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. | -| ext_ip_addr | string | :x: | IP внешней сети | -| ipcidr | string | :x: | IP CIDR, который требуется присвоить внутреннему сегменту данного ViNS.
Данный параметр не является обязательным и принимается во внимание только на стадии создания нового ViNS. Если он не задан, то платформа установит значение самостоятельно. | +| Аргумент | Тип | Обязательный | Описание | +|----------------------| --- | --- | --- | +| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.
ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).
Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. | +| rg_id | int | :x: | Идентификатор ресурсной группы, в которой должен находиться данный ViNS.
Если требуется создать ViNS на уровне подписчика ("account"), то необходимо указать `rg_id = 0`.
Обратите внимание, что попытка изменить `rg_id` у существующего ресурса приведёт к его пересозданию.| +| account_id | int | :x: | Данный параметр является обязательным независимо от того, создаётся ли ViNS на уровне подписчика или на уровне ресурсной группы.
Идентификатор подписчика ("account"), в котором должен находиться данный ViNS.
Обратите внимание, что попытка изменить `account_id` у существующего ресурса приведёт к его пересозданию. | +| ext_net_id | int | :x: | Идентификатор внешней сети, в которую должен быть подключён ViNS. Если подключение во внешнюю сеть не требуется, то необходимо задать `ext_net_id = 0`.
Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. | +| ext_ip_addr | string | :x: | IP внешней сети | +| ipcidr | string | :x: | IP CIDR, который требуется присвоить внутреннему сегменту данного ViNS.
Данный параметр не является обязательным и принимается во внимание только на стадии создания нового ViNS. Если он не задан, то платформа установит значение самостоятельно. | | pre_reservations_num | int | :x: | Кол-во IP адресов, которое будет зарезервировано при создании | -| gid | int | :x: | GRID ID | -| enable | bool | :x: | Флаг, отвечающий за возможность переводить ресурс в состояния enable и disable | -| permanently | bool | :x: | Безвозвратное удаление диска. Используется при удалении| -| force | bool | :x: | Удаление ресурса, в случае если он к чему-то присоединен произойдет отсоединение его от других ресурсов и удаление| -| ip | Struct{} [см. ниже](#описание-структуры-ip)| :x: | Структура для резервирования IP адресов | -| nat_rule | Struct{} [см. ниже](#описание-структуры-nat_rule)| :x: | Структура для того, чтобы задавать правила NAT | -| desc | string | :x: | Текстовое описание данного ViNS.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | -| restore | bool | :x: | Флаг, для восстановления ресурса | -| vnfdev_restart | bool | :x: | Флаг, для рестарта VNF | -| vnfdev_redeploy | bool | :x: | Флаг, для редеплоя VNF | +| gid | int | :x: | GRID ID | +| enabled | bool | :x: | Флаг, отвечающий за возможность переводить ресурс в состояния enable и disable | +| permanently | bool | :x: | Безвозвратное удаление диска. Используется при удалении| +| force | bool | :x: | Удаление ресурса, в случае если он к чему-то присоединен произойдет отсоединение его от других ресурсов и удаление| +| ip | Struct{} [см. ниже](#описание-структуры-ip)| :x: | Структура для резервирования IP адресов | +| nat_rule | Struct{} [см. ниже](#описание-структуры-nat_rule)| :x: | Структура для того, чтобы задавать правила NAT | +| desc | string | :x: | Текстовое описание данного ViNS.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | +| restore | bool | :x: | Флаг, для восстановления ресурса | +| vnfdev_restart | bool | :x: | Флаг, для рестарта VNF | +| vnfdev_redeploy | bool | :x: | Флаг, для редеплоя VNF | ### Описание структуры ip | Аргумент | Тип | Обязательный | Описание | @@ -60,34 +60,45 @@ _Resource_ функция **decort_vins** принимает следующие ## Возвращаемые значения В случае успешного выполнения _Resource_ функция **decort_vins** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -| --- | --- | --- | -| vnf_dev | []Struct{} [см. ниже](#описание-структуры-vnf_dev)| VNFDEV | -| \_ckey | string | CKey | -| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. | -| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | -| computes | []Struct{} [см. ниже](#описание-структуры-computes) | Информация о компьютах | -| default_gw | string | Шлюз по умолчанию | -| default_qos | []Struct{} [см. ниже](#описание-структуры-qos) | qos виртуальной сети | -| desc | string | Текстовое описание ViNS. | -| gid | int | Grid ID | -| guid | int | ID ресурса | -| lock_status | string | Статус доступа виртуальной сети | -| manager_id | int | ID manager | -| manager_type | string | Type of manager | -| milestones | int | Milestones | -| name | string | Имя ViNS. | -| net_mask | int | Маска подсети | -| network | string | Сеть Vins | -| pre_reservations_num | int | Кол-во зарезервированных ip адресов | -| redundant | bool | Redudant | -| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | -| rg_name | string | Имя ресурсной группы | -| sec_vnf_dev_id | int | ID sec vnf | -| status | string | Статус | -| user_managed | bool | Флаг user managed | -| vnfs | []Struct{} [см. ниже](#описание-структуры-vnfs) | VNFS | -| vxlan_id | int | ID vxlan | +| Параметр | Тип | Описание | +|----------------------|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| vnf_dev | []Struct{} [см. ниже](#описание-структуры-vnf_dev) | VNFDEV | +| \_ckey | string | CKey | +| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. | +| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | +| computes | []Struct{} [см. ниже](#описание-структуры-computes) | Информация о компьютах | +| default_gw | string | Шлюз по умолчанию | +| default_qos | []Struct{} [см. ниже](#описание-структуры-qos) | qos виртуальной сети | +| desc | string | Текстовое описание ViNS. | +| gid | int | Grid ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступа виртуальной сети | +| manager_id | int | ID manager | +| manager_type | string | Type of manager | +| milestones | int | Milestones | +| name | string | Имя ViNS. | +| net_mask | int | Маска подсети | +| network | string | Сеть Vins | +| pre_reservations_num | int | Кол-во зарезервированных ip адресов | +| redundant | bool | Redudant | +| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | +| rg_name | string | Имя ресурсной группы | +| sec_vnf_dev_id | int | ID sec vnf | +| status | string | Статус | +| user_managed | bool | Флаг user managed | +| vnfs | []Struct{} [см. ниже](#описание-структуры-vnfs) | VNFS | +| vxlan_id | int | ID vxlan | +| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов | + +### Описание структуры routes +| Параметр | Тип | Описание | +|-------------|--------|-------------------------------------------------| +| compute_ids | []int | Список ID compute, которым предоствавлен доступ | +| route_id | int | ID статического маршрута | +| guid | string | ID ресурса | +| destination | string | IP целевой сети | +| netmask | string | Маска сети | +| gateway | string | IP шлюза | ### Описание структуры vnf_dev @@ -369,7 +380,7 @@ resource "decort_vins" "my_vins" { #опциональный параметр #ручное подключение и отключение ресурса #тип - булев тип - enable = true + #enabled = true #опциональный параметр #удаление навсегда