Se connecter à Cloud Build

Cette page explique comment configurer Cloud Build pour stocker des artefacts créés dans un dépôt Artifact Registry.

Avant de commencer

  1. Si le dépôt cible n'existe pas dans Artifact Registry, Créer un dépôt
  2. Si Cloud Build et votre dépôt se trouvent dans des projets différents ou si vous utilisez un compte de service spécifié par l'utilisateur pour exécuter builds, accordez le rôle de rédacteur Artifact Registry au compte de service de compilation du projet avec les dépôts.

    Le compte de service Cloud Build par défaut est autorisé à effectuer les actions suivantes avec un dépôt dans le même projet Google Cloud :

    • Importer et télécharger des artefacts
    • Créer des dépôts gcr.io dans Artifact Registry

Configurer une compilation Docker

Une fois les autorisations accordées au dépôt cible, vous pouvez configurer votre build.

Pour configurer votre build :

  1. Dans votre fichier de configuration de compilation, ajoutez l'étape permettant de compiler l'image et de lui ajouter un tag.

    steps:
    - name: 'gcr.io/cloud-builders/docker'
      args: [ 'build', '-t', '${_LOCATION}-docker.pkg.dev/$PROJECT_ID/${_REPOSITORY}/${_IMAGE}', '.' ]
    images:
    - '${_LOCATION}-docker.pkg.dev/$PROJECT_ID/${_REPOSITORY}/${_IMAGE}'
    

    Cet extrait utilise des substitutions Cloud Build. Cette approche est utile si vous souhaitez utiliser le même fichier de configuration de compilation pour transférer des images vers des dépôts pour différents environnements, tels que des environnement de test, de préproduction ou de production.

    • ${_LOCATION}, ${_REPOSITORY} et ${_IMAGE} sont des substitutions définies par l'utilisateur pour l'emplacement, le nom et l'image du dépôt. Vous spécifiez les valeurs pour ces variables au moment de la compilation.
    • $PROJECT_ID est une substitution par défaut que Cloud Build résout avec l'ID du projet Google Cloud pour la compilation.

      • Si vous exécutez la commande gcloud builds submit, Cloud Build utilise l'ID de projet actif dans la session gcloud.
      • Si vous utilisez un déclencheur de compilation, Cloud Build utilise l'ID du projet sur lequel Cloud Build s'exécute.

      Vous pouvez également utiliser une substitution définie par l'utilisateur au lieu de $PROJECT_ID afin de pouvoir spécifier un ID de projet au moment de la compilation.

  2. Lorsque vous êtes prêt à exécuter la compilation, spécifiez des valeurs pour les champs ou des substitutions. Par exemple, cette commande remplace :

    • us-east1 pour l'emplacement du dépôt
    • my-repo pour le nom du dépôt
    • my-image pour le nom de l'image
    gcloud builds submit --config=cloudbuild.yaml \
      --substitutions=_LOCATION="us-east1",_REPOSITORY="my-repo",_IMAGE="my-image" .
    

Configurer un build Go

Une fois les autorisations accordées au dépôt cible, vous pouvez configurer votre build. Les instructions suivantes décrivent comment configurer votre build pour importer un module Go dans un dépôt Go.

Pour configurer votre build :

  1. Pour importer un module Go dans votre dépôt Go lors de la compilation, ajoutez les étapes suivantes à votre fichier de configuration de compilation :

    steps:
    - name: gcr.io/cloud-builders/gcloud
    args:
    - 'artifacts'
    - 'go'
    - 'upload'
    - '--project=$PROJECT_ID'
    - '--location=${_LOCATION}'
    - '--repository=${_REPOSITORY}'
    - '--module-path=${_MODULE_PATH}'
    - '--version=$TAG_NAME'
    

    Le fichier de configuration de compilation inclut Cloud Build substitutions. Cette approche est utile si vous souhaitez utiliser le même fichier de configuration de compilation pour télécharger des packages dans des dépôts différents environnements (test, préproduction ou production, par exemple).

    • ${_LOCATION}, ${_REPOSITORY} et ${_MODULE_PATH} sont des substitutions définies par l'utilisateur pour l'emplacement, le nom et le chemin d'accès au module du dépôt. Vous spécifiez les valeurs de ces variables au moment de la compilation.
    • $PROJECT_ID et $TAG_NAME sont substitutions par défaut que Cloud Build remplace par ce qui suit:

      • $PROJECT_ID est remplacé par l'ID du projet Google Cloud. pour la compilation.

        • Si vous exécutez la commande gcloud builds submit, Cloud Build utilise l'ID du projet actif dans la session gcloud.
        • Si vous utilisez un déclencheur de compilation, Cloud Build utilise l'ID du projet sur lequel Cloud Build s'exécute.

        Vous pouvez également utiliser une substitution définie par l'utilisateur au lieu de $PROJECT_ID afin de pouvoir spécifier un ID de projet au moment de la compilation.

      • $TAG_NAME est remplacé par le nom de votre balise pour respecter la convention Go consistant à utiliser des balises Git comme numéros de version.

  2. Pour installer le package à partir du dépôt Go, ajoutez les étapes suivantes à votre fichier de configuration de compilation pour :

    • Ajouter un point de terminaison régional Artifact Registry dans votre dépôt l'emplacement du fichier .netrc.
    • Exécutez l'outil d'assistance d'identification pour actualiser les jetons OAuth.
    • Exécutez la commande go run. Vous pouvez aussi le remplacer par go build pour compilez le module, go test pour exécuter des tests ou go mod tidy pour télécharger. les dépendances.

    Pour l'étape de commande go, GOPROXY est défini sur le dépôt Artifact Registry qui héberge les dépendances privées. Vous pouvez ajouter le proxy public à la liste GOPROXY séparée par une virgule si le module comporte des dépendances publiques.

    steps:
    - name: golang
      entrypoint: go
      args: ['run', 'github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0', 'add-locations', '--locations=${_LOCATION}']
      env:
      # Set GOPROXY to the public proxy to pull the credential helper tool
      - 'GOPROXY=https://proxy.golang.org'
    - name: golang
      entrypoint: go
      args: ['run', 'github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0', 'refresh']
      env:
      # Set GOPROXY to the public proxy to pull the credential helper tool
      - 'GOPROXY=https://proxy.golang.org'
    - name: golang
      entrypoint: go
      args: ['run', '.']
      env:
      - 'GOPROXY=https://${_LOCATION}-go.pkg.dev/${_PROJECT_ID}/${_REPOSITORY}'
    options:
      env:
      # Disable GO sumdb checks for private modules.
      - 'GONOSUMDB=${_MODULE_PATH}'
    
  3. Lorsque vous êtes prêt à exécuter la compilation, spécifiez des valeurs pour les champs ou des substitutions. Par exemple, cette commande remplace :

    • us-east1 pour l'emplacement du dépôt
    • my-project pour l'ID du projet
    • my-repo pour le nom du dépôt
    • example.com/greetings pour le chemin d'accès au module
    gcloud builds submit --config=cloudbuild.yaml \
      --substitutions=_LOCATION="us-east1",_PROJECT_ID="my-project",_REPOSITORY="my-repo",_MODULE_PATH="example.com/greetings" .
    

Configurer un build Java

Une fois les autorisations accordées au dépôt cible, vous pouvez configurer votre build. Les instructions suivantes décrivent la configuration de votre compilation pour importer un package Java dans un dépôt Maven.

Pour configurer votre build :

  1. Configurez l'authentification pour Maven. Ensure de spécifier le projet cible et le dépôt appropriés dans votre fichier pom.xml .

  2. Dans votre fichier de configuration de compilation Cloud Build, ajoutez l'étape permettant d'importer le package avec Maven :

    steps:
    - name: gcr.io/cloud-builders/mvn
      args: ['deploy']
    
  3. Lorsque votre fichier de configuration de compilation est prêt, démarrez la compilation avec les éléments suivants : commande:

    gcloud builds submit
    

Configurer une compilation Node.js

Une fois les autorisations accordées au dépôt cible, vous pouvez configurer votre build. Les instructions suivantes décrivent comment configurer votre build pour télécharger un package Node.js dans un dépôt npm.

Pour configurer votre build, procédez comme suit:

  1. Ajoutez votre dépôt Artifact Registry au fichier .npmrc de votre code Node.js projet. Le fichier se trouve dans le répertoire avec votre fichier package.json.

    @SCOPE:registry=https://LOCATION-npm.pkg.dev/PROJECT_ID/REPOSITORY
    //LOCATION-npm.pkg.dev/PROJECT_ID/REPOSITORY/:always-auth=true
    
    • SCOPE-NAME est le nom du champ d'application npm à associer au dépôt. L'utilisation de niveaux d'accès vous garantit de toujours publier et installer des packages à partir du dépôt approprié.
    • PROJECT_ID correspond à votre ID de projet Google Cloud.
    • LOCATION est l'emplacement régional ou multirégional du dépôt.
    • REPOSITORY est le nom du dépôt.
  2. Ajoutez un script qui actualise le fichier package.json de votre projet le jeton d'accès pour l'authentification auprès du dépôt.

    "scripts": {
     "artifactregistry-login": "npx google-artifactregistry-auth"
    }
    
  1. Dans votre fichier de configuration de compilation, ajoutez l'étape permettant d'importer le package un dépôt de clés.

    steps:
    - name: gcr.io/cloud-builders/npm
      args: ['run', 'artifactregistry-login']
    - name: gcr.io/cloud-builders/npm
      args: ['publish', '${_PACKAGE}']
    

    ${_PACKAGE} est une compilation Cloud Build. Substitution qui représente votre projet Node.js . Vous pouvez spécifier le répertoire lorsque vous exécutez la commande pour exécuter le build.

    Par exemple, la commande suivante importe le package à partir d'un répertoire nommé src:

    gcloud builds submit --config=cloudbuild.yaml \
        --substitutions=_PACKAGE="src" .
    

Configurer une compilation Python

Après avoir accordé des autorisations sur le dépôt cible, vous pouvez : configurer votre build. Les instructions suivantes décrivent comment configurer votre build pour télécharger un package Python dans un dépôt Python et l'installer à l'aide de pip.

Pour créer une application Python et l'intégrer à un conteneur, puis la transférer vers un Docker, consultez la section Créer des applications Python dans le documentation Cloud Build.

Pour configurer votre build :

  1. Dans le répertoire contenant votre fichier de configuration de compilation Cloud Build, créez un fichier nommé requirements.txt avec les dépendances suivantes :

    twine
    keyrings.google-artifactregistry-auth
    
    • Twine : en important des packages dans Artifact Registry.
    • keyrings.google-artifactregistry-auth est le backend du trousseau Artifact Registry qui gère l'authentification avec Artifact Registry pour pip et Twine.
  2. Pour importer un package Python dans votre dépôt Python lors de la compilation, ajoutez les étapes suivantes à votre fichier de configuration de compilation :

    steps:
    - name: python
      entrypoint: pip
      args: ["install", "-r", "requirements.txt", "--user"]
    - name: python
      entrypoint: python
      args:
      - '-m'
      - 'twine'
      - 'upload'
      - '--repository-url'
      - 'https://${_LOCATION}-python.pkg.dev/$PROJECT_ID/${_REPOSITORY}/'
      - 'dist/*'
    

    Dans cet extrait, la première étape installe Twine et Artifact Registry du backend de trousseaux. La deuxième importe les fichiers Python créés dans le fichier Sous-répertoire dist. Ajustez les chemins d'accès à requirements.txt et à votre construit les fichiers Python s'ils ne correspondent pas à l'extrait.

    Le chemin d'accès au dépôt inclut des substitutions Cloud Build. Cette approche est utile si vous souhaitez utiliser le même fichier de configuration de compilation pour télécharger des packages dans des dépôts différents environnements (test, préproduction ou production, par exemple).

    • ${_LOCATION} et ${_REPOSITORY} sont des substitutions définies par l'utilisateur pour l'emplacement du dépôt, le nom du dépôt et le nom du package. Vous spécifiez les valeurs de ces variables au moment de la compilation.
    • $PROJECT_ID est une substitution par défaut que Cloud Build résout avec l'ID de projet Google Cloud pour la compilation.

      • Si vous exécutez la commande gcloud builds submit, Cloud Build utilise l'ID de projet actif dans la session gcloud.
      • Si vous utilisez un déclencheur de compilation, Cloud Build utilise l'ID du projet sur lequel Cloud Build s'exécute.

      Vous pouvez également utiliser une substitution définie par l'utilisateur au lieu de $PROJECT_ID afin de spécifier un ID de projet au moment de la compilation.

  3. Pour installer le package à partir du dépôt Python, ajoutez une étape à votre compilation fichier de configuration qui exécute la commande pip install.

      steps:
      - name: python
        entrypoint: pip
        args:
        - 'install'
        - '--index-url'
        - 'https://${_LOCATION}-python.pkg.dev/$PROJECT_ID/${_REPOSITORY}/simple/'
        - '${_PACKAGE}'
        - '--verbose'
    

    Cet extrait inclut une substitution ${_PACKAGE} supplémentaire pour le paramètre nom du package.

  4. Lorsque vous êtes prêt à exécuter la compilation, spécifiez des valeurs pour les champs ou des substitutions. Par exemple, cette commande remplace :

    • us-east1 pour l'emplacement du dépôt
    • my-repo pour le nom du dépôt
    • my-package pour le nom du package
    gcloud builds submit --config=cloudbuild.yaml \
      --substitutions=_LOCATION="us-east1",_REPOSITORY="my-repo",_PACKAGE="my-package" .