Creating a trigger for Container Registry that invokes Cloud Functions
Create a trigger for Container Registry that invokes a function in Cloud Functions when you create or delete Container Registry Docker images or Docker image tags.
Getting started
To create a trigger, you will need:
-
Function the trigger will invoke. If you do not have a function:
-
Optionally, a dead-letter queue where to redirect the messages the function failed to process. If you do not have a queue, create one.
-
Service accounts with permissions to invoke the function and, optionally, write to the dead letter queue. You can use the same service account or different ones. If you do not have a service account, create one.
- Registry whose Docker image events will set off the trigger. If you do not have a registry, create one.
Creating a trigger
Note
The trigger is initiated within five minutes after it is created.
-
In the management console
, select the folder where you want to create your trigger. -
Navigate
to Cloud Functions. -
In the left-hand panel, select
Triggers. -
Click Create trigger.
-
Under Basic settings:
-
Enter a name and description for the trigger.
-
In the Labels field, click Add label and specify the labels in
key: valueformat. -
In the Type field, select
Container Registry.
-
-
Under Container Registry settings:
- In the Registry field, select the registry where you want to create a trigger for image events.
- In the Event types field, select events that will set off the trigger.
- Optionally, in the Docker image name field, enter the image name for filtering. To find out the Docker image name, get the list of Docker images in the registry.
- Optionally, in the Docker image tag field, enter the image tag for filtering.
-
Under Batch message settings, specify the following:
- Waiting time, s. The values may range from 1 to 60 seconds. The default value is 1 second.
- Batch size. The values may range from 1 to 1,000. The default value is 1.
The trigger groups events within the specified wait time and sends them to the target. The number of events cannot exceed the specified batch size.
-
Under Targets:
-
In the Target type field, select
Function. -
Under Function settings, select a function and specify:
- Function version tag.
- Service account to use for invoking the function.
-
Optionally, under Repeat request settings:
- In the Interval field, specify how long to wait before retrying the function if it fails. The values may range from 10 to 60 seconds. The default value is 10 seconds.
- In the Number of attempts field, specify the number of function retries before the trigger sends a message to the dead letter queue. The values may range from 1 to 5. The default value is 1.
-
Optionally, under Dead Letter Queue settings, select a dead-letter queue and a service account with write permissions for that queue.
-
Optionally, in the Filter field, specify a jq template to filter events sent to the target. If no filter is specified, all events are sent to the target.
-
Optionally, in the Transformation template field, specify a
jqtemplate to transform events before sending them to the target. If no template is specified, no transformations apply to the events.
-
-
Click Create trigger.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.
If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.
To create a trigger that invokes a function, run this command:
yc serverless trigger create container-registry \
--name <trigger_name> \
--registry-id <registry_ID> \
--events 'create-image', 'delete-image', 'create-image-tag', 'delete-image-tag' \
--batch-size <event_group_size> \
--batch-cutoff <maximum_timeout> \
--invoke-function-id <function_ID> \
--invoke-function-service-account-id <service_account_ID> \
--retry-attempts <number_of_retry_attempts> \
--retry-interval <interval_between_retry_attempts> \
--dlq-queue-id <dead-letter_queue_ID> \
--dlq-service-account-id <service_account_ID>
Where:
--name: Trigger name.--registry-id: Registry ID.--events: Events that set off the trigger.
--batch-size: Event batch size. This is an optional setting. The values may range from 1 to 10. The default value is 1.--batch-cutoff: Maximum wait time. This is an optional setting. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups events within thebatch-cutoffperiod and sends them to the function. The number of events cannot exceedbatch-size.
--invoke-function-id: Function ID.--invoke-function-service-account-id: ID of the service account with permissions to invoke the function.--retry-attempts: Number of invocation retries before the trigger sends a message to the dead-letter queue. This is an optional setting. The values may range from 1 to 5. The default value is 1.--retry-interval: Time to wait before retrying the function if it fails. This is an optional setting. 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 setting.--dlq-service-account-id: ID of the service account with write permissions for the dead-letter queue. This is an optional setting.
Result:
id: a1s92agr8m**********
folder_id: b1g88tflru**********
created_at: "2020-09-08T06:26:22.651656Z"
name: registry-trigger
rule:
container_registry:
event_type:
- CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE
- CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE
- CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG
- CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG
registry_id: crtlds4tdfg12kil77**********
batch_settings:
size: "3"
cutoff: 20s
invoke_function:
function_id: d4eofc7n0m**********
function_tag: $latest
service_account_id: aje3932acd**********
retry_settings:
retry_attempts: "1"
interval: 10s
dead_letter_queue:
queue-id: yrn:yc:ymq:ru-central1:aoek49ghmk**********:dlq
service-account-id: aje3932acd**********
status: ACTIVE
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the guides on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.
To create a trigger for Container Registry:
-
In the Terraform configuration file, describe the resources you want to create:
resource "yandex_serverless_triggers" "my_trigger" { name = "<trigger_name>" source { container_registry { registry_id = "<registry_ID>" image_name = "<Docker_image_name>" tag = "<Docker_image_tag>" event_type = [ "CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE", "CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE", "CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG", "CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG", ] batch_settings { max_count = "<max_number_of_events>" max_bytes = "<max_group_size_in_bytes>" cutoff = "<maximum_wait_time>" } } } action { invoke_function { function_id = "<function_ID>" service_account_id = "<service_account_ID>" } retry_policy { retry_attempts = "<number_of_retries>" interval = "<interval_between_retries>" } dead_letter { dead_letter_queue { queue_arn = "<Dead_Letter_Queue_ARN>" service_account_id = "<service_account_ID>" } } } }Where:
-
name: Trigger name. The name format is as follows:- Length: between 3 and 63 characters.
- It can only contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
description: Trigger description. This is an optional parameter. -
labels: Trigger labels inkey:valueformat. This is an optional parameter.
-
source: Event source settings:-
container_registry: Registry settings:-
registry_id: Registry ID. -
image_name: Docker image name. -
tag: Docker image tag. -
event_type: List of events to set off the trigger. Specify at least one value:CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE: Creating a new Docker image in the registry.CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE: Deleting a Docker image from the registry.CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG: Creating a new Docker image tag in the registry.CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG: Deleting a Docker image tag from the registry.
-
batch_settings: Event grouping settings. This is an optional section.cutoff: Maximum event grouping time. This is a required setting. After the specified time has passed, the trigger sends the event group, even if it is not complete.max_count: Maximum number of events per group.max_bytes: Maximum total size of events per group, in bytes.
At least one of the parameters,
max_countormax_bytes, must be greater than 0.
-
-
-
action: Target settings. You can specify this section multiple times so that the trigger calls multiple resources, including those of different types. There are limits on the maximum number of resources.-
invoke_function: Function settings:function_id: Function ID.function_tag: Function version tag. This is an optional parameter. If it is not specified, the latest version of the function is called.service_account_id: ID of the service account with permissions to invoke the function.
-
filter: Filtering events before sending them to the target. This is an optional section.jq: jq template to filter events sent to the target. It not specified, all events reach the target.
-
transformer: Transforming events before sending them to the target. This is an optional section.jq: jq template to transform events before sending them to the target. It omitted, no transformations apply to the events.
-
retry_policy: Repeated request settings. This is an optional section.interval: Time interval before a retry attempt to send the event if the current attempt fails.retry_attempts: Number of retry attempts before the trigger moves the event to the dead-letter queue.
-
dead_letter: Dead-letter queue settings. This is an optional section.-
dead_letter_queue: Queue settings:queue_arn: Queue ARN.service_account_id: ID of the service account with permissions to write to the queue.message_attributes: Attributes to add to each message in the queue, inkey:valueformat. This is an optional parameter.
-
-
For more on the properties of the
yandex_serverless_triggersresource, see this provider guide.Configuration for the yandex_function_trigger resource
resource "yandex_function_trigger" "my_trigger" { name = "<trigger_name>" function { id = "<function_ID>" service_account_id = "<service_account_ID>" retry_attempts = "<number_of_retry_attempts>" retry_interval = "<time_between_retry_attempts>" } container_registry { registry_id = "<registry_ID>" image_name = "<image_name>" tag = "<image_tag>" create_image = true delete_image = true create_image_tag = true delete_image_tag = true batch_cutoff = "<maximum_wait_time>" batch_size = "<event_batch_size>" } dlq { queue_id = "<dead-letter_queue_ID>" service_account_id = "<service_account_ID>" } }Where:
-
name: Trigger name. Follow these naming requirements:- Length: between 3 and 63 characters.
- It can only contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
description: Trigger description. -
function: Function settings:id: Function ID.service_account_id: ID of the service account with permissions to invoke the function.retry_attempts: Number of invocation retries before the trigger sends a message to the dead-letter queue. This is an optional setting. The values may range from 1 to 5. The default value is 1.retry_interval: Time to wait before retrying the function if it fails. This is an optional setting. The values may range from 10 to 60 seconds. The default value is 10 seconds.
-
container_registry: Trigger settings:-
registry_id: Registry ID. -
image_name: Docker image name. -
tag: Docker image tag. -
Events that set off the trigger:
create_image: Trigger will invoke the function when a new Docker image is created in the registry. It can either betrueorfalse.delete_image: Trigger will invoke the function when a Docker image is deleted from the registry. It can either betrueorfalse.create_image_tag: Trigger will invoke the function when a new Docker image tag is created in the registry. It can either betrueorfalse.delete_image_tag: Trigger will invoke the function when a Docker image tag is deleted from the registry. It can either betrueorfalse.
batch_cutoff: Maximum wait time. This is an optional setting. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups events within thebatch-cutoffperiod and sends them to the function. The number of events cannot exceedbatch-size.batch_size: Event batch size. This is an optional setting. The values may range from 1 to 10. The default value is 1.
-
dlq: Dead-letter queue settings:queue_id: Dead-letter queue ID.service_account_id: ID of the service account with write permissions for the dead-letter queue.
For more on the properties of the
yandex_function_triggerresource, see this provider guide. -
-
Create the resources:
-
In the terminal, navigate to the configuration file directory.
-
Make sure the configuration is correct using this command:
terraform validateIf the configuration is valid, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.
-
Apply the configuration changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
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 Container Registry, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.
Checking the result
Check that the trigger works correctly. To do this, view function logs that show information on invocations.