Create resource decort_delete_images, add a description

stSolo
2022-03-28 18:46:43 +03:00
parent a519e63c2c
commit 523a06a322

@@ -0,0 +1,39 @@
**Внимание:** необходимы права администратора.
_Resource_ функция **decort_delete_images** служит для удаления нескольких образов. _Resource_ является чисто служебным и ничего не создает, не изменяет.
Для того, чтобы удалить образы, необходимо:
1. Создать .tf - файл и добавить в него данные.
2. Ввести команды в консоли:
```bash
terraform init
terraform apply
terraform destroy
```
3. После введения последней команды, образы удалятся из системы.
Если имеется необходимо повторить удаление, но с другими данными, рекомендуется удалить файл состояния terraform - .tfstate, .tfstate.backup.
После этого, рекомендуется повторить все с первого этапа.
## Аргументы
_Resource_ функция **decort_delete_images** для создания образа принимает следующие аргументы:
| Аргумент | Тип | Описание |
| --- | --- | --- |
| images_ids | []int | Обязательный параметр,<br/>массив, содержащий набор id образов для удаления |
| reason | string | Обязательный параметр,<br/>причина удаления |
| permanently | bool | Опциональный тип,<br/>параметр удаления<br/>по-умолчанию - false |
## Возвращаемые значения
Отсутствуют
## Пример использования
Пример вызова _resource_ функции **decort_image**:
```terraform
resource "decort_delete_images" "my_images" {
image_ids = [1111]
reason = "test delete"
permanently = true
}
```
Данный пример подразумевает, что ранее по тексту 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.)).