Creating a trigger for Data Streams that invokes a Serverless Containers container

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To create a trigger that invokes a container, run this command:

yc serverless trigger create yds \
  --name <trigger_name> \
  --database <database_location> \
  --stream <stream_name> \
  --batch-size <message_group_size> \
  --batch-cutoff <maximum_timeout> \
  --stream-service-account-id <service_account_ID> \
  --invoke-container-id <container_ID> \
  --invoke-container-service-account-id <service_account_ID> \
  --retry-attempts <number_of_retries> \
  --retry-interval <interval_between_retries> \
  --dlq-queue-id <dead-letter_queue_ID> \
  --dlq-service-account-id <service_account_ID>

Where:

• --name: Trigger name.

• --database: Location of the YDB DB the Data Streams stream is linked to.

  To find out where the DB is located, run the yc ydb database list command. The DB location is specified in the ENDPOINT column, in the database parameter, e.g., /ru-central1/b1gia87mbah2********/etn7hehf6gh3********.

• --stream: Stream name.

• --batch-size: Message batch size. This is an optional parameter. The values may range from 1 B to 64 KB. The default value is 1 B.

• --batch-cutoff: Maximum wait time. This is an optional parameter. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups messages for a period not exceeding batch-cutoff and sends them to a function. The total amount of the data transmitted to a container may exceed batch-size if the data is transmitted as a single message. Otherwise, the amount of data does not exceed batch-size.

• --stream-service-account-id: ID of the service account with permissions to read from the stream and write to it.

• --invoke-container-id: Container ID.
• --invoke-container-service-account-id: ID of the service account with permissions to invoke the container.
• --retry-attempts: Number of invocation retries before the trigger moves a message to the dead-letter queue. This is an optional parameter. The values may range from 1 to 5. The default value is 1.
• --retry-interval: Time to retry invoking the container if the current attempt fails. This is an optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.
• --dlq-queue-id: Dead-letter queue ID. This is an optional parameter.
• --dlq-service-account-id: ID of the service account with write permissions to the dead-letter queue. This is an optional parameter.

Result:

id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2022-10-24T14:07:04.693126923Z"
name: data-streams-trigger
rule:
  data_stream:
    database: /ru-central1/b1gia87mbah2********/etn7hehh2********
    stream: streams-name
    service_account_id: ajep8qm0kh2********
    batch_settings:
      size: "1"
      cutoff: 1s
    invoke_container:
      container_id: bba5jb38o8h2********
      service_account_id: aje03adgd2h2********
      retry_settings:
        retry_attempts: "1"
        interval: 10s
      dead_letter_queue:
        queue-id: yrn:yc:ymq:ru-central1:b1gmit33ngh2********:dlq
        service-account-id: aje3lebfemh2********
status: ACTIVE

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To create a trigger for Data Streams:

1. In the configuration file, describe the trigger parameters:

   resource "yandex_function_trigger" "my_trigger" {
     name = "<trigger_name>"
     container {
       id                 = "<container_ID>"
       service_account_id = "<service_account_ID>"
       retry_attempts     = "<number_of_retries>"
       retry_interval     = "<interval_between_retries>"
     }
     data_streams {
       stream_name        = "<stream_name>"
       database           = "<database_location>"
       service_account_id = "<service_account_ID>"
       batch_cutoff       = "<maximum_timeout>"
       batch_size         = "<message_group_size>"
     }
     dlq {
       queue_id           = "<dead-letter_queue_ID>"
       service_account_id = "<service_account_ID>"
     }
   }
   

   Where:

   • name: Trigger name. The name format is as follows:

     • The name must be from 3 to 63 characters long.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • The first character must be a letter and the last character cannot be a hyphen.

   • container: Container parameters:

     • id: Container ID.
     • service_account_id: ID of the service account with rights to invoke the container.
     • retry_attempts: Number of invocation retries before the trigger moves a message to the dead letter queue. This is an optional parameter. The values may range from 1 to 5. The default value is 1.
     • retry_intervall: Time to retry invoking the container if the current attempt fails. This is an optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.

   • data_streams: Trigger parameters:

     • stream_name: Stream name.

     • database: Location of the YDB DB the Data Streams stream is linked to.

       To find out where the DB is located, run the yc ydb database list command. The DB location is specified in the ENDPOINT column, in the database parameter, e.g., /ru-central1/b1gia87mba**********/etn7hehf6g*******.

     • service_account_id: ID of the service account with permissions to read from the stream and write to it.

     • batch_cutoff: Maximum wait time. This is an optional parameter. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups messages for a period not exceeding batch_cutoff and sends them to a container. The number of messages cannot exceed batch_size.

     • batch_size: Message batch size. This is an optional parameter. The values may range from 1 B to 64 KB. The default value is 1 B.

   • dlq: Dead-letter queue message parameters:
     • queue_id: Dead-letter queue ID. This is an optional parameter.
     • service_account_id: ID of the service account with write permissions to the dead-letter queue. This is an optional parameter.

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

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

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

   4. Apply the configuration changes:

      terraform apply
      

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

   Terraform will create all the required resources. You can check the new resources using the management console or this CLI command:

   yc serverless trigger list
   

To create a trigger for Data Streams, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.