Управление расширениями

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

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

Чтобы получить список расширений для базы данных, выполните команду:

yc managed-postgresql database get <имя_БД> \
   --cluster-name <имя_кластера>

Включенные расширения будут перечислены в списке extensions.

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

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

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

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>/databases/<имя_БД>'
   

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

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

   Список установленных расширений приведен в параметре extensions в выводе команды.

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

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

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

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

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

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/database_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "database_name": "<имя_БД>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.DatabaseService.Get
   

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

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

   Список установленных расширений приведен в параметре extensions в выводе команды.

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

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

Чтобы изменить расширения для базы данных, передайте их список в аргументе --extensions команды CLI. При этом расширения, не упомянутые в списке, будут выключены.

yc managed-postgresql database update <имя_БД> \
   --cluster-name <имя_кластера>
   --extensions <имя_расширения>=<версия>,<имя_расширения>=<версия>...

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

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

2. Добавьте к описанию соответствующей базы данных кластера один или несколько блоков extension (по одному блоку на каждое расширение):

   resource "yandex_mdb_postgresql_database" "<имя_БД>" {
     ...
     extension {
       name    = "<имя_расширения>"
       version = "<версия_расширения>"
     }
     ...
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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

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

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
     --request PATCH \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>/databases/<имя_БД>' \
     --data '{
               "updateMask": "extensions",
               "extensions": [
                 {
                   "name": "<имя_расширения>",
                   "version": "<версия_расширения>"
                 },
                 { <аналогичный_набор_настроек_для_расширения_2> },
                 { ... },
                 { <аналогичный_набор_настроек_для_расширения_N> }
               ]
             }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • extensions — массив расширений БД. Каждый объект соответствует отдельному расширению и имеет следующую структуру:

     • name — имя расширения;
     • version — версия расширения.

     Указывайте имя и версию в соответствии со списком поддерживаемых расширений и утилит PostgreSQL.

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

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

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

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

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

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

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

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

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/database_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "database_name": "<имя_БД>",
           "update_mask": {
             "paths": [
               "extensions"
             ]
           },
           "extensions": [
             {
               "name": "<имя_расширения>",
               "version": "<версия_расширения>"
             },
             { <аналогичный_набор_настроек_для_расширения_2> },
             { ... },
             { <аналогичный_набор_настроек_для_расширения_N> }
           ]
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.DatabaseService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • extensions — массив расширений БД. Один элемент массива содержит настройки для одного расширения и имеет следующую структуру:

     • name — имя расширения;
     • version — версия расширения.

     Указывайте имя и версию в соответствии со списком поддерживаемых расширений и утилит PostgreSQL.

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

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