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,51 @@
+# Resource nubes_s3bucket
+
+Service ID: `13`
+
+Service Name: S3 бакет
+
+[Manual](s3bucket.md) | [Create params](s3bucket_params_create.md) | [Modify params](s3bucket_params_modify.md) | [Output params](s3bucket_outputs.md) | [Operations](s3bucket_ops.md) | [Example](s3bucket_example.md)
+
+## Copy-ready manifest (`s3bucket_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_s3bucket" "baza" {
+  s3_user_uid = "235e0546-..." # UID Корневой услуги S3. На основе него будет создан бакет.
+  bucket_name = "TODO" # Имя бакета s3
+
+  # Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
+  max_size = -1 # Максимальный размер бакета s3. Если поставить -1, будет безлимит. Размер указывается в Bytes
+  read_all = false # Публичный доступ на чтение позволяет любому пользователю интернета скачивать объекты из бакета.
+  list_all = false # Публичный доступ к листингу позволяет любому пользователю интернета получить список объектов в бакете.
+  cors_all = false # Публичный доступ к чтению настроек позволяет любому пользователю интернета читать конфигурации CORS
+  placement = "HOT" # Класс хранилища, который используется по умолчанию при загрузке объектов. Чем холоднее, тем дешевле место, но дороже обращения
+}
+```
+
+## Outputs usage
+
+```hcl
+# Выходные параметры можно использовать как
+nubes_s3bucket.baza.state_params["имя_ключа"]
+nubes_s3bucket.baza.state_out["имя_ключа"]
+nubes_s3bucket.baza.state_params_flat["имя_ключа"]
+nubes_s3bucket.baza.state_out_flat["имя_ключа"]
+nubes_s3bucket.baza.vault_secrets["имя_ключа"]
+nubes_s3bucket.baza.vault_url
+nubes_s3bucket.baza.vault_user_path
+nubes_s3bucket.baza.vault_fields
+```