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,49 @@
+# Resource nubes_dummy
+
+Service ID: `1`
+
+Service Name: Болванка
+
+[Manual](dummy.md) | [Create params](dummy_params_create.md) | [Modify params](dummy_params_modify.md) | [Output params](dummy_outputs.md) | [Operations](dummy_ops.md) | [Example](dummy_example.md)
+
+## Copy-ready manifest (`dummy_main.tf`)
+
+```hcl
+terraform {
+  required_providers {
+    nubes = {
+      source  = "terra.k8c.ru/nubes/nubes"
+      version = "2.1.23"
+    }
+  }
+}
+
+# Токен доступа api_token к Nubes API  — замените на реальный.
+provider "nubes" {
+  api_token    = "token_***"
+  api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
+}
+resource "nubes_dummy" "baza" {
+  resource_realm = "TODO" # Платформа для развертывания
+
+  # Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
+  duration_ms = 0 # перед завершением подождать (sleep) столько миллисекунд
+  fail_at_start = false # если true, завершить джоб, ничего не записывая в cmdb
+  fail_in_progress = false # если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb
+  where_fail = 1 # принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write
+}
+```
+
+## Outputs usage
+
+```hcl
+# Выходные параметры можно использовать как
+nubes_dummy.baza.state_params["имя_ключа"]
+nubes_dummy.baza.state_out["имя_ключа"]
+nubes_dummy.baza.state_params_flat["имя_ключа"]
+nubes_dummy.baza.state_out_flat["имя_ключа"]
+nubes_dummy.baza.vault_secrets["имя_ключа"]
+nubes_dummy.baza.vault_url
+nubes_dummy.baza.vault_user_path
+nubes_dummy.baza.vault_fields
+```