Создание PostgreSQL-кластера

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы создать кластер:

1. Проверьте, есть ли в каталоге подсети для хостов кластера:

   yc vpc subnet list
   

   Если ни одной подсети в каталоге нет, создайте нужные подсети в сервисе VPC.

2. Посмотрите описание команды CLI для создания кластера:

   yc managed-postgresql cluster create --help
   

3. Укажите параметры кластера в команде создания (в примере приведены не все доступные параметры):

   yc managed-postgresql cluster create \
      --name <имя кластера> \
      --environment <окружение, prestable или production> \
      --network-name <имя сети> \
      --host zone-id=<зона доступности>,subnet-id=<идентификатор подсети> \
      --resource-preset <класс хоста> \
      --user name=<имя пользователя>,password=<пароль пользователя> \
      --database name=<имя базы данных>,owner=<имя владельца базы данных> \
      --disk-size <объем хранилища, ГБ> \
      --disk-type <network-hdd | network-ssd | local-ssd | network-ssd-nonreplicated> \
      --security-group-ids <список идентификаторов групп безопасности> \
      --connection-pooling-mode=<режим работы менеджера соединений> \
      --deletion-protection=<защита от удаления кластера: true или false> \
      --serverless-access
   

   Идентификатор подсети subnet-id необходимо указывать, если в выбранной зоне доступности создано две и более подсети.

   Доступные режимы работы менеджера соединений: SESSION, TRANSACTION или STATEMENT.

   Включенная защита от удаления кластера не помешает подключиться вручную и удалить содержимое базы данных.

   Также вы можете указать несколько дополнительных опций в параметре --host для управления репликацией в кластере:

   • Источник репликации для хоста в опции replication-source для того, чтобы вручную управлять потоками репликации.
   • Приоритет хоста в опции priority для того, чтобы влиять на процесс выбора мастера:
     • Хост с наибольшим значением приоритета в кластере становится синхронной репликой.
     • Если в кластере есть несколько хостов с наибольшим приоритетом, то среди них проводятся выборы мастера.
     • Наименьший приоритет — 0 (по умолчанию), наивысший — 100.

   Чтобы разрешить доступ к кластеру из сервиса Yandex Cloud Functions, передайте параметр --serverless-access. Подробнее о настройке доступа см. в документации Cloud Functions.

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). Terraform и его провайдеры распространяются под лицензией Mozilla Public License.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Если у вас еще нет Terraform, установите его и настройте провайдер.

Чтобы создать кластер:

1. Опишите в конфигурационном файле параметры ресурсов, которые необходимо создать:

   • Кластер базы данных — описание кластера и его хостов.

   • Сеть — описание облачной сети, в которой будет расположен кластер. Если подходящая сеть у вас уже есть, описывать ее повторно не нужно.

   • Подсети — описание подсетей, к которым будут подключены хосты кластера. Если подходящие подсети у вас уже есть, описывать их повторно не нужно.

   Пример структуры конфигурационного файла:

   terraform {
     required_providers {
       yandex = {
         source = "yandex-cloud/yandex"
       }
     }
   }
   
   provider "yandex" {
     token     = "<OAuth или статический ключ сервисного аккаунта>"
     cloud_id  = "<идентификатор облака>"
     folder_id = "<идентификатор каталога>"
     zone      = "<зона доступности>"
   }
   
   resource "yandex_mdb_postgresql_cluster" "<имя кластера>" {
     name                = "<имя кластера>"
     environment         = "<окружение, PRESTABLE или PRODUCTION>"
     network_id          = "<идентификатор сети>"
     security_group_ids  = [ "<список групп безопасности>" ]
     deletion_protection = <защита от удаления кластера: true или false>
   
     config {
       version = "<версия PostgreSQL>"
       resources {
         resource_preset_id = "<класс хоста>"
         disk_type_id       = "<тип хранилища>"
         disk_size          = <объем хранилища, ГБ>
       }
       pooler_config {
         pool_discard = <параметр Odyssey pool_discard: true или false>
         pooling_mode = "<режим работы: SESSION, TRANSACTION или STATEMENT>"
       }
       ...
     }
   
     database {
       name  = "<имя базы данных>"
       owner = "<имя владельца базы данных>"
     }
   
     user {
       name     = "<имя пользователя>"
       password = "<пароль пользователя>"
       permission {
         database_name = "<имя базы данных>"
       }
     }
   
     host {
       zone      = "<зона доступности>"
       subnet_id = "<идентификатор подсети>"
     }
   }
   
   resource "yandex_vpc_network" "<имя сети>" { name = "<имя сети>" }
   
   resource "yandex_vpc_subnet" "<имя подсети>" {
     name           = "<имя подсети>"
     zone           = "<зона доступности>"
     network_id     = "<идентификатор сети>"
     v4_cidr_blocks = ["<диапазон>"]
   }
   

   Включенная защита от удаления кластера не помешает подключиться вручную и удалить содержимое базы данных.

   Чтобы настроить время технического обслуживания (в т. ч. для выключенных кластеров), добавьте к описанию кластера блок maintenance_window:

   resource "yandex_mdb_postgresql_cluster" "<имя кластера>" {
     ...
     maintenance_window {
       type = <тип технического обслуживания: ANYTIME или WEEKLY>
       day  = <день недели для типа WEEKLY>
       hour = <час дня для типа WEEKLY>
     }
     ...
   }
   

   Где:

   • type — тип технического обслуживания:
     • ANYTIME — в любое время.
     • WEEKLY — по расписанию.
   • day — день недели для типа WEEKLY в формате DDD. Например, MON.
   • hour — час дня по UTC для типа WEEKLY в формате HH. Например, 21.

   Полный список доступных для изменения полей конфигурации кластера Managed Service for PostgreSQL см. в документации провайдера Terraform.

2. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

3. Создайте кластер.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

   Ограничения по времени

   Провайдер Terraform ограничивает время на выполнение операций с кластером Managed Service for PostgreSQL:

   • создание, в том числе путем восстановления из резервной копии, — 30 минут;
   • обновление — 60 минут;
   • удаление — 15 минут.

   Операции, длящиеся дольше указанного времени, прерываются.

   Как изменить эти ограничения?

   Добавьте к описанию кластера блок timeouts, например:

   resource "yandex_mdb_postgresql_cluster" "<имя кластера>" {
     ...
     timeouts {
       create = "1h30m" # Полтора часа
       update = "2h"    # 2 часа
       delete = "30m"   # 30 минут
     }
   }
   

Воспользуйтесь методом API create и передайте в запросе:

• Идентификатор каталога, в котором должен быть размещен кластер, в параметре folderId.
• Имя кластера в параметре name.
• Окружение кластера в параметре environment.
• Идентификатор сети в параметре networkId.
• Конфигурацию кластера в параметре configSpec.
• Конфигурацию хостов кластера в одном или нескольких параметрах hostSpecs.
• Идентификаторы групп безопасности в параметре securityGroupIds.
• Конфигурацию баз данных в одном или нескольких параметрах databaseSpecs.
• Настройки пользователей в одном или нескольких параметрах userSpecs.

Чтобы разрешить доступ к кластеру из сервиса Yandex Cloud Functions, передайте значение true для параметра configSpec.access.serverless. Подробнее о настройке доступа см. в документации Cloud Functions.

Допустим, нужно создать PostgreSQL-кластер и сеть для него со следующими характеристиками:

• С именем mypg.
• Версии 14.
• В окружении PRESTABLE.
• В облаке с идентификатором b1gq90dgh25bebiu75o.
• В каталоге с идентификатором b1gia87mbaomkfvsleds.
• В новой сети mynet.
• В новой группе безопасности pgsql-sg, разрешающей подключение к кластеру из интернета через порт 6432.
• С одним хостом класса s2.micro в новой подсети mysubnet, в зоне доступности ru-central1-c. Подсеть mysubnet будет иметь диапазон 10.5.0.0/24.
• С хранилищем на сетевых SSD-дисках (network-ssd) объемом 20 ГБ.
• С одним пользователем (user1), с паролем user1user1.
• С одной базой данных db1, принадлежащей пользователю user1.
• С защитой от случайного удаления кластера.

Конфигурационный файл для такого кластера выглядит так:

terraform {
  required_providers {
    yandex = {
      source = "yandex-cloud/yandex"
    }
  }
}

provider "yandex" {
  token     = "<OAuth или статический ключ сервисного аккаунта>"
  cloud_id  = "b1gq90dgh25bebiu75o"
  folder_id = "b1gia87mbaomkfvsleds"
  zone      = "ru-central1-c"
}

resource "yandex_mdb_postgresql_cluster" "mypg" {
  name                = "mypg"
  environment         = "PRESTABLE"
  network_id          = yandex_vpc_network.mynet.id
  security_group_ids  = [ yandex_vpc_security_group.pgsql-sg.id ]
  deletion_protection = true

  config {
    version = 14
    resources {
      resource_preset_id = "s2.micro"
      disk_type_id       = "network-ssd"
      disk_size          = "20"
    }
  }

  database {
    name  = "db1"
    owner = "user1"
  }

  user {
    name     = "user1"
    password = "user1user1"
    permission {
      database_name = "db1"
    }
  }

  host {
    zone      = "ru-central1-c"
    subnet_id = yandex_vpc_subnet.mysubnet.id
  }
}

resource "yandex_vpc_network" "mynet" {
  name = "mynet"
}

resource "yandex_vpc_subnet" "mysubnet" {
  name           = "mysubnet"
  zone           = "ru-central1-c"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.5.0.0/24"]
}

resource "yandex_vpc_security_group" "pgsql-sg" {
  name       = "pgsql-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "PostgreSQL"
    port           = 6432
    protocol       = "TCP"
    v4_cidr_blocks = [ "0.0.0.0/0" ]
  }
}