Guide de démarrage rapide pour Java

Ce guide de démarrage rapide vous explique comment configurer un dépôt Maven Artifact Registry et y importer un package.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activez l'API Artifact Registry.

    Activer l'API

  5. Installez et initialisez le SDK Cloud.
  6. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  7. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  8. Activez l'API Artifact Registry.

    Activer l'API

  9. Installez et initialisez le SDK Cloud.

Créer un dépôt de packages Java

Créez le dépôt pour vos artefacts Java.

  1. Créez le dépôt :

    Console

    1. Ouvrez la page Dépôts dans Cloud Console.

      Ouvrir la page "Dépôts"

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

    3. Spécifiez quickstart-java-repo comme nom de dépôt.

    4. Choisissez le format Maven.

    5. Sous Type d'emplacement, sélectionnez Région, puis l'emplacement us-central1.

    6. Cliquez sur Create (Créer).

    Le dépôt est ajouté à la liste des dépôts.

    gcloud

    1. Exécutez la commande suivante pour créer un dépôt de packages Java dans le projet actuel nommé quickstart-java-repo, à l'emplacement us-central1.

      gcloud artifacts repositories create quickstart-java-repo --repository-format=maven \
      --location=us-central1 [--description="Java package repository"]
      
    2. Exécutez la commande suivante pour vérifier que votre dépôt a bien été créé :

      gcloud artifacts repositories list

    Exécutez la commande gcloud artifacts pour en savoir plus sur les commandes Artifact Registry.

  2. Pour simplifier les commandes gcloud, définissez le dépôt par défaut sur quickstart-java-repo et l'emplacement par défaut sur us-central1. Une fois les valeurs définies, vous n'avez pas besoin de les spécifier dans les commandes gcloud nécessitant un dépôt ou un emplacement.

    Pour définir le dépôt, exécutez la commande suivante :

    gcloud config set artifacts/repository quickstart-java-repo
    

    Pour définir l'emplacement, exécutez la commande suivante :

    gcloud config set artifacts/location us-central1
    

    Pour plus d'informations sur ces commandes, reportez-vous à la documentation gcloud config set.

Configurer un compte de service pour votre client

  1. Créez un compte de service pour agir au nom de votre application ou sélectionnez un compte de service existant que vous utilisez pour l'automatisation.

    Vous aurez besoin de l'emplacement du fichier de clé de compte de service pour configurer l'authentification avec Artifact Registry. Pour les comptes existants, vous pouvez afficher les clés et en créer sur la page "Comptes de service".

    Accéder à la page "Comptes de service"

  2. Accordez au compte de service un accès en lecture et en écriture sur votre dépôt.

    gcloud artifacts repositories add-iam-policy-binding \
    quickstart-java-repo --location=us-central1 --member=serviceAccount:ACCOUNT --role=roles/artifactregistry.writer
    

    ACCOUNT correspond à l'ID de votre compte de service au format USERNAME@PROJECT-ID.iam.gserviceaccount.com.

  3. Attribuez l'emplacement du fichier de clé du compte de service à la variable GOOGLE_APPLICATION_CREDENTIALS afin que l'assistant d'identification Artifact Registry puisse obtenir votre clé lors de la connexion aux dépôts.

    export GOOGLE_APPLICATION_CREDENTIALS=KEY-FILE
    

    KEY-FILE est le chemin d'accès au fichier de clé du compte de service.

    Pour en savoir plus sur la configuration de l'authentification par mot de passe avec le fichier de clé de compte de service, consultez la documentation authentication#auth-password.

Configurer Maven

  1. Choisissez un projet Maven simple que vous souhaitez utiliser.

    Si vous n'avez pas de projet simple disponible, vous pouvez créer le projet Maven in 5 minutes.

    Dans ce guide de démarrage rapide, nous partons du principe que votre projet simple ne contient pas de dépendances de plug-in parent ou de plug-in supplémentaires stockées dans Artifact Registry. Pour en savoir plus sur la configuration d'un projet Maven avec des dépendances dans Artifact Registry, consultez la page S'authentifier avec un assistant d'identification.

  2. Exécutez la commande suivante pour imprimer les paramètres du dépôt quickstart-java-repo par défaut.

    gcloud artifacts print-settings mvn
    

    La sortie de la commande gcloud ressemble à l'extrait suivant, où PROJECT est l'ID de votre projet.

    <distributionManagement>
      <snapshotRepository>
        <id>artifact-registry</id>
        <url>artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo</url>
      </snapshotRepository>
      <repository>
        <id>artifact-registry</id>
        <url>artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo</url>
      </repository>
    </distributionManagement>
    
    <repositories>
      <repository>
        <id>artifact-registry</id>
        <url>artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo</url>
        <releases>
          <enabled>true</enabled>
        </releases>
        <snapshots>
          <enabled>true</enabled>
        </snapshots>
      </repository>
    </repositories>
    
    <build>
      <extensions>
        <extension>
          <groupId>com.google.cloud.artifactregistry</groupId>
          <artifactId>artifactregistry-maven-wagon</artifactId>
          <version>2.1.4</version>
        </extension>
      </extensions>
    </build>
    
  3. Ajoutez les paramètres au fichier pom.xml pour votre projet Maven. La structure suivante montre le positionnement relatif de chaque élément principal. Reportez-vous à la documentation de référence POM de Maven pour plus de détails sur la structure du fichier.

    <project xmlns="http://maven.apache.org/POM/4.0.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                          http://maven.apache.org/xsd/maven-4.0.0.xsd">
    
      <!-- Build Settings -->
      <build>
        ...
        <extensions>...</extensions>
      </build>
    
      <!-- Environment Settings -->
      <repositories>...</repositories>
      <distributionManagement>...</distributionManagement>
    </project>
    

Votre projet Maven peut désormais importer des packages dans votre dépôt.

Configurer Gradle

  1. Créez un projet Gradle simple pour déployer un package vers le dépôt Artifact Registry que vous avez créé. Si vous n'avez pas de build Gradle de test, vous pouvez suivre le tutoriel de présentation de Gradle pour en créer un simple.

  2. Pour simplifier les commandes gcloud, définissez le dépôt par défaut sur quickstart-java-repo et l'emplacement par défaut sur us-central1. Une fois les valeurs définies, vous n'avez pas besoin de les spécifier dans les commandes gcloud nécessitant un dépôt ou un emplacement.

    Pour définir le dépôt, exécutez la commande suivante :

    gcloud config set artifacts/repository quickstart-java-repo
    

    Pour définir l'emplacement, exécutez la commande suivante :

    gcloud config set artifacts/location us-central1
    

    Pour plus d'informations sur ces commandes, reportez-vous à la documentation gcloud config set.

  3. Ajoutez les paramètres pour vous connecter au dépôt au fichier build.gradle. La commande suivante imprime les paramètres à ajouter pour le dépôt quickstart-java-repo par défaut.

    gcloud artifacts print-settings gradle
    

    La sortie de la commande gcloud ressemble à l'exemple suivant, où PROJECT est l'ID de votre projet.

    plugins {
      id "maven-publish"
      id "com.google.cloud.artifactregistry.gradle-plugin" version "2.1.4"
    }
    
    publishing {
      repositories {
        maven {
          url "artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo"
        }
      }
    }
    
    repositories {
      maven {
        url "artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo"
      }
    }
    
  4. Vérifiez que le fichier build.gradle inclut une section publications. La section publications est un enfant de publishing, comme illustré dans l'exemple suivant :

    publishing {
      publications {
           mavenJava(MavenPublication) {
              groupId  'maven.example.id'
              from components.java
           }
      }
      repositories {
        maven {
          url "artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo"
        }
      }
    }
    

Vous pouvez également ajouter la configuration du dépôt à vos fichiers init.gradle ou settings. Pour en savoir plus sur ces options, consultez la page Configurer l'authentification.

Importer un package dans le dépôt

Pour Maven, vous pouvez utiliser mvn deploy et mvn release pour ajouter des packages au dépôt.

Pour Gradle, exécutez la commande gradle publish pour importer un package dans le dépôt.

Afficher le package dans le dépôt

Pour vérifier que votre package a bien été ajouté au dépôt :

Console

  1. Ouvrez la page Dépôts dans Cloud Console.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, cliquez sur le dépôt quickstart-java-repo.

    La page Packages répertorie les packages du dépôt.

gcloud

Pour répertorier les packages dans le dépôt quickstart-java-repo, exécutez la commande suivante :

 gcloud artifacts packages list --repository=quickstart-java-repo

Pour afficher les versions d'un package, exécutez la commande suivante :

gcloud artifacts versions list --package=PACKAGE

PACKAGE correspond à l'ID de package.

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud :

Avant de supprimer le dépôt, assurez-vous que tous les packages que vous souhaitez conserver sont disponibles à un autre emplacement.

Pour supprimer le dépôt :

Console

  1. Ouvrez la page Dépôts dans Cloud Console.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, sélectionnez le dépôt quickstart-java-repo.

  3. Cliquez sur Supprimer.

gcloud

  1. Pour supprimer le dépôt quickstart-java-repo, exécutez la commande suivante :

    gcloud artifacts repositories delete quickstart-java-repo
    
  2. Si vous souhaitez supprimer le dépôt par défaut et les paramètres d'emplacement que vous avez définis pour la configuration gcloud active, exécutez les commandes suivantes :

    gcloud config unset artifacts/repository
    gcloud config unset artifacts/location
    

Étape suivante