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,63 @@
+# Resource nubes_postgres
+
+Service ID: `90`
+
+Service Name: PostgreSQL
+
+[Manual](postgres.md) | [Create params](postgres_params_create.md) | [Modify params](postgres_params_modify.md) | [Output params](postgres_outputs.md) | [Operations](postgres_ops.md) | [Example](postgres_example.md)
+
+## Copy-ready manifest (`postgres_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_postgres" "baza" {
+  s3_uid = "235e0546-..." # Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно
+  resource_realm = "TODO" # Платформа для развертывания
+
+  # Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте
+  resource_instances = 1 # Количество узлов
+  resource_memory = 512 # Квота памяти пода (MBytes)
+  resource_c_p_u = 500 # Квота ядра пода (milicores)
+  resource_disk = 10 # Квота диска (Указывается в GIGAbytes)
+  need_external_address_master = false # Выделяет внешний (белый) IP для доступа к master
+  need_external_address_slave = false # Выделяет внешний (белый) IP для доступа к slave. Будет работать, если slave в принципе есть
+  ext__b_a_c_k_u_p__s_c_h_e_d_u_l_e = "0 0 * * *" # Не обязательный. Время запуска бекапа
+  ext__b_a_c_k_u_p__n_u_m__t_o__r_e_t_a_i_n = 7 # Не обязательный. Количество сохраняемых бекапов
+  app_version = 17 # Версия PostgreSQL
+  json_parameters = { "log_connections": "off", "log_disconnections": "off" } # Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html
+  enable_pg_pooler_master = false # Включает pgPooler (на запись). Будет создан новый под
+  enable_pg_pooler_slave = false # Включает pgPooler (на чтение). Будет создан новый под
+  allow_no_s_s_l = false # По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр
+  auto_scale = false # Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги
+  auto_scale_percentage = 10 # Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема
+  auto_scale_tech_window = 0 # Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)
+  auto_scale_quota_gb = 1 # Квота для autoScale
+}
+```
+
+## Outputs usage
+
+```hcl
+# Выходные параметры можно использовать как
+nubes_postgres.baza.state_params["имя_ключа"]
+nubes_postgres.baza.state_out["имя_ключа"]
+nubes_postgres.baza.state_params_flat["имя_ключа"]
+nubes_postgres.baza.state_out_flat["имя_ключа"]
+nubes_postgres.baza.vault_secrets["имя_ключа"]
+nubes_postgres.baza.vault_url
+nubes_postgres.baza.vault_user_path
+nubes_postgres.baza.vault_fields
+```