Canary release of a Cloud Functions function

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. Create the canary-sa service account:

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

   Result:

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

   Save the id of the canary-sa service account and the folder where you created it (folder_id).

2. Assign the service account the editor role for the folder:

   yc resource-manager folder add-access-binding <folder_ID> \
     --role editor \
     --subject serviceAccount:<service_account_ID>
   

   Result:

   done (1s)
   

If you do not have Terraform yet, install it and configure Yandex Cloud.

1. In the configuration file, describe the service account parameters:

   resource "yandex_iam_service_account" "canary-sa" {
     name        = "canary-sa"
     folder_id   = "<folder_ID>"
   }
   
   resource "yandex_resourcemanager_folder_iam_member" "editor" {
     folder_id = "<folder_ID>"
     role      = "editor"
     member    = "serviceAccount:${yandex_iam_service_account.canary-sa id}"
   }
   

   Where:

   • name: Service account name. This is a required parameter.
   • folder_id: Folder ID. This is an optional parameter. By default, the value specified in the provider settings is used.
   • role: Role to assign.

   For more information about the yandex_iam_service_account resource parameters in Terraform, see the relevant provider documentation.

2. Make sure the configuration files are correct.

   1. In the command line, go to the directory where you created the configuration file.

   2. Run a check using this command:

      terraform plan
      

   If the configuration is specified correctly, the terminal will display information about the service account. If the configuration contains any errors, Terraform will point them out.

3. Deploy the cloud resources.

   1. If the configuration does not contain any errors, run this command:

      terraform apply
      

   2. Confirm creating the service account: type yes in the terminal and press Enter.

      The service account will then be created. You can check the new service account using the management console or this CLI command:

      yc iam service-account list
      

To create a service account, use the create REST API method for the ServiceAccount resource or the ServiceAccountService/Create gRPC API call.

To assign the editor role for a folder to a service account, use the setAccessBindings method for the ServiceAccount resource or the ServiceAccountService/SetAccessBindings gRPC API call.

To add a version tag:

1. In the configuration file, add the tags section for the yandex_function resource and specify the list of tags in tags = ["<tag_name>"] format.

   Example function description in the Terraform configuration:

   resource "yandex_function" "test-function" {
       name               = "canary-function"
       user_hash          = "canary-function"
       runtime            = "python311"
       entrypoint         = "main"
       memory             = "128"
       execution_timeout  = "10"
       service_account_id = "<service_account_ID>"
       tags               = ["my_tag"]
       content {
           zip_filename = "<path_to_ZIP_archive>"
       }
   }
   

   For more information about the yandex_function resource properties, see the provider documentation.

2. Check the configuration using this command:

   terraform validate
   

   If the configuration is correct, you will get this message:

   Success! The configuration is valid.
   

3. Run this command:

   terraform plan
   

   The terminal will display a list of resources with their parameters. No changes will be made at this step. If the configuration contains any errors, Terraform will point them out.

4. Apply the configuration changes:

   terraform apply
   

5. Confirm the changes: type yes into the terminal and press Enter.

You can check the new tags using the management console or this CLI command:

yc serverless function version list --function-name <function_name>

To add a function version tag, use the setTag REST API method for the Function resource or the FunctionService/SetTag gRPC API call.

1. Save the following specification to the spec.yaml file:

   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: <function_ID>
           tag: "${var.function.tag}"
           service_account_id: <service_account_ID>
   

2. Run this command:

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

   Where:

   • --name: API gateway name.
   • --spec: Specification file.
   • --canary-weight: Percentage of requests in the canary release.
   • --canary-variables: Variables for the canary release.

   Result:

   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
   

To create an API gateway:

1. Describe the parameters of the yandex_api_gateway resource in the configuration file:

   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: <function_ID>
                tag: "${var.function.tag}"
                service_account_id: <service_account_ID>
     EOT
   }
   

   Where:

   • name: API gateway name. The name should match the following format:

     • It must be from 2 to 63 characters long.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • canary.0.weight: Percentage of requests in the canary release.

   • canary.0.variables: Variables for the canary release.

   • spec: API gateway specification.

   For more information about the resource parameters in Terraform, see the relevant provider documentation.

2. Make sure the configuration files are correct.

   1. In the command line, go to the directory where you created the configuration file.

   2. Run a check using this command:

      terraform plan
      

   If you described the configuration correctly, the terminal will display a list of the resources being created and their parameters. If the configuration contains any errors, Terraform will point them out.

3. Deploy the cloud resources.

   1. If the configuration does not contain any errors, run this command:

      terraform apply
      

   2. Confirm creating the resources: type yes in the terminal and press Enter.

      This will create all the resources you need in the specified folder. You can check the new resources and their settings using the management console or these CLI commands:

      yc serverless api-gateway get <API_gateway_name>
      

To create an API gateway, use the create REST API method for the ApiGateway resource or the ApiGatewayService/Create gRPC API call.