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,48 @@
+# Resource nubes_s3
+
+Service ID: `12`
+
+Service Name: S3 Object Storage
+
+[Manual](s3.md) | [Create params](s3_params_create.md) | [Modify params](s3_params_modify.md) | [Output params](s3_outputs.md) | [Operations](s3_ops.md) | [Example](s3_example.md)
+
+## Output params
+
+- `state_params` (map) — параметры, отправленные в API при создании/изменении
+- `state_out` (map) — ответ API с результатами/выходными значениями
+- `state_params_flat` (map) — параметры в плоском виде (ключи с путями)
+- `state_out_flat` (map) — ответы в плоском виде (ключи с путями)
+- `vault_secrets` (map) — секреты, записанные в Vault для ресурса
+- `vault_url` (string) — адрес Vault для ресурса
+- `vault_user_path` (string) — путь пользователя в Vault
+- `vault_fields` (list) — список ключей доступных секретов
+
+## Реальные поля из облака (test / naeel-s3 / running)
+
+Поля ниже получены из реальных инстансов этого сервиса в облаке.
+Используйте их как готовые ключи для `state_out_flat` и `vault_secrets`.
+
+### `state_params` ключи
+
+- `state_params["userName"]`
+- `state_params["resourceRealm"]`
+- `state_params["maxSizeGbPerUser"]`
+- `state_params["maxBucketsPerUser"]`
+- `state_params["maxObjectsPerBucket"]`
+
+### `state_out_flat` ключи
+
+- `state_out_flat["isTrial"]`
+- `state_out_flat["dtEndTrial"]`
+- `state_out_flat["monitoring"]`
+- `state_out_flat["monitoring.s3ceph"]`
+- `state_out_flat["monitoring.s3ceph.url"]`
+- `state_out_flat["monitoring.resourceMetrics"]`
+- `state_out_flat["urlConnect"]`
+- `state_out_flat["dtStartTrial"]`
+
+### `vault_secrets` ключи
+
+- `vault_secrets["url"]`
+- `vault_secrets["fields"]`
+- `vault_secrets["userPath"]`