CR supports sending message notifications, helping you promptly receive information about successful image pushes. This topic describes how to create a notification rule for image push events.

Background

CR supports sending notifications for image push events in specified instances, namespaces, or OCI artifact repositories. For example, if the effective scope of a rule is all Nginx image tags within namespace A, notifications will be sent when a new or updated image or Chart version is pushed to that Nginx OCI repository via CR.

Prerequisites

You have created a Standard Edition instance. For instructions, see Creating Standard instances.

Considerations

A maximum of 20 notification rules can be enabled. Any new rules created beyond this limit will be in a disabled state. To enable a new rule, first disable or delete an existing one.

A notification rule takes effect only after it is created and enabled. The following methods are supported for enabling notification rules.

During creation: Select Notification rules > Rule state > Enable.

After creation: On the notification rules list page, click Enable in the Actions column of the target rule to enable the rule.

Operating Steps

Log in to the Container Registry console.

Select the target region in the top navigation bar.

In the left navigation bar, click Event notification.

On the Event notification page, click Create notification rule.

Configure the notification rule parameters.

Basic information

Parameter
Description
Trigger action
Select the event that triggers the notification. In this scenario, select Push image.
Name
The custom name of the notification rule.

Effective scope

Parameter	Description
Effective level	The level at which the rule is applied. Options: Instance, Namespace, and OCI artifact repository. Instance: The notification rule applies to all namespaces and OCI artifact repositories under the selected instance. Namespace: The notification rule applies to all OCI artifact repositories within the selected namespace. OCI artifact repository: The notification rule applies to the selected OCI repository(ies).
Instance	Select the instance to which the notification rule applies.
Namespace	Select the namespace to which the notification rule applies.
OCI artifact repository	Select the OCI artifact repository to which the notification rule applies. Multiple OCI artifact repositories can be selected.
Artifact repository type	Select the type of artifact to which the rule applies. Current options: Image, Chart, and All.
Version	Select the image or Chart version to which the notification rule applies. Options: All and Regular expression matching. For examples of common version filtering regular expressions, see Regular expression matching examples.

Notification rules

Parameter	Description
Rule state	Specifies whether the notification rule is enabled or disabled. A maximum of 20 notification rules can be enabled. Any new rules created beyond this limit will be in a disabled state. To enable a new rule, first disable or delete an existing one.
Notification method	Currently, only HTTP(s) is supported.
Target URL	The URL that is invoked when the event is triggered. The notification payload is sent to this URL. For example, a webhook URL.
Custom Header	Supports defining custom Header for the request sent to the target URL based on your service.

After the configuration is complete, click Confirm.

Message example

After a successful push, you will receive a Hook message notification. An example message and parameter descriptions are provided below.

Parameter			Description
id			The ID of the push notification message.
source			The source of the pushed message. Fixed value is cr, which indicates CR product.
type			The event that triggers the notification. cr:Image:Pushed indicates an image push event.
specversion			The message notification version. This is a fixed parameter and requires no special attention.
time			The time when the notification is sent.
volcaccountid			The ID of the Volcano Engine root user who creates the message notification.
volcregion			The Volcano Engine region from which the notification is sent.
data	image	The address of the image.
		registry	The name of the instance where the image resides.
		namespace	The namespace where the image resides.
		repository	Name of the OCI artifact.
		tag	The image tag.
		digest	The identifier of the image content.
		operator	The Volcano Engine root user who creates the message notification.
		type	The type of pushed OCI artifact. image: Image. chart : Helm Chart.

Parameter	Description
Trigger action	Select the event that triggers the notification. In this scenario, select Push image.
Name	The custom name of the notification rule.

Container Registry