Подключение к кластеру PostgreSQL из приложений

1. Подключитесь к базе данных:

   psql "host=<список_хостов_кластера> \
         port=6432 \
         sslmode=verify-full \
         dbname=<имя_БД> \
         user=<имя_пользователя> \
         target_session_attrs=read-write"
   

   В параметре host указываются хосты кластера через запятую в формате <зона_доступности>-<идентификатор_хоста>.<зона_DNS> (пример: rc1a-goh2a9tr********.mdb.yandexcloud.net).

   После выполнения команды введите пароль пользователя для завершения процедуры подключения.

2. Для проверки успешности подключения выполните запрос:

   SELECT version();
   

1. Установите переменные окружения для подключения:

   $Env:PGSSLMODE="verify-full"; $Env:PGTARGETSESSIONATTRS="read-write"
   

2. Подключитесь к базе данных:

   & "C:\Program Files\PostgreSQL\<версия>\bin\psql.exe" `
     --host=<список_хостов> `
     --port=6432 `
     --username<имя_пользователя> `
     <имя_БД>
   

   В параметре host указываются хосты кластера через запятую в формате <зона_доступности>-<идентификатор_хоста>.<зона_DNS> (пример: rc1a-goh2a9tr********.mdb.yandexcloud.net).

   После выполнения команды введите пароль пользователя для завершения процедуры подключения.

3. Для проверки успешности подключения выполните запрос:

   SELECT version();
   

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

1. Назначьте роль аккаунту пользователя, который будет подключаться к БД:

   • Пользователю с аккаунтом на Яндексе или локальному пользователю:

     yc managed-postgresql cluster add-access-binding \
        --id <идентификатор_кластера> \
        --role managed-postgresql.clusters.connector \
        --user-account-id <идентификатор_пользователя>
     

   • Федеративному пользователю:

     yc managed-postgresql cluster add-access-binding \
        --id <идентификатор_кластера> \
        --role managed-postgresql.clusters.connector \
        --subject federatedUser:<идентификатор_пользователя>
     

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

2. Создайте пользователя PostgreSQL:

   yc managed-postgresql user create <идентификатор_пользователя> \
     --cluster-id <идентификатор_кластера> \
     --auth-method auth-method-iam \
     --permissions <имя_БД>
   

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Назначьте роль аккаунту пользователя, который будет подключаться к БД:

   1. Воспользуйтесь методом Cluster.UpdateAccessBindings и выполните запрос, например с помощью cURL:

      • Для пользователя с аккаунтом на Яндексе или локального пользователя:

        curl \
          --request PATCH \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --header "Content-Type: application/json" \
          --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>:updateAccessBindings' \
          --data '{
                    "accessBindingDeltas": [
                      { 
                        "action": "ADD",
                        "accessBinding": {
                          "roleId": "managed-postgresql.clusters.connector",
                          "subject": {
                            "id": "<идентификатор_пользователя>",
                            "type": "userAccount"
                          }
                        }
                      }
                    ]
                  }'
        

      • Для федеративного пользователя:

        curl \
          --request PATCH \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --header "Content-Type: application/json" \
          --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>:updateAccessBindings' \
          --data '{
                    "accessBindingDeltas": [
                      { 
                        "action": "ADD",
                        "accessBinding": {
                          "roleId": "managed-postgresql.clusters.connector",
                          "subject": {
                            "id": "<идентификатор_пользователя>",
                            "type": "federatedUser"
                          }
                        }
                      }
                    ]
                  }'
        

      Идентификатор кластера можно запросить со списком кластеров в каталоге.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

3. Создайте пользователя PostgreSQL:

   1. Воспользуйтесь методом User.Create и выполните запрос, например с помощью cURL:

      curl \
        --request POST \
        --header "Authorization: Bearer $IAM_TOKEN" \
        --header "Content-Type: application/json" \
        --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>/users' \
        --data '{
                  "userSpec": {
                    "name": "<идентификатор_пользователя>",
                    "permissions": [
                      {
                        "databaseName": "<имя_БД>"
                      }
                    ],
                    "authMethod": "AUTH_METHOD_IAM"
                  }
                }'
      

      Идентификатор кластера можно запросить со списком кластеров в каталоге.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Назначьте роль аккаунту пользователя, который будет подключаться к БД:

   1. Воспользуйтесь вызовом ClusterService.UpdateAccessBindings и выполните запрос, например с помощью gRPCurl:

      • Для пользователя с аккаунтом на Яндексе или локального пользователя:

        grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "resource_id": "<идентификатор_кластера>",
                "access_binding_deltas": [
                   { 
                    "action": "ADD",
                    "access_binding": {
                        "role_id": "managed-postgresql.clusters.connector",
                        "subject": {
                            "id": "<идентификатор_пользователя>",
                            "type": "userAccount"
                        }
                    }
                   }
                ]
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.postgresql.v1.ClusterService.UpdateAccessBindings
        

      • Для федеративного пользователя:

        grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "resource_id": "<идентификатор_кластера>",
                "access_binding_deltas": [
                   { 
                    "action": "ADD",
                    "access_binding": {
                        "role_id": "managed-postgresql.clusters.connector",
                        "subject": {
                            "id": "<идентификатор_пользователя>",
                            "type": "federatedUser"
                        }
                    }
                   }
                ]
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.postgresql.v1.ClusterService.UpdateAccessBindings
        

      Идентификатор кластера можно запросить со списком кластеров в каталоге.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

4. Создайте пользователя PostgreSQL:

   1. Воспользуйтесь вызовом UserService.Create и выполните запрос, например с помощью gRPCurl:

      grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/user_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "cluster_id": "<идентификатор_кластера>",
              "user_spec": {
                "name": "<идентификатор_пользователя>",
                "permissions": [
                  {
                    "database_name": "<имя_БД>"
                  }
                ],
                "auth_method": "AUTH_METHOD_IAM"
              }
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.postgresql.v1.UserService.Create
      

      Идентификатор кластера можно запросить со списком кластеров в каталоге.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Создайте новое соединение с БД:
   1. Выберите в меню База данных пункт Новое соединение.
   2. Выберите из списка БД PostgreSQL.
   3. Нажмите кнопку Далее.
   4. Укажите параметры подключения на вкладке Главное:
      • Хост — особый FQDN хоста-мастера или обычный FQDN хоста;
      • Порт — 6432;
      • База данных — имя БД для подключения;
      • В блоке Аутентификация укажите имя и пароль пользователя БД.
   5. На вкладке SSL:
      1. Включите настройку Использовать SSL.
      2. В поле Корневой сертификат укажите путь к сохраненному файлу SSL-сертификата.
2. Нажмите кнопку Тест соединения ... для проверки подключения. При успешном подключении будут выведены статус подключения, информация о СУБД и драйвере.
3. Нажмите кнопку Готово, чтобы сохранить настройки соединения с БД.