docs: full postgres documentation rewrite — sub-field tables, working HCL examples for create/modify/user/database

2026-07-03 17:02:08 +04:00
parent 1e3038af63
commit 595c9250a1
11 changed files with 412 additions and 117 deletions
@@ -12,39 +12,108 @@ Service Name: PostgreSQL
 terraform {
  required_providers {
    nubes = {
-      source  = "terra.k8c.ru/nubes/nubes"
-      version = "2.1.23"
+      source  = "terra.k8c.ru/nubes-test/nubes"
+      version = "5.0.57"
    }
  }
 }

-# Токен доступа api_token к Nubes API  — замените на реальный.
-provider "nubes" {
-  api_token    = "token_***"
-  api_endpoint = "https://deck-api.ngcloud.ru/api/v1/index.cfm"
+variable "api_token" {
+  type      = string
+  sensitive = true
+}
+variable "s3_uid" {
+  type = string
+}
+variable "realm" {
+  type = string
 }
-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
+provider "nubes" {
+  api_token    = var.api_token
+  api_endpoint = "https://lk-api-gateway-test.ngcloud.ru/api/v1/svc"
+}
+
+# =============================================================================
+# PostgreSQL — основной ресурс
+# =============================================================================
+resource "nubes_postgres" "baza" {
+  resource_name = "pg-my-instance"
+
+  # Платформа развёртывания
+  startup_configuration = jsonencode({
+    resourceRealm = var.realm
+  })
+
+  # Размер кластера
+  cluster_configuration = jsonencode({
+    cpu      = "500"
+    memory   = "512"
+    replicas = "1"
+    disk     = "10"
+  })
+
+  # Сетевой доступ
+  access_configuration = jsonencode({
+    masterIpSpace    = "no-needed"
+    masterAccessList = []
+    slaveIpSpace     = "no-needed"
+    slaveAccessList  = []
+  })
+
+  # Параметры PostgreSQL
+  postgres_configuration = jsonencode({
+    version      = "17"
+    sslRequired  = true
+    poolerMaster = false
+    poolerSlave  = false
+  })
+
+  # Доп. параметры postgresql.conf (опционально)
+  postgres_conf = jsonencode([
+    {
+      paramName  = "log_connections"
+      paramValue = "''"
+    }
+  ])
+
+  # Резервное копирование
+  backup_configuration = jsonencode({
+    s3Uid    = var.s3_uid
+    retain   = "7"
+    schedule = "0 0 * * *"
+  })
+
+  # Автоскейлинг
+  autoscale_configuration = jsonencode({
+    enabled  = false
+    schedule = "0"
+    percent  = "10"
+    quota    = "100"
+  })
+
+  operation_timeout        = "11m"
+  adopt_existing_on_create = true
+}
+
+# =============================================================================
+# Пользователь базы данных
+# =============================================================================
+resource "nubes_postgres_user" "app_user" {
+  postgres_id              = nubes_postgres.baza.id
+  username                 = "myapp"
+  role                     = "app_user"
+  adopt_existing_on_create = true
+}
+
+# =============================================================================
+# База данных
+# =============================================================================
+resource "nubes_postgres_database" "app_db" {
+  postgres_id              = nubes_postgres.baza.id
+  db_name                  = "myappdb"
+  db_owner                 = nubes_postgres_user.app_user.username
+  adopt_existing_on_create = true
 }
 ```

@@ -61,3 +130,11 @@ nubes_postgres.baza.vault_url
 nubes_postgres.baza.vault_user_path
 nubes_postgres.baza.vault_fields
 ```
+
+## terraform.tfvars
+
+```hcl
+api_token = "ваш_токен"
+s3_uid    = "UUID-S3-Object-Storage"
+realm     = "k8s-3-sandbox-nubes-ru"
+```