diff --git a/07.02.13-Resource-функция-decort_cb_disk-управление-дисковыми-ресурсами.md b/07.02.13-Resource-функция-decort_cb_disk-управление-дисковыми-ресурсами.md new file mode 100644 index 0000000..d1b4436 --- /dev/null +++ b/07.02.13-Resource-функция-decort_cb_disk-управление-дисковыми-ресурсами.md @@ -0,0 +1,153 @@ +_Resource_ функция **decort_cb_disk** служит для управления дисковыми ресурсами ("disk") в облачной платформе DECORT. + +## Аргументы +_Resource_ функция **decort_cb_disk** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_id | int | :heavy_check_mark: | id аккаунта | +| disk_name | string | :heavy_check_mark: | Наименование диска | +| size_max | int | :heavy_check_mark: | Размер диска, ГБ | +| gid | int | :heavy_check_mark: | id площадки (grid id) | +| type | string | :heavy_check_mark: | Тип диска, не может быть изменен после создания. Доступные значения:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | +| pool | string | :x: | Pool для расположения диска | +| sep_id | int | :x: | id sep | +|ssd_size| int | :x: | Размер в ГБ | +|iops| int | :x: | Максимальное значение IOPS диска, которое можно выполнять. Значение по умолчанию 2000. | +| desc | string | :x: | Описание диска | +| detach | bool | :x: | Отсоединение диска от compute. Используется при удалении | +| permanently | bool | :x: | Мгновенное удаление диска. Используется при удалении | +| reason | string | :x: | Причина удаления. Используется при удалении | +| shareable | bool | :x: | Флаг, отвечающий за доступность диска дургим ресурсам | +| restore | bool | :x: | Восстановление диска | +| iotune | Struct{
read_bytes_sec int
read_bytes_sec_max int
read_iops_sec int
read_iops_sec_max int
size_iops_sec int
total_bytes_sec int
total_bytes_sec_max int
total_iops_sec int
total_iops_sec_max int
write_bytes_sec int
write_bytes_sec_max int
write_iops_sec int
write_iops_sec_max int
} | :x: | Информация об ограничениях IO диска
Кол-во байт для чтения в секунду
Максимальное кол-во байт для чтения
 
Кол-во операций чтения io в секунду
Максимальное число io операций чтения
Размер io операций
Общий размер байт в секунду
Максимальный общий размер байт в секунду
 
Общее кол-во io операций в секунду
Максимальное общее кол-во io операций в секунду
 
Кол-во байт для записи в секунду
Максимальное кол-во байт для записи в секунду
 
Кол-во операций записи в секунду
Максимальное число операций записей
 
| + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_disk** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +|-----------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| account_id | int | Уникальный идентификатор подписчика-владельца диска | +| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск | +| acl | string | Acces Control List | +| boot_partition | int | Кол-во разделов диска | +| computes | []Struct [см. ниже](#описание-структуры-computes) | Информация о подключенных виртуальных машинах | +| created_time | int | Время создания | +| deleted_time | int | Время удаления | +| desc | string | Текстовое описание диска | +| destruction_time | int | Время окончательного удаления | +| devicename | string | Наименование устройства | +| disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. | +| disk_path | string | Адрес диска | +| gid | int | Идентификатор площадки (grid id) | +| guid | int | Идентификатор диска | +| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа | +| images | []int | Идентификаторы образов, использующих диск | +| iotune | []Struct [см. ниже](#описание-структуры-iotune) | Информация об ограничениях IO диска | +| iqn | string | iqn диска | +| login | string | Логин для доступа к диску | +| milestones | int | Вехи | +| disk_name | string | Наименование диска | +| order | int | Номер диска | +| params | string | Параметры диска | +| parent_id | int | id родительского диска | +| passwd | string | Пароль для доступа к диску | +| pci_slot | int | id pci слота, к которому подключен диск | +| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск | +| present_to | []int | Список ID ресурсов, которым предоставлен диск | +| purge_attempts | int | Кол-во попыток удаления | +| purge_time | int | Время последней попытки | +| reality_device_number | int | Реальный номер устройства | +| reference_id | int | id ссылки на диск | +| res_id | int | id ресурса | +| res_name | string | Наименование ресурса | +| role | string | Роль диска | +| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | +| sep_type | string | Тип 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 | Идентификатор виртуальной машины (устаревшее) | + +### Описание структуры computes +| Параметр | Тип | Описание | +| --- | --- | --- | +| compute_id | int | Идентификатор compute (виртуальной машины) | +| compute_name | string | Название compute (виртуальной машины) | + +### Описание структуры 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 | Наименование снимка | +| reference_id | int | Reference ID | +| res_id | string | Ссылка на снимок | +| snap_set_guid | string | Установленный id снимка | +| snap_set_time | int | Установленное время снимка | +| timestamp | int | Время снимка | + +## Пример использования +```terraform +resource "decort_cb_disk" "my_disk01" { + account_id = 88366 + gid = 212 + disk_name = "super-disk-re" + type = "d" + size_max = 20 + + #desc = "description" + #ssd_size = 1 + #iops = 1 + #sep_id = 1 + #pool = 1 + + #restore = true + #permanently = true + #detach = true + #reason = "delete" + #shareable = true + +/* + iotune { + #read_bytes_sec = 0 + #read_bytes_sec_max = 0 + #read_iops_sec = 0 + #read_iops_sec_max = 0 + #size_iops_sec = 0 + #total_bytes_sec = 0 + #total_bytes_sec_max = 0 + #total_iops_sec = 3000 + #total_iops_sec_max = 0 + #write_bytes_sec = 0 + #write_bytes_sec_max = 0 + #write_iops_sec = 0 + #write_iops_sec_max = 0 + } +*/ +} +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова _resource_ функции **decort_cb_disk** в переменной `decort_cb_disk.my_disk01` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `decort_disk.decort_cb_disk.disk_id`. diff --git a/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами.md b/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами.md deleted file mode 100644 index c18caed..0000000 --- a/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами.md +++ /dev/null @@ -1,84 +0,0 @@ -_Resource_ функция **decort_disk** служит для управления дисковыми ресурсами ("disk") в облачной платформе DECORT. - -## Аргументы -_Resource_ функция **decort_disk** принимает следующие аргументы: - -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| account_id | int | :heavy_check_mark: | id аккаунта | -| disk_name | string | :heavy_check_mark: | Наименование диска | -| size_max | int | :heavy_check_mark: | Размер диска, ГБ | -| gid | int | :heavy_check_mark: | id площадки (grid id) | -| pool | string | :x: | Pool для расположения диска | -| sep_id | int | :x: | id sep | -| desc | string | :x: | Описание диска | -| type | string | Тип диска, не может быть изменен после создания. Доступные значения:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | -| detach | bool | :x: | Отсоединение диска от compute. Используется при удалении | -| permanently | bool | :x: | Мгновенное удаление диска. Используется при удалении | -| reason | string | :x: | Причина удаления. Используется при удалении | -| restore | bool | :x: | Восстановление диска | -| iotune | Struct{
read_bytes_sec int
read_bytes_sec_max int
read_iops_sec int
read_iops_sec_max int
size_iops_sec int
total_bytes_sec int
total_bytes_sec_max int
total_iops_sec int
total_iops_sec_max int
write_bytes_sec int
write_bytes_sec_max int
write_iops_sec int
write_iops_sec_max int
} | :x: | Информация об ограничениях IO диска
Кол-во байт для чтения в секунду
Максимальное кол-во байт для чтения
 
Кол-во операций чтения io в секунду
Максимальное число io операций чтения
Размер io операций
Общий размер байт в секунду
Максимальный общий размер байт в секунду
 
Общее кол-во io операций в секунду
Максимальное общее кол-во io операций в секунду
 
Кол-во байт для записи в секунду
Максимальное кол-во байт для записи в секунду
 
Кол-во операций записи в секунду
Максимальное число операций записей
 
| - -## Возвращаемые значения -В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения: - -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | Уникальный идентификатор подписчика-владельца диска | -| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск | -| boot_partition | int | Кол-во разделов диска | -| compute_id | int | Идентификатор compute (виртуальной машины) | -| compute_name | string | Название compute (виртуальной машины) | -| created_time | int | Время создания | -| deleted_time | int | Время удаления | -| desc | string | Текстовое описание диска | -| destruction_time | int | Время окончательного удаления | -| devicename | string | Наименование устройства | -| disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. | -| disk_path | string | Адрес диска | -| gid | int | Идентификатор площадки (grid id) | -| guid | int | Идентификатор диска | -| id | int | Идентификатор диска | -| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа | -| images | []int | Идентификаторы образов, использующих диск | -| iotune | Struct{
read_bytes_sec int
read_bytes_sec_max int
read_iops_sec int
read_iops_sec_max int
size_iops_sec int
total_bytes_sec int
total_bytes_sec_max int
total_iops_sec int
total_iops_sec_max int
write_bytes_sec int
write_bytes_sec_max int
write_iops_sec int
write_iops_sec_max int
} | Информация об ограничениях IO диска
Кол-во байт для чтения в секунду
Максимальное кол-во байт для чтения
 
Кол-во операций чтения io в секунду
Максимальное число io операций чтения
Размер io операций
Общий размер байт в секунду
Максимальный общий размер байт в секунду
 
Общее кол-во io операций в секунду
Максимальное общее кол-во io операций в секунду
 
Кол-во байт для записи в секунду
Максимальное кол-во байт для записи в секунду
 
Кол-во операций записи в секунду
Максимальное число операций записей
 
| -| iqn | string | iqn диска | -| login | string | Логин для доступа к диску | -| milestones | int | Вехи | -| disk_name | string | Наименование диска | -| order | int | Номер диска | -| params | string | Параметры диска | -| parent_id | int | id родительского диска | -| passwd | string | Пароль для доступа к диску | -| pci_slot | int | id pci слота, к которому подключен диск | -| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск | -| purge_attempts | int | Кол-во попыток удаления | -| purge_time | int | Время последней попытки | -| reality_device_number | int | Реальный номер устройства | -| reference_id | int | id ссылки на диск | -| res_id | int | id ресурса | -| res_name | string | Наименование ресурса | -| role | string | Роль диска | -| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | -| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений | -| size_max | int | Размер диска в ГБ | -| size_used | int | Кол-во используемого места, в ГБ | -| snapshots | []Struct{
guid string
label string
res_id string
snap_set_guid string
snap_set_time int
timestamp int
} | Снимки состояния диска
id снимка
Наименование снимка
Ссылка на снимок
Установленный id снимка
Установленное время снимка
Время снимка
 
| -| status | string | Статус диска | -| tech_status | string | Технический статус диска | -| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | -| vmid | int | Идентификатор виртуальной машины (устаревшее) | - -## Пример использования -```terraform -resource "decort_disk" "my_disk01" { - name = "MyDisk01" - account_id = 100 - size_max = 10 - gid = 333 -} -``` - -Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). - -После успешного завершения такого вызова _resource_ функции **decort_disk** в переменной `decort_disk.my_disk01` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `decort_disk.my_disk01.id`. diff --git a/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска.md b/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска.md new file mode 100644 index 0000000..b072f79 --- /dev/null +++ b/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска.md @@ -0,0 +1,44 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Resource_ функция **decort_cb_disk_snapshot** служит для управления снимками данных диска. Функция позволяет: +- Получить снимок +- Удалить снимок +- Произвести "откат" диска к этому снимку + +## Аргументы +_Resource_ функция **decort_cb_disk_snapshot** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | :---: |------------------------------------------------------------------------------------| +| disk_id | int | :heavy_check_mark: | ID диска, к которому принадлежит снимок | +| label | string | :heavy_check_mark: | Название снимка | +| rollback | bool | :x: | Откат диска. Происходит только при изменении с false на true. По умолчанию - false | +| timestamp | int | :x: | Время отката. Используется только при осуществлении отката | + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_disk_snapshot** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- |--------| --- | +| disk_id | int | ID диска, к которому принадлежит снимок | +| label | string | Название снимка | +| rollback | bool | Откат диска. Происходит только при изменении с false на true. По умолчанию - false | +| timestamp | int | Время отката. Используется только при осуществлении отката | +| guid | string | ID снимка | +| reference_id | string | ID ссылки | +| res_id | string | Ссылка на снимок | +| snap_set_guid | string | ID набора снимков, в котором лежит снимок состояния | +| snap_set_time | int | Время набора | + +## Пример использования +Пример вызова _resource_ функции **decort_cb_disk_snapshot**: +```terraform +resource "decort_cb_disk_snapshot" "ds" { + disk_id = 20100 + label = "label" + #rollback = false + #timestamp = 15 +} +``` + +После успешного завершения такого вызова **decort_cb_disk_snapshot** в переменной `decort_cb_disk_snapshot.ds` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index 08fdeb5..f3415f0 100644 --- a/Home.md +++ b/Home.md @@ -215,7 +215,7 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.11-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM - [**decort_cb_rg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.14-Resource-функция-decort_cb_rg-управление-ресурсными-группами) - управление ресурсными группами - [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями) - управление внешними сетями - - [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами. + - [**decort_cb_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_cb_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами. - [**decort_cb_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами) - управление виртуальными сетевыми сегментами. - [**decort_k8s**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.10-Resource-функция-decort_k8s-управление-кластером-kubernetes) - управление кластером - [**decort_k8s_wg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.09-Resource-функция-decort_k8s_wg-управление-worker-groups-кластера) - управление worker group кластера @@ -234,6 +234,7 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_lb_frontend**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.20-Resource-функция-decort_cb_lb_frontend-управление-фронтендом-балансировщиком-нагрузки) управление фронтендом балансировщиком нагрузки - [**decort_cb_lb_frontend_bind**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки) - управление привязками фронтенда балансировщиком нагрузки - [**decort_cb_vins_static_route**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.22-Resource-функция-decort_cb_vins_static_route-управление-статическим-маршрутом-для-внутренней-сети) - управление статическим маршрутом для внутренней сети + - [**decort_cb_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.23-Resource-функция-decort_cb_disk_snapshot-управление-снимком-диска) - управление снимком диска --> 8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы)