Изменение кластера Sharded PostgreSQL

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

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

Создайте файл body.json и добавьте в него следующее содержимое:

{
  "updateMask": "<список_изменяемых_параметров>",
  "name": "<имя_кластера>",
  "description": "<описание>",
  "environment": "<окружение>",
  "securityGroupIds": [
    "<идентификатор_группы_безопасности_1>",
    "<идентификатор_группы_безопасности_2>",
    ...
    "<идентификатор_группы_безопасности_N>"
  ],
  "deletionProtection": <защитить_кластер_от_удаления>,
  "configSpec": {
    "spqrSpec": {
      "router": {
        "config": {
          "showNoticeMessages": <показывать_информационные_уведомления>,
          "timeQuantiles": [
            <список_квантилей_времени_для_отображения_статистики>
          ],
          "defaultRouteBehavior": "<разрешать_мультишардовые_запросы>",
          "preferSameAvailabilityZone": <приоритет_маршрутизации_в_зону_доступности_роутера>
        },
        "resources": {
          "resourcePresetId": "<класс_хостов_роутера>",
          "diskSize": "<размер_хранилища_в_байтах>",
          "diskTypeId": "<тип_диска>"
        }
      },
      "coordinator": {
        "resources": {
          "resourcePresetId": "<класс_хостов_координатора>",
          "diskSize": "<размер_хранилища_в_байтах>",
          "diskTypeId": "<тип_диска>"
        }
      },
      "infra": {
        "resources": {
          "resourcePresetId": "класс_хостов_INFRA",
          "diskSize": "<размер_хранилища_в_байтах>",
          "diskTypeId": "<тип_диска>"
        },
        "router": {
          "showNoticeMessages": <показывать_информационные_уведомления>,
          "timeQuantiles": [
            <список_квантилей_времени_для_отображения_статистики>
          ],
          "defaultRouteBehavior": "<разрешать_мультишардовые_запросы>",
          "preferSameAvailabilityZone": <приоритет_маршрутизации_в_зону_доступности_роутера>
        }
      },
      "consolePassword": "<пароль_консоли_Sharded_PostgreSQL>",
      "logLevel": "<уровень_логирования>"
    },
    "backupWindowStart": {
      "hours": "<часы>",
      "minutes": "<минуты>",
      "seconds": "<секунды>",
      "nanos": "<наносекунды>"
    },
    "backupRetainPeriodDays": "<количество_дней>",
    "maintenanceWindow": {
      "weeklyMaintenanceWindow": {
        "day": "<день_недели>",
        "hour": "<час_дня>"
      }
    }
  }
}

Где:

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

  Важно

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

• name — имя кластера.

• securityGroupIds — идентификаторы групп безопасности.

  Важно

  Чтобы роутер мог подключаться к хостам шарда, кластер Managed Service for Sharded PostgreSQL и шарды должны находиться в одной группе безопасности, разрешающей входящие и исходящие TCP-подключения на порт 6432.

• deletionProtection — защита кластера от удаления: true или false.

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

• configSpec — настройки кластера:

  • spqrSpec — настройки сервиса Sharded PostgreSQL:

    • router — при расширенном шардировании задайте настройки роутера:

      • config — конфигурация роутера:

        • showNoticeMessages — показывать информационные уведомления: true или false.
        • timeQuantiles — массив строк временных квантилей для отображения статистики. По умолчанию используются значения "0.5", "0.75", "0.9", "0.95", "0.99", "0.999", "0.9999".
        • defaultRouteBehavior — политика выполнения мультишардовых запросов роутером. Возможные значения: BLOCK — блокировать, ALLOW — разрешать.
        • preferSameAvailabilityZone — включить приоритет маршрутизации запросов на чтение в зону доступности роутера: true или false.

      • resources — параметры ресурсов хостов ROUTER:

        • resourcePresetId — класс хостов;
        • diskSize — размер диска в байтах;
        • diskTypeId — тип диска.

      • coordinator – при расширенном шардировании задайте настройки координатора:

        • resources — параметры ресурсов:
          • resourcePresetId — класс хостов;
          • diskSize — размер диска в байтах;
          • diskTypeId — тип диска.

      • infra – при стандартном шардировании задайте настройки хостов INFRA:

        • resources — параметры ресурсов:

          • resourcePresetId — класс хостов;
          • diskSize — размер диска в байтах;
          • diskTypeId — тип диска.

        • router — конфигурация роутера:

          • showNoticeMessages — показывать информационные уведомления: true или false.
          • timeQuantiles — массив строк временных квантилей для отображения статистики. По умолчанию используются значения "0.5", "0.75", "0.9", "0.95", "0.99", "0.999", "0.9999".
          • defaultRouteBehavior — политика выполнения мультишардовых запросов роутером. Возможные значения: BLOCK — блокировать, ALLOW — разрешать.
          • preferSameAvailabilityZone — включить приоритет маршрутизации запросов на чтение в зону доступности роутера: true или false.

      • consolePassword — пароль консоли Sharded PostgreSQL.

      • logLevel — уровень логирования запросов: DEBUG, INFO, WARNING, ERROR, FATAL, PANIC.

  • backupWindowStart — настройки окна резервного копирования.

    В параметре укажите время, когда начинать резервное копирование. Возможные значения параметров:

    • hours — от 0 до 23 часов;
    • minutes — от 0 до 59 минут;
    • seconds — от 0 до 59 секунд;
    • nanos — от 0 до 999999999 наносекунд.

  • backupRetainPeriodDays — сколько дней хранить резервную копию кластера. Возможные значения: от 7 до 60 дней.

• maintenanceWindow — настройки расписания окна технического обслуживания:

  • day — день недели в формате DDD, когда должно проходить обслуживание.
  • hour — час дня в формате HH, когда должно проходить обслуживание. Допустимые значения: от 1 до 24.

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

curl \
  --request PATCH \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --header "Content-Type: application/json" \
  --url 'https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters/<идентификатор_кластера>' \
  --data "@body.json"

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

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

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

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

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

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

Создайте файл body.json и добавьте в него следующее содержимое:

{
  "update_mask": {
    "paths": [
      <список_изменяемых_параметров>
    ]
  },
  "name": "<имя_кластера>",
  "description": "<описание>",
  "security_group_ids": [
    "<идентификатор_группы_безопасности_1>",
    "<идентификатор_группы_безопасности_2>",
    ...
    "<идентификатор_группы_безопасности_N>"
  ],
  "deletion_protection": <защитить_кластер_от_удаления>,
  "config_spec": {
    "spqr_spec": {
      "router": {
        "config": {
          "show_notice_messages": {
            "value": <показывать_информационные_уведомления>
          },
          "time_quantiles": [
            <список_квантилей_времени_для_отображения_статистики>
          ],
          "default_route_behavior": "<разрешать_мультишардовые_запросы>",
          "prefer_same_availability_zone": {
            "value": <приоритет_маршрутизации_в_зону_доступности_роутера>
          }
        },
        "resources": {
          "resource_preset_id": "<класс_хостов_роутера>",
          "disk_size": "<размер_хранилища_в_байтах>",
          "disk_type_id": "<тип_диска>"
        }
      },
      "coordinator": {
        "resources": {
          "resource_preset_id": "<класс_хостов_координатора>",
          "disk_size": "<размер_хранилища_в_байтах>",
          "disk_type_id": "<тип_диска>"
        }
      },
      "infra": {
        "resources": {
          "resource_preset_id": "класс_хостов_INFRA",
          "disk_size": "<размер_хранилища_в_байтах>",
          "disk_type_id": "<тип_диска>"
        },
        "router": {
          "show_notice_messages": {
            "value": <показывать_информационные_уведомления>
          },
          "time_quantiles": [
            <список_квантилей_времени_для_отображения_статистики>
          ],
          "default_route_behavior": "<разрешать_мультишардовые_запросы>",
          "prefer_same_availability_zone": {
            "value": <приоритет_маршрутизации_в_зону_доступности_роутера>
          }
        }
      },
      "console_password": "<пароль_консоли_Sharded_PostgreSQL>",
      "log_level": "<уровень_логирования>"
    },
    "backup_window_start": {
      "hours": "<часы>",
      "minutes": "<минуты>",
      "seconds": "<секунды>",
      "nanos": "<наносекунды>"
    },
    "backup_retain_period_days": "<количество_дней>"
  },
  "maintenance_window": {
    "weekly_maintenance_window": {
      "day": "<день_недели>",
      "hour": "<час_дня>"
    }
  }
}

Где:

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

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

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

  Важно

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

• name — имя кластера.

• security_group_ids — идентификаторы групп безопасности.

  Важно

  Чтобы роутер мог подключаться к хостам шарда, кластер Managed Service for Sharded PostgreSQL и шарды должны находиться в одной группе безопасности, разрешающей входящие и исходящие TCP-подключения на порт 6432.

• deletion_protection — защита кластера от удаления: true или false.

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

• config_spec — настройки кластера:

  • spqr_spec — настройки сервиса Sharded PostgreSQL:

    • router — при расширенном шардировании задайте настройки роутера:

      • config — конфигурация роутера:

        • show_notice_messages — показывать информационные уведомления: true или false.
        • time_quantiles — массив временных квантилей для отображения статистики. По умолчанию используются значения 0.5, 0.75, 0.9, 0.95, 0.99, 0.999, 0.9999.
        • default_route_behavior — политика выполнения мультишардовых запросов роутером. Возможные значения: BLOCK — блокировать, ALLOW — разрешать.
        • prefer_same_availability_zone — включить приоритет маршрутизации запросов на чтение в зону доступности роутера: true или false.

      • resources — параметры ресурсов хостов ROUTER:

        • resource_preset_id — класс хостов;
        • disk_size — размер диска в байтах;
        • disk_type_id — тип диска.

      • coordinator – при расширенном шардировании задайте настройки координатора:

        • resources — параметры ресурсов:
          • resource_preset_id — класс хостов;
          • disk_size — размер диска в байтах;
          • disk_type_id — тип диска.

      • infra – при стандартном шардировании задайте настройки хостов INFRA:

        • resources — параметры ресурсов:

          • resource_preset_id — класс хостов;
          • disk_size — размер диска в байтах;
          • disk_type_id — тип диска.

        • router — конфигурация роутера:

          • show_notice_messages — показывать информационные уведомления: true или false.
          • time_quantiles — массив временных квантилей для отображения статистики. По умолчанию используются значения 0.5, 0.75, 0.9, 0.95, 0.99, 0.999, 0.9999.
          • default_route_behavior — политика выполнения мультишардовых запросов роутером. Возможные значения: BLOCK — блокировать, ALLOW — разрешать.
          • prefer_same_availability_zone — включить приоритет маршрутизации запросов на чтение в зону доступности роутера: true или false.

      • console_password — пароль консоли Sharded PostgreSQL.

      • log_level — уровень логирования запросов: DEBUG, INFO, WARNING, ERROR, FATAL, PANIC.

  • backup_window_start — настройки окна резервного копирования.

    В параметре укажите время, когда начинать резервное копирование. Возможные значения параметров:

    • hours — от 0 до 23 часов;
    • minutes — от 0 до 59 минут;
    • seconds — от 0 до 59 секунд;
    • nanos — от 0 до 999999999 наносекунд.

  • backup_retain_period_days — сколько дней хранить резервную копию кластера. Возможные значения: от 7 до 60 дней.

• maintenance_window — настройки расписания окна технического обслуживания:

  • day — день недели в формате DDD, когда должно проходить обслуживание.
  • hour — час дня в формате HH, когда должно проходить обслуживание. Допустимые значения: от 1 до 24.

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

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/spqr/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d @ \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.spqr.v1.ClusterService.Update \
  < body.json

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