add: documentation

2026-06-30 15:45:24 +04:00
parent 540c1f7293
commit ca276d200f
1055 changed files with 47294 additions and 0 deletions
@@ -0,0 +1,40 @@
+# Resource: nubes_tubulus_instance
+
+Ресурс `nubes_tubulus_instance` управляет жизненным циклом (создание, приостановка, восстановление) виртуального инстанса в платформе Nubes.
+
+## Пример использования (HCL)
+
+```text
+resource "nubes_tubulus_instance" "example" {
+  display_name     = "nubes-app-server"
+  description      = "Production-ready tubulus instance"
+  duration_ms      = 5000
+  fail_in_progress = false
+  where_fail       = 1
+}
+```
+
+## Параметры (Arguments)
+
+- `display_name` (string, Required) — Отображаемое имя инстанса в UI Nubes.
+- `description` (string, Optional) — Описание назначения ресурса.
+- `duration_ms` (int, Optional) — Задержка перед завершением операции (мс).
+- `fail_at_start` (bool, Optional) — Если true, мгновенный отказ без записи в CMDB.
+- `fail_in_progress` (bool, Optional) — Аварийное завершение после успешного начала операции.
+- `where_fail` (int, Optional) — Точка отказа при `fail_in_progress`: 1 (Prepare), 2 (Data Fill), 3 (Post-Vault).
+- `body_message` (string, Optional) — Произвольное сообщение для сохранения в Vault.
+- `map_example` (string, Optional) — Параметры в формате JSON Map.
+- `json_example` (string, Optional) — Произвольный JSON-объект (строка).
+
+## Атрибуты (Attributes)
+
+- `id` (string) — Уникальный UUID инстанса в облаке.
+- `status` (string) — Текущее состояние ресурса (`running`, `suspended`, `failed`).
+
+## Жизненный цикл и удаление (Soft Delete Policy)
+
+Для ресурса в платформе Nubes действует политика **отложенного удаления (Soft Delete)**:
+
+1. **Destroy / Удаление из манифеста:** При выполнении `terraform destroy` или удалении ресурса из конфигурации, инстанс переводится в статус **Suspended** и переходит в режим **ожидания удаления (Retention Period) на 14 дней**.
+2. **Apply / Resume:** Повторное добавление ресурса в конфигурацию до завершения срока удержания инициирует операцию **Resume**, возвращающую инстанс в работу без потери данных.
+3. **Управление:** Состояние ресурсов в режиме Soft Delete доступно для мониторинга в разделе «Управление облаком» UI Nubes.