Configurer les notifications Pub/Sub

Vous pouvez recevoir des notifications de Pub/Sub pour les modifications apportées à un dépôt Docker. Les notifications s'appliquent à toutes les images de conteneur stockées dans le dépôt, y compris aux graphiques Helm 3 empaquetés au format OCI.

Pub/Sub publie des messages concernant vos dépôts dans des ressources identifiées appelées sujets. Les applications qui s'abonnent aux sujets Pub/Sub reçoivent ces messages et des notifications lorsque l'état d'un dépôt change.

Artifact Registry publie des messages concernant les modifications suivantes :

  • Importations d'image
  • Nouveaux tags ajoutés aux images
  • Suppression d'images

Vous pouvez également configurer des rôles et des autorisations pour publier ou vous abonner à des notifications.

Pour plus d'informations sur la configuration des notifications Artifact Analysis pour les activités telles que les nouveaux résultats d'analyse des failles, consultez la documentation d'Artifact Analysis.

Présentation

Artifact Registry publie des messages concernant les modifications apportées aux dépôts dans un sujet nommé gcr.

Pour recevoir des notifications, vous devez :

  1. Créez un sujet nommé gcr dans le projet avec Artifact Registry.
  2. Créez un abonnement associé au sujet.
  3. Configurez votre application d'abonné pour recevoir des messages sur les modifications apportées au dépôt.
  4. Le cas échéant, configurez des autorisations pour contrôler l'accès à votre sujet et à votre abonnement.

Créer le sujet Artifact Registry

Pour créer le sujet gcr avec des clés de chiffrement appartenant à Google et gérées par Google :

Console

  1. Accédez à la page des sujets Pub/Sub dans la console Google Cloud.

    Accéder à la page des sujets Pub/Sub

  2. Cliquez sur Créer un sujet.

  3. Saisissez l'ID de sujet gcr.

  4. Cliquez sur Créer un sujet.

gcloud

Exécutez la commande suivante :

    gcloud pubsub topics create gcr --project=PROJECT-ID

Remplacez PROJECT-ID par votre Google Cloud ID de projet. Si vous omettez l'option --project, la commande utilise le projet actuel.

Pour en savoir plus sur la commande gcloud pubsub topics, consultez la documentation sur topics.

Pour créer le sujet gcr avec le chiffrement CMEK, consultez les instructions Pub/Sub pour chiffrer les sujets.

Une fois que vous avez créé le sujet gcr ou vérifié qu'il existe, vous pouvez créer un abonnement à ce sujet.

Créer un abonnement

Une fois que vous avez créé un sujet pour les modifications de dépôt, vous pouvez y configurer un abonnement qui utilise la diffusion push ou la diffusion pull. Nous vous recommandons d'utiliser la diffusion pull, car les systèmes CI/CD peuvent générer de nombreuses modifications des artefacts stockés, et la diffusion pull est plus efficace pour un grand volume de messages.

Pour créer un abonnement avec la distribution pull, procédez comme suit :

Console

  1. Accédez à la page des sujets Pub/Sub dans la console Google Cloud.

    Accéder à la page des sujets Pub/Sub

  2. Cliquez sur le sujet de votre projet.

  3. Cliquez sur Créer un abonnement.

  4. Entrez un nom d'abonnement :

    projects/PROJECT/subscriptions/[SUBSCRIPTION-NAME]

    Laissez le type de distribution défini sur Retrait.

  5. Cliquez sur Créer.

gcloud

Exécutez la commande suivante :

gcloud pubsub subscriptions create SUBSCRIPTION-NAME --topic=gcr

Remplacez SUBSCRIPTION-NAME par le nom de l'abonnement.

Pour en savoir plus sur la commande gcloud pubsub subscriptions, consultez la documentation sur subscriptions.

Vous êtes désormais abonné au sujet gcr. L'étape suivante consiste à configurer les autorisations pour les identités qui déclenchent des modifications dans les dépôts.

Configurer votre application d'abonné

Une fois que vous avez créé un sujet et un abonnement à ce sujet, vous pouvez configurer votre application d'abonné, l'application qui reçoit des messages sur les modifications apportées aux dépôts. Les applications d'abonnés accomplissent des tâches telles que les notifications d'événements, la journalisation système et la communication entre les applications.

Lorsqu'un utilisateur d'un dépôt transfère ou supprime une image, les étapes suivantes se produisent:

  1. Le compte de service Artifact Registry publie la modification apportée à votre sujet gcr. Le compte de service est service-PROJECT-NUMBER@gcp-sa-artifactregistry.iam.gserviceaccount.com, où PROJECT-NUMBER correspond à votre Google Cloud numéro de projet. Le compte de service Artifact Registry dispose par défaut de l'autorisation pubsub.topics.publish pour pouvoir publier les modifications apportées à votre sujet.

    Si un administrateur a révoqué les autorisations pubsub.topics.publish pour le compte de service Artifact Registry, Artifact Registry tente de publier le message en tant qu'utilisateur du dépôt. Dans ce cas, le compte de l'utilisateur du dépôt doit disposer de l'autorisation pubsub.topics.publish pour publier le message.

  2. Pub/Sub transfère le message du sujet à votre abonnement.

  3. Lorsque votre application d'abonnés envoie une requête de messages, elle extrait le nouveau message de l'abonnement.

    L'identité qui extrait les messages au nom de l'abonné doit disposer des autorisations nécessaires pour accéder à l'abonnement. Vous pouvez utiliser le rôle d'abonné Pub/Sub pour accorder cette autorisation.

Pour en savoir plus sur la configuration d'un abonnement pour recevoir des messages dans le cadre d'un abonnement avec la distribution pull, consultez la page Recevoir des messages en mode pull.

Configurer des autorisations

Vous pouvez utiliser les autorisations Pub/Sub pour contrôler l'accès à vos sujets et abonnements.

Pour en savoir plus sur les autorisations Pub/Sub et l'octroi d'accès aux sujets et aux abonnements, consultez la documentation sur le contrôle des accès Pub/Sub.

Exemples de notifications

Pub/Sub envoie les notifications sous forme de chaînes au format JSON. Consultez les exemples suivants pour savoir à quoi vous attendre lorsque vous recevez des notifications Artifact Registry de Pub/Sub.

Lorsqu'une image est stockée dans Artifact Registry, le contenu de la notification peut ressembler à ceci :

{
  "action":"INSERT",
  "digest":"us-west1-docker.pkg.dev/my-project/my-repo/hello-world@sha256:6ec128e26cd5..."
}

Lorsqu'un nouveau tag d'image est transféré vers Artifact Registry, la charge utile de notification se présente comme suit :

{
  "action":"INSERT",
  "digest":"us-west1-docker.pkg.dev/my-project/my-repo/hello-world@sha256:6ec128e26cd5...",
  "tag":"us-west1-docker.pkg.dev/my-project/my-repo/hello-world:1.1"
}

Le message identifie l'image pertinente à l'aide d'une clé digest ou tag.

Lorsqu'un tag d'image est supprimé d'Artifact Registry, le contenu de la notification peut ressembler à ceci :

{
  "action":"DELETE",
  "tag":"us-west1-docker.pkg.dev/my-project/my-repo/hello-world:1.1"
}

Le message peut contenir les valeurs DELETE ou INSERT pour la clé action.

Étape suivante