Creating a trigger for Container Registry that sends messages to WebSocket connections
Create a trigger for Container Registry to send messages to WebSocket connections when you create or delete Container Registry Docker images or Docker image tags.
Getting started
To create a trigger, you will need:
-
API gateway. Messages will be sent to WebSocket connections accessing the API gateway at the path specified in the trigger settings. If you do not have an API gateway, create one.
Note
The trigger does not call the API gateway when sending messages to WebSocket connections.
-
Service account with the
api-gateway.websocketBroadcasterrole. If you do not have a service account, create one.
- Registry whose Docker image events will fire the trigger. If you do not have a registry, create one.
Creating a trigger
Note
The trigger is initiated within 5 minutes of being created.
-
In the management console, select the folder where you want to create a trigger.
-
Open API Gateway.
-
In the left-hand panel, select Triggers.
-
Click Create trigger.
-
Under Basic settings:
- Enter a name and description for the trigger.
- In the Type field, select
Container Registry. - In the Launched resource field, select
API gateway.
-
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 the events that will fire the trigger.
- (Optional) In the Docker image name field, enter an image name for filtering. To find out the Docker image name, get a list of Docker images in the registry.
- (Optional) In the Docker image tag field, enter the image tag for filtering.
-
Under Batch message settings, specify:
- Event batch size. The values may range from 1 to 1,000. The default value is 1.
- Maximum wait time. The values may range from 1 to 60 seconds. The default value is 1 second.
The trigger groups events for a period not exceeding the specified wait time and sends them to WebSocket connections. The number of events cannot exceed the specified batch size.
-
Under API gateway settings:
- In the API gateway field, select the API gateway.
- In the Path field, specify the path in the OpenAPI specification. Messages will be sent through WebSocket connections established using this path.
- In the Service account field, select the service account to send messages to WebSocket connections.
-
Click Create trigger.
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.
To create a trigger that sends messages to WebSocket connections, 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 <group_size> \
--batch-cutoff <maximum_timeout> \
--gateway-id <API_gateway_ID> \
--gateway-websocket-broadcast-path <path> \
--gateway-websocket-broadcast-service-account-id <service_account_ID>
Where:
--name: Trigger name.--registry-id: Registry ID.--events: Events activating the trigger.
--batch-size: Event batch size. This is an optional parameter. The values may range from 1 to 1,000. The default value is 1.--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 events for a period not exceedingbatch-cutoffand sends them to WebSocket connections. The number of events cannot exceedbatch-size.
--gateway-id: API gateway ID.--gateway-websocket-broadcast-path: Path in the OpenAPI specification. Messages will be sent through WebSocket connections established using this path.--gateway-websocket-broadcast-account-id: Service account ID with permissions to send messages to WebSocket connections.
Result:
id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2023-08-04T15:19:15.353909857Z"
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: crtlds4tdfg12kil77h2********
batch_settings:
size: "3"
cutoff: 20s
gateway_websocket_broadcast:
gateway_id: d4eofc7n0mh2********
path: /
service_account_id: aje3932acdh2********
status: ACTIVE
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 operates correctly. Do it by viewing the API gateway logs that present information about its incoming requests.