Настроить канареечный релиз

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

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

Чтобы настроить канареечный релиз:

1. При необходимости внесите изменения в файл спецификации OpenAPI или подготовьте новый файл.

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

   yc serverless api-gateway update --help
   

3. Укажите в команде идентификатор или имя API-шлюза, а также параметры канареечного релиза:

   yc serverless api-gateway update \
     --id <идентификатор_API-шлюза> \
     --canary-weight <процент_запросов> \
     --canary-variables=<список_переменных>
   

   Где:

   • --canary-weight — процент запросов, которые будут обработаны канареечным релизом.
   • --canary-variables — переменные для канареечного релиза в формате ключ=значение.

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

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

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

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

Чтобы настроить канареечный релиз:

1. Откройте файл конфигурации Terraform и добавьте в него блок canary:

   resource "yandex_api_gateway" "<имя_API-шлюза>" {
   ...
   canary {
     weight    = <процент_запросов>
     variables = {
       <список_переменных>
     }
   }
   

   Где:

   • weight — процент запросов, которые будут обработаны канареечным релизом.
   • variables — переменные для канареечного релиза в формате ключ=значение.

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

2. Проверьте конфигурацию командой:

   terraform validate
   

   Если конфигурация является корректной, появится сообщение:

   Success! The configuration is valid.
   

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

   terraform plan
   

   В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

4. Примените изменения конфигурации:

   terraform apply
   

5. Подтвердите изменения: введите в терминал слово yes и нажмите Enter.

Проверить, что API-шлюз изменился, можно в консоли управления или с помощью команды CLI:

yc serverless api-gateway get <имя API-шлюза>

Чтобы настроить канареечный релиз, воспользуйтесь методом REST API update для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/Update.