Канареечный релиз функции Cloud Functions

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

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

1. Создайте сервисный аккаунт canary-sa:

   yc iam service-account create --name canary-sa
   

   Результат:

   id: nfersamh4sjq********
   folder_id: b1gc1t4cb638********
   created_at: "2023-09-21T10:36:29.726397755Z"
   name: canary-sa
   

   Сохраните идентификатор сервисного аккаунта canary-sa (id) и каталога, в котором его создали (folder_id).

2. Назначьте сервисному аккаунту роль editor на каталог:

   yc resource-manager folder add-access-binding <идентификатор_каталога> \
     --role editor \
     --subject serviceAccount:<идентификатор_сервисного_аккаунта>
   

   Результат:

   done (1s)
   

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

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

   resource "yandex_iam_service_account" "canary-sa" {
     name        = "canary-sa"
     folder_id   = "<идентификатор_каталога>"
   }
   
   resource "yandex_resourcemanager_folder_iam_member" "editor" {
     folder_id = "<идентификатор_каталога>"
     role      = "editor"
     member    = "serviceAccount:${yandex_iam_service_account.canary-sa id}"
   }
   

   Где:

   • name — имя сервисного аккаунта. Обязательный параметр.
   • folder_id — идентификатор каталога. Необязательный параметр. По умолчанию будет использовано значение, указанное в настройках провайдера.
   • role — назначаемая роль.

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

2. Проверьте корректность конфигурационных файлов.

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

   2. Выполните проверку с помощью команды:

      terraform plan
      

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

3. Разверните облачные ресурсы.

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

      terraform apply
      

   2. Подтвердите создание сервисного аккаунта: введите в терминал слово yes и нажмите Enter.

      После этого будет создан сервисный аккаунт. Проверить появление сервисного аккаунта можно в консоли управления или с помощью команды CLI:

      yc iam service-account list
      

Чтобы создать сервисный аккаунт, воспользуйтесь методом create для ресурса ServiceAccount или вызовом gRPC API ServiceAccountService/Create.

Чтобы назначить сервисному аккаунту роль editor на каталог, воспользуйтесь методом setAccessBindings для ресурса ServiceAccount или вызовом gRPC API ServiceAccountService/SetAccessBindings.

Чтобы добавить тег версии:

1. В конфигурационном файле добавьте блок tags для ресурса yandex_function и укажите список тегов формате tags = ["<имя_тега>"].

   Пример описания функции в конфигурации Terraform:

   resource "yandex_function" "test-function" {
       name               = "canary-function"
       user_hash          = "canary-function"
       runtime            = "python311"
       entrypoint         = "main"
       memory             = "128"
       execution_timeout  = "10"
       service_account_id = "<идентификатор_сервисного_аккаунта>"
       tags               = ["my_tag"]
       content {
           zip_filename = "<путь_к_ZIP-архиву>"
       }
   }
   

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

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

   terraform validate
   

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

   Success! The configuration is valid.
   

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

   terraform plan
   

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

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

   terraform apply
   

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

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

yc serverless function version list --function-name <имя_функции>

Чтобы добавить тег версии функции, воспользуйтесь методом REST API setTag для ресурса Function или вызовом gRPC API FunctionService/SetTag.

1. Сохраните следующую спецификацию в файл spec.yaml:

   openapi: 3.0.0
   info:
     title: Sample API
     version: 1.0.0
   
   x-yc-apigateway:
     variables:
       function.tag:
         default: "stable"
         enum:
           - "stable"
           - "canary"
   
   paths:
     /:
       get:
         x-yc-apigateway-integration:
           type: cloud_functions
           function_id: <идентификатор_функции>
           tag: "${var.function.tag}"
           service_account_id: <идентификатор_сервисного_аккаунта>
   

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

   yc serverless api-gateway create --name canary --spec=spec.yaml --canary-weight=50 --canary-variables function.tag=canary
   

   Где:

   • --name — имя API-шлюза.
   • --spec — файл со спецификацией.
   • --canary-weight — доля запросов в канареечном релизе.
   • --canary-variables — переменные для канареечного релиза.

   Результат:

   done (5s)
   id: d5d1ud9bli1e********
   folder_id: b1gc1t4cb638********
   created_at: "2023-09-25T16:01:48.926Z"
   name: canary
   status: ACTIVE
   domain: d5dm1lba80md********.i9******.apigw.yandexcloud.net
   log_group_id: ckgefpleo5eg********
   connectivity: {}
   log_options:
     folder_id: b1gc1t4cb638********
   canary:
     weight: "50"
     variables:
       function.tag:
         string_value: canary
   

Чтобы создать API-шлюз:

1. Опишите в конфигурационном файле параметры ресурса yandex_api_gateway:

   resource "yandex_api_gateway" "canary-api-gateway" {
     name        = "canary"
     canary {
       weight    = 50
       variables = {
         function.tag = "canary"
       }
     }
     spec = <<-EOT
       openapi: 3.0.0
        info:
          title: Sample API
          version: 1.0.0
   
        x-yc-apigateway:
          variables:
            function.tag:
              default: "stable"
              enum:
                - "stable"
                - "canary"
   
        paths:
          /:
            get:
              x-yc-apigateway-integration:
                type: cloud_functions
                function_id: <идентификатор_функции>
                tag: "${var.function.tag}"
                service_account_id: <идентификатор_сервисного_аккаунта>
     EOT
   }
   

   Где:

   • name — имя API-шлюза. Формат имени:

     • длина — от 2 до 63 символов;
     • может содержать строчные буквы латинского алфавита, цифры и дефисы;
     • первый символ — буква, последний — не дефис.

   • canary.0.weight — доля запросов в канареечном релизе.

   • canary.0.variables — переменные для канареечного релиза.

   • spec — спецификация API-шлюза.

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

2. Проверьте корректность конфигурационных файлов.

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

   2. Выполните проверку с помощью команды:

      terraform plan
      

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

3. Разверните облачные ресурсы.

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

      terraform apply
      

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

      После этого в указанном каталоге будут созданы все требуемые ресурсы. Проверить появление ресурсов и их настройки можно в консоли управления или с помощью команд CLI:

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

Чтобы создать API-шлюз, воспользуйтесь методом REST API create для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/Create.