使用 Azure 容器注册表 webhook

Azure 容器注册表可存储和管理专用 Docker 容器映像,其方式类似于 Docker Hub 存储公共 Docker 映像。 它还可托管 Helm Chart(预览版)的存储库;Helm Chart 是一种将应用程序部署到 Kubernetes 的打包格式。 可以使用 Webhook 在其中一个注册表存储库中发生特定操作时触发事件。 Webhook 可在注册表级别响应事件或者将其范围缩小到特定存储库标记。 通过异地复制注册表,可将每个 Webhook 配置为响应特定区域副本中的事件。

必须能从注册表公开访问 Webhook 的终结点。 可以配置注册表 Webhook 请求来对安全终结点进行身份验证。

有关 Webhook 请求的详细信息,请参阅 Azure 容器注册表 Webhook 架构参考

先决条件

创建 Webhook - Azure 门户

  1. 登录 Azure 门户
  2. 导航到要在其中创建 Webhook 的容器注册表。
  3. 在“服务”下,选择“Webhook” 。
  4. 在 Webhook 工具栏中选择“添加”。
  5. 使用以下信息完成“创建 webhook”窗体:
说明
Webhook 名称 想要赋予 webhook 的名称。 它只能包含字母和数字,且长度必须为 5-50 个字符。
位置 对于异地复制注册表,请指定注册表副本的 Azure 区域。
服务 URI Webhook 应向其发送 POST 通知的 URI。
自定义标头 想要随 POST 请求一起传递的标头。 它们的格式应该为:“键: 值”。
触发操作 触发 webhook 的操作。 操作包括映像推送、映像删除、Helm Chart 推送、Helm Chart 删除和映像隔离。 可选择一个或多个操作来触发 Webhook。
状态 Webhook 创建后的状态。 默认启用。
范围 Webhook 的作用域。 如果未指定,则范围为注册表中的所有事件。 可通过对存储库中的所有标记使用“存储库:标记”或“存储库:”格式,指定存储库或标记的范围。

示例 Webhook 窗体:

Screenshot that shows the ACR webhook creation U I in the Azure portal.

创建 Webhook - Azure CLI

若要使用 Azure CLI 创建 webhook,请使用 az acr webhook create 命令。 以下命令为注册表 mycontainerregistry 中的所有映像删除事件创建 Webhook:

az acr webhook create --registry mycontainerregistry --name myacrwebhook01 --actions delete --uri http://webhookuri.com

测试 webhook

Azure 门户

使用 Webhook 之前,可使用 Ping 按钮对它进行测试。 Ping 将向指定的终结点发送泛型 POST 请求并记录响应。 使用 ping 功能可帮助验证是否已正确配置 Webhook。

  1. 选择想要测试的 webhook。
  2. 在顶部工具栏中,选择“Ping”。
  3. 在“HTTP 状态”列中检查终结点的响应。

ACR webhook creation UI in the Azure portal

Azure CLI

若要使用 Azure CLI 测试 ACR webhook,请使用 az acr webhook ping 命令。

az acr webhook ping --registry mycontainerregistry --name myacrwebhook01

若要查看结果,请使用 az acr webhook list-events 命令。

az acr webhook list-events --registry mycontainerregistry08 --name myacrwebhook01

删除 webhook

Azure 门户

每个 webhook 均可通过在 Azure 门户中选择 webhook,然后选择“删除”按钮进行删除。

Azure CLI

az acr webhook delete --registry mycontainerregistry --name myacrwebhook01

后续步骤

Webhook 架构参考

有关 Azure 容器注册表发出的 JSON 事件负载的格式和属性的详细信息,请参阅 Webhook 架构参考:

Azure 容器注册表 Webhook 架构参考