Créer des dépôts virtuels

Cette page explique comment créer des dépôts virtuels Artifact Registry.

Les dépôts virtuels agissent comme un point d'accès unique pour télécharger, installer ou déployer des artefacts au même format à partir d'un ou de plusieurs dépôts en amont. Un dépôt en amont peut être un dépôt standard Artifact Registry ou un dépôt distant.

Les autres modes de dépôt sont les suivants:

  • Standard: mode de dépôt par défaut. Vous importez ou publiez des artefacts tels que des packages privés directement dans des dépôts standards. Bien que vous puissiez les télécharger directement à partir de dépôts standards individuels, accéder à des groupes de dépôts avec un dépôt virtuel simplifie la configuration des outils.
  • Remote (dépôts de packages de langage uniquement): récupération du cache pour les artefacts dans des dépôts publics tels que Maven Central ou PyPI. Il agit comme un proxy pour les dépôts publics, ce qui vous permet de mieux contrôler vos dépendances externes.

Pour en savoir plus sur le fonctionnement des dépôts virtuels, consultez la page Présentation du dépôt virtuel.

Avant de commencer

Activez Artifact Registry, y compris l'activation de l'API Artifact Registry et l'installation de la dernière version de Google Cloud CLI.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les dépôts, demandez à votre administrateur de vous attribuer les rôles IAM suivants:

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Si les dépôts en amont se trouvent dans d'autres projets, un administrateur de ces projets doit être autorisé à gérer l'accès à ces dépôts.

Créer des dépôts en amont

Avant de configurer un dépôt virtuel, créez les dépôts en amont que vous souhaitez rendre disponibles avec le dépôt virtuel.

  1. Créez les dépôts en amont dans la région Google Cloud où vous prévoyez de créer le dépôt virtuel.

  2. Les dépôts virtuels utilisent l'agent de service Artifact Registry pour s'authentifier auprès des dépôts en amont. Vous devez accorder à l'agent de service un accès en lecture aux dépôts en amont.

    Vous pouvez attribuer le rôle Lecteur Artifact Registry à l'agent de service Artifact Registry au niveau du projet afin de ne pas avoir à accorder l'accès aux dépôts individuels en amont.

    Dans chaque projet comportant des dépôts en amont, exécutez la commande suivante:

    gcloud projects add-iam-policy-binding UPSTREAM_PROJECT_ID \
    --member serviceAccount:service-VIRTUAL-REPO-PROJECT_NUMBER@gcp-sa-artifactregistry.iam.gserviceaccount.com \
    --role roles/artifactregistry.reader

    Où

    • UPSTREAM_PROJECT_ID est l'ID du projet Google Cloud avec le dépôt en amont.
    • VIRTUAL_REPO_PROJECT_NUMBER est le numéro de projet du projet Google Cloud pour votre dépôt virtuel.

    Si vous souhaitez attribuer un rôle plus précis à l'agent de service, ajoutez l'autorisation artifactregistry.repositories.readViaVirtualRepository à un rôle personnalisé, puis accordez ce rôle à l'agent de service.

    Pour en savoir plus sur l'attribution d'autorisations, consultez la documentation sur le contrôle des accès.

Créer un dépôt virtuel

Lorsque vous créez un dépôt, vous devez configurer les paramètres suivants, qui ne peuvent pas être modifiés après la création du dépôt:

  • Format de l'artefact.
  • Mode Dépôt, si plusieurs modes sont disponibles pour le format sélectionné.
  • Emplacement du dépôt.
  • Chiffrement à l'aide de clés détenues et gérées par Google, ou de clés de chiffrement gérées par le client Artifact Registry utilise par défaut des clés détenues et gérées par Google.

Artifact Registry applique des contraintes liées aux règles d'administration qui nécessitent le chiffrement des ressources par CMEK ou limite les clés Cloud KMS pouvant être utilisées pour la protection CMEK.

Créer un dépôt virtuel à l'aide de la console Google Cloud

  1. Ouvrez la page Dépôts de la console Google Cloud.

    Ouvrir la page "Dépôts"

  2. Cliquez sur Créer un dépôt.

  3. Spécifiez le nom du dépôt. Pour chaque emplacement de dépôt d'un projet, les noms de dépôt doivent être uniques.

  4. Sélectionnez le format du dépôt.

  5. Sous Repository mode (Mode dépôt), sélectionnez Virtual (Virtuel).

  6. Sous Paramètres en amont du dépôt virtuel, cliquez sur Ajouter en amont pour ajouter un dépôt en amont.

    • Un dépôt en amont peut être un dépôt standard, distant ou virtuel.
    • Un dépôt en amont doit se trouver au même emplacement que le dépôt virtuel, mais peut se trouver dans un autre projet Google Cloud.
    • Un dépôt en amont doit présenter le même format d'artefact que le dépôt virtuel.

    Spécifiez une priorité et un nom de règle pour chaque dépôt en amont. Les valeurs de priorité élevée prévalent sur les valeurs inférieures. Laissez un espace entre les valeurs de priorité afin de pouvoir ajouter des dépôts en amont avec des priorités situées entre les valeurs existantes.

  7. Sous Type d'emplacement, sélectionnez l'emplacement du dépôt :

    1. Choisissez le type d'emplacement : régional ou multirégional. La liste des emplacements change pour refléter votre sélection.

    2. Dans la liste Région ou Multirégional, sélectionnez un emplacement.

    Pour en savoir plus sur les types d'emplacements et les emplacements compatibles, consultez la section Emplacements des dépôts.

  8. Ajoutez une description pour le dépôt. Les descriptions aident à identifier l'objectif du dépôt et le type d'artefacts qu'il contient.

    N'incluez pas de données sensibles, car les descriptions de dépôt ne sont pas chiffrées.

  9. Si vous souhaitez utiliser des libellés pour organiser vos dépôts, cliquez sur Add Label (Ajouter une étiquette) et saisissez la paire clé-valeur du libellé. Vous pouvez ajouter, modifier ou supprimer des étiquettes après avoir créé le dépôt.

  10. Dans la section Chiffrement, choisissez le mécanisme de chiffrement du dépôt.

    • Clé gérée par Google : chiffrez le contenu du dépôt à l'aide d'une clé détenue par Google et gérée par Google.
    • Clé gérée par le client : chiffre le contenu du dépôt à l'aide d'une clé que vous contrôlez via Cloud Key Management Service. Pour obtenir des instructions sur la configuration de la clé, consultez la page Configurer des CMEK pour les dépôts.

  11. Cliquez sur Créer.

Artifact Registry crée le dépôt et l'ajoute à la liste des dépôts.

Après avoir créé le dépôt:

Créer un dépôt virtuel à l'aide de gcloud CLI

Pour créer un dépôt virtuel, vous devez définir vos dépôts en amont dans un fichier de stratégie, puis créer le dépôt à l'aide de ce fichier.

  1. Créez un fichier de règles en amont au format JSON avec les paramètres suivants:

    [{
"id" : "POLICY_ID",
"repository" : "UPSTREAM_REPOSITORY_RESOURCE_NAME",
"priority" : PRIORITY
}, {...}]
    • POLICY_ID est le nom de la règle. Chaque dépôt en amont de la règle doit posséder un ID de règle unique.

    • UPSTREAM_REPO_RESOURCE_NAME est le nom du dépôt en amont au format suivant:

      projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY
      • Un dépôt en amont peut être un dépôt standard, distant ou virtuel.
      • Un dépôt en amont doit se trouver au même emplacement que le dépôt virtuel, mais peut se trouver dans un autre projet Google Cloud.
      • Un dépôt en amont doit présenter le même format d'artefact que le dépôt virtuel.

    • PRIORITY est un entier qui indique la priorité du dépôt en amont. Les valeurs de priorité plus élevée prévalent sur les valeurs inférieures.

    L'exemple suivant montre un fichier de stratégie nommé policies.json avec quatre dépôts en amont. upstream1 ayant la valeur la plus élevée pour priority, Artifact Registry la recherche en premier. upstream-test présente la valeur priority la plus faible. Artifact Registry effectuera donc sa recherche en dernier. upstream2 et upstream3 ont la même priorité. Si Artifact Registry trouve un package demandé dans des dépôts avec la même priorité, il peut le diffuser à partir de l'un ou l'autre des dépôts.

    [{
"id" : "upstream1",
"repository" : "projects/myproject/locations/us-west1/repositories/python-repo1",
"priority" : 100
}, {
"id" : "upstream2",
"repository" : "projects/myproject/locations/us-west1/repositories/python-repo2",
"priority" : 80
}, {
"id" : "upstream3",
"repository" : "projects/myproject/locations/us-west1/repositories/python-repo2",
"priority" : 80
}, {
"id" : "upstream-test",
"repository" : "projects/myproject/locations/us-west1/repositories/python-test-repo",
"priority" : 20
}]

    Cet exemple laisse également un espace entre les valeurs de priorité. Ces écarts permettent d'ajouter des dépôts en amont avec des priorités situées entre des valeurs existantes. Par exemple, vous pouvez ajouter un dépôt upstream-3 avec une priorité de 70 afin qu'Artifact Registry puisse le rechercher avant upstream-test.

    Envisagez de stocker votre fichier de règles en amont dans votre système de contrôle du code source afin de pouvoir le réutiliser ultérieurement pour modifier les paramètres du dépôt en amont et suivre l'historique des modifications.

  2. Dans le répertoire contenant votre fichier de règles en amont, exécutez la commande suivante pour créer le dépôt virtuel:

    gcloud artifacts repositories create VIRTUAL-REPOSITORY-NAME \
    --project=PROJECT_ID \
    --repository-format=FORMAT \
    --mode=virtual-repository \
    --location=LOCATION \
    --description="DESCRIPTION" \
    --upstream-policy-file=UPSTREAM_POLICY_FILE

    Remplacez les éléments suivants :

    • VIRTUAL-REPOSITORY-NAME est le nom du dépôt virtuel.
    • PROJECT_ID est l'ID du projet dans lequel vous créez le dépôt virtuel. Si cette option est ignorée, le projet en cours ou par défaut est utilisé.
    • FORMAT est le format du dépôt. Les valeurs suivantes sont disponibles :
      • apt (aperçu privé)
      • docker
      • maven
      • npm
      • python
      • yum (aperçu privé)

    • LOCATION est l'emplacement régional ou multirégional du dépôt. Vous pouvez ignorer cette option si vous définissez une valeur par défaut. Pour afficher la liste des emplacements acceptés, exécutez la commande suivante :

      gcloud artifacts locations list

    • DESCRIPTION est une description facultative du dépôt. N'incluez pas de données sensibles, car les descriptions de dépôt ne sont pas chiffrées.

    • UPSTREAM_POLICY_FILE est un chemin d'accès au fichier de stratégie en amont.

    Par exemple, la commande suivante crée un dépôt virtuel nommé virtual-repo pour les packages Python dans la région us-west1 avec les paramètres de policies.json.

    gcloud artifacts repositories create virtual-repo \
--repository-format=python \
--mode=virtual-repository \
--location=us-west1 \
--description="Python virtual repository" \
--upstream-policy-file=policies.json

Artifact Registry crée le dépôt virtuel.

Créer un dépôt virtuel à l'aide de Terraform

Utilisez la ressource google_artifact_registry_repository pour créer des dépôts. Veuillez utiliser terraform-provider-google version 5.0.0 ou ultérieure.

Si vous débutez avec Terraform pour Google Cloud, consultez la page Premiers pas – Google Cloud sur le site Web de HashiCorp.

L'exemple suivant définit le fournisseur, un dépôt virtuel avec le nom de ressource Terraform my-repo et un dépôt en amont avec le nom de ressource Terraform my-repo-upstream.

Docker 

provider "google" {
    project = "PROJECT-ID"
}
resource "google_artifact_registry_repository" "my-repo-upstream" {
  location      = "UPSTREAM_LOCATION"
  repository_id = "UPSTREAM_REPOSITORY_ID"
  description   = "UPSTREAM_REPOSITORY_DESCRIPTION"
  format        = "docker"
}

resource "google_artifact_registry_repository" "my-repo" {
  depends_on    = []
  location      = "LOCATION"
  repository_id = "REPOSITORY_ID"
  description   = "VIRTUAL_REPOSITORY_DESCRIPTION"
  format        = "docker"
  kms_key_name = "KEY"
  mode          = "VIRTUAL_REPOSITORY"
  virtual_repository_config {
    upstream_policies {
      id          = "UPSTREAM_REPOSITORY_ID"
      repository  = google_artifact_registry_repository.my-repo-upstream.id
      priority    = PRIORITY
    }
  }
}

Où

  • PROJECT-ID est l'ID du projet Google Cloud.
  • UPSTREAM_LOCATION est l'emplacement du dépôt en amont. Notez que le dépôt virtuel et le contenu en amont doivent se trouver dans la même région ou dans un emplacement multirégional.
  • UPSTREAM_REPOSITORY_ID est l'ID du dépôt en amont.
  • UPSTREAM_REPOSITORY_DESCRIPTION est la description facultative du dépôt en amont.
  • LOCATION est l'emplacement du dépôt virtuel.
  • REPOSITORY_ID est l'ID du dépôt virtuel.
  • DESCRIPTION correspond à la description facultative du dépôt virtuel. N'incluez pas de données sensibles, car les descriptions de dépôt ne sont pas chiffrées.
  • KEY est le nom de la clé Cloud Key Management Service si vous utilisez des clés de chiffrement gérées par le client (CMEK) pour le chiffrement. Omettez cet argument pour utiliser le paramètre par défaut, à savoir les clés détenues et gérées par Google.
  • PRIORITY correspond à la valeur de priorité facultative. La priorité la plus élevée est 1. Les entrées dont la valeur de priorité est supérieure sont prioritaires dans l'ordre d'extraction.

Maven

Si vous ne spécifiez pas de stratégie de version, Artifact Registry crée un dépôt Maven qui stocke par défaut les versions d'instantané et de version des packages.

provider "google" {
    project = "PROJECT-ID"
}
resource "google_artifact_registry_repository" "my-repo-upstream" {
  location      = "UPSTREAM_LOCATION"
  repository_id = "UPSTREAM_REPOSITORY_ID"
  description   = "UPSTREAM_REPOSITORY_DESCRIPTION"
  format        = "maven"
}

resource "google_artifact_registry_repository" "my-repo" {
  depends_on    = []
  location      = "LOCATION"
  repository_id = "REPOSITORY_ID"
  description   = "VIRTUAL_REPOSITORY_DESCRIPTION"
  format        = "maven"
  kms_key_name = "KEY"
  mode          = "VIRTUAL_REPOSITORY"
  virtual_repository_config {
    upstream_policies {
      id          = "UPSTREAM_REPOSITORY_ID"
      repository  = google_artifact_registry_repository.my-repo-upstream.id
      priority    = PRIORITY
    }
  }
}

Où

  • PROJECT-ID est l'ID du projet Google Cloud.
  • UPSTREAM_LOCATION est l'emplacement du dépôt en amont. Notez que le dépôt virtuel et le contenu en amont doivent se trouver dans la même région ou dans un emplacement multirégional.
  • UPSTREAM_REPOSITORY_ID est l'ID du dépôt en amont.
  • UPSTREAM_REPOSITORY_DESCRIPTION est la description facultative du dépôt en amont.
  • LOCATION est l'emplacement du dépôt virtuel.
  • REPOSITORY_ID est l'ID du dépôt virtuel.
  • DESCRIPTION correspond à la description facultative du dépôt virtuel. N'incluez pas de données sensibles, car les descriptions de dépôt ne sont pas chiffrées.
  • KEY est le nom de la clé Cloud Key Management Service si vous utilisez des clés de chiffrement gérées par le client (CMEK) pour le chiffrement. Omettez cet argument pour utiliser le paramètre par défaut, à savoir les clés détenues et gérées par Google.
  • PRIORITY correspond à la valeur de priorité facultative. La priorité la plus élevée est 1. Les entrées dont la valeur de priorité est supérieure sont prioritaires dans l'ordre d'extraction.

Pour stocker des versions d'instantanés et de publication dans différents dépôts, spécifiez une stratégie de version pour le dépôt à l'aide d'un bloc maven_config. Ce bloc prend en charge les paramètres suivants:

  • version_policy définit la stratégie de version avec l'une des valeurs suivantes :
    • VERSION_POLICY_UNSPECIFIED: stocker les packages d'instantanés et de versions. Il s'agit du paramètre par défaut.
    • VERSION: packages de version sur le Play Store uniquement.
    • SNAPSHOT: stocker uniquement les packages d'instantanés
  • allow_snapshot_overwrites configure un dépôt avec une règle de version SNAPSHOT pour accepter les instantanés non uniques qui écrasent les versions existantes du dépôt.

L'exemple suivant définit un dépôt Maven avec une stratégie de version de version.

provider "google" {
project = "my-project"
}

resource "google_artifact_registry_repository" "my-repo" {
provider = google-beta

location = "us-central1"
repository_id = "my-repo"
description = "Maven repository"
format = "MAVEN"
maven_config {
  version_policy = "RELEASE"
}
}

npm 

provider "google" {
    project = "PROJECT-ID"
}
resource "google_artifact_registry_repository" "my-repo-upstream" {
  location      = "UPSTREAM_LOCATION"
  repository_id = "UPSTREAM_REPOSITORY_ID"
  description   = "UPSTREAM_REPOSITORY_DESCRIPTION"
  format        = "npm"
}

resource "google_artifact_registry_repository" "my-repo" {
  depends_on    = []
  location      = "LOCATION"
  repository_id = "REPOSITORY_ID"
  description   = "VIRTUAL_REPOSITORY_DESCRIPTION"
  format        = "npm"
  kms_key_name = "KEY"
  mode          = "VIRTUAL_REPOSITORY"
  virtual_repository_config {
    upstream_policies {
      id          = "UPSTREAM_REPOSITORY_ID"
      repository  = google_artifact_registry_repository.my-repo-upstream.id
      priority    = PRIORITY
    }
  }
}

Où

  • PROJECT-ID est l'ID du projet Google Cloud.
  • UPSTREAM_LOCATION est l'emplacement du dépôt en amont. Notez que le dépôt virtuel et le contenu en amont doivent se trouver dans la même région ou dans un emplacement multirégional.
  • UPSTREAM_REPOSITORY_ID est l'ID du dépôt en amont.
  • UPSTREAM_REPOSITORY_DESCRIPTION est la description facultative du dépôt en amont.
  • LOCATION est l'emplacement du dépôt virtuel.
  • REPOSITORY_ID est l'ID du dépôt virtuel.
  • DESCRIPTION correspond à la description facultative du dépôt virtuel. N'incluez pas de données sensibles, car les descriptions de dépôt ne sont pas chiffrées.
  • KEY est le nom de la clé Cloud Key Management Service si vous utilisez des clés de chiffrement gérées par le client (CMEK) pour le chiffrement. Omettez cet argument pour utiliser le paramètre par défaut, à savoir les clés détenues et gérées par Google.
  • PRIORITY correspond à la valeur de priorité facultative. La priorité la plus élevée est 1. Les entrées dont la valeur de priorité est supérieure sont prioritaires dans l'ordre d'extraction.

Python 

provider "google" {
    project = "PROJECT-ID"
}
resource "google_artifact_registry_repository" "my-repo-upstream" {
  location      = "UPSTREAM_LOCATION"
  repository_id = "UPSTREAM_REPOSITORY_ID"
  description   = "UPSTREAM_REPOSITORY_DESCRIPTION"
  format        = "python"
}

resource "google_artifact_registry_repository" "my-repo" {
  depends_on    = []
  location      = "LOCATION"
  repository_id = "REPOSITORY_ID"
  description   = "VIRTUAL_REPOSITORY_DESCRIPTION"
  format        = "python"
  kms_key_name = "KEY"
  mode          = "VIRTUAL_REPOSITORY"
  virtual_repository_config {
    upstream_policies {
      id          = "UPSTREAM_REPOSITORY_ID"
      repository  = google_artifact_registry_repository.my-repo-upstream.id
      priority    = PRIORITY
    }
  }
}

Où

  • PROJECT-ID est l'ID du projet Google Cloud.
  • UPSTREAM_LOCATION est l'emplacement du dépôt en amont. Notez que le dépôt virtuel et le contenu en amont doivent se trouver dans la même région ou dans un emplacement multirégional.
  • UPSTREAM_REPOSITORY_ID est l'ID du dépôt en amont.
  • UPSTREAM_REPOSITORY_DESCRIPTION est la description facultative du dépôt en amont.
  • LOCATION est l'emplacement du dépôt virtuel.
  • REPOSITORY_ID est l'ID du dépôt virtuel.
  • DESCRIPTION correspond à la description facultative du dépôt virtuel. N'incluez pas de données sensibles, car les descriptions de dépôt ne sont pas chiffrées.
  • KEY est le nom de la clé Cloud Key Management Service si vous utilisez des clés de chiffrement gérées par le client (CMEK) pour le chiffrement. Omettez cet argument pour utiliser le paramètre par défaut, à savoir les clés détenues et gérées par Google.
  • PRIORITY correspond à la valeur de priorité facultative. La priorité la plus élevée est 1. Les entrées dont la valeur de priorité est supérieure sont prioritaires dans l'ordre d'extraction.

Artifact Registry crée votre dépôt. Exécutez la commande suivante pour afficher une description du dépôt:

gcloud artifacts repositories describe REPOSITORY \
    --location=LOCATION

Après avoir créé le dépôt:

Mettre à jour les dépôts en amont

Vous pouvez modifier la liste des dépôts en amont ou ajuster la priorité des dépôts en amont.

Console

  1. Ouvrez la page Dépôts de la console Google Cloud.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, sélectionnez le dépôt virtuel, puis cliquez sur Modifier le dépôt.

  3. Dans la liste En amont du dépôt virtuel, apportez les modifications requises. Vous pouvez ajouter et supprimer des dépôts, ou modifier leur priorité.

  4. Cliquez sur Enregistrer.

gcloud

  1. Apportez vos modifications dans le fichier de règles en amont. Par exemple, vous pouvez ajouter un dépôt en amont ou ajuster les paramètres de priorité.

    Si vous souhaitez supprimer tous les dépôts en amont, votre fichier de stratégie doit contenir un ensemble vide de dépôts.

    []

  2. Exécutez la commande suivante pour appliquer vos modifications au dépôt virtuel.

    gcloud artifacts repositories update REPOSITORY \
    --upstream-policy-file=UPSTREAM_POLICY_FILE

    Remplacez UPSTREAM_POLICY_FILE par le chemin d'accès au fichier de règles en amont.

    Pour en savoir plus sur cette commande, consultez la documentation de référence sur gcloudartifact dépôts update.

Modifier les descriptions du dépôt

Vous pouvez modifier la description du dépôt depuis la console Google Cloud ou la gcloud CLI.

Console

  1. Ouvrez la page Dépôts de la console Google Cloud.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, sélectionnez le dépôt et cliquez sur Modifier le dépôt.

  3. Modifiez la description du dépôt, puis cliquez sur Save (Enregistrer).

gcloud

Pour mettre à jour la description du dépôt, exécutez la commande suivante:

gcloud artifacts repositories update REPOSITORY \
    --project=PROJECT \
    --location=LOCATION \
    --description="DESCRIPTION"

Remplacez les éléments suivants :

  • REPOSITORY : nom du dépôt Si vous avez configuré un dépôt par défaut, vous pouvez ignorer cette option et utiliser le dépôt par défaut.
  • PROJECT : ID de projet Google Cloud. Si cette option est ignorée, le projet en cours ou par défaut est utilisé.
  • LOCATION: régional ou multirégional emplacement. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement default, vous pouvez omettre cet indicateur pour utiliser l'emplacement par défaut.
  • DESCRIPTION: description du dépôt.