Authentifizierung bei Artifact Registry für Maven und Gradle konfigurieren

Sie müssen sich bei Artifact Registry authentifizieren, wenn Sie eine Drittanbieteranwendung für die Verbindung mit einem Artifact Registry-Repository verwenden. In dieser Dokumentation liegt der Schwerpunkt auf der Konfiguration von Maven und Gradle.

Sie müssen die Authentifizierung für Cloud Build oder Google Cloud-Laufzeitumgebungen wie Google Kubernetes Engine und Cloud Run nicht konfigurieren. Sie sollten jedoch prüfen, ob die erforderlichen Berechtigungen konfiguriert sind. Weitere Informationen finden Sie unter Cloud Build und Bereitstellung in den Laufzeitumgebungen von Google Cloud .

Hinweise

1. Install the Google Cloud CLI, then initialize it by running the following command:

   gcloud init

   Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
2. (Optional) Konfigurieren Sie die Standardeinstellungen für gcloud-Befehle.

3. Wenn Sie die Authentifizierung mit einem Standard-Repository konfigurieren, prüfen Sie die Versionsrichtlinie, damit Sie Ihr Maven-Projekt richtig für die Arten von Java-Paketen konfigurieren können, die Sie hochladen können.

   Console

   1. Öffnen Sie in der Google Cloud -Konsole die Seite Repositories.

      Zur Seite „Repositories“

   2. Klicken Sie auf das Repository, bei dem Sie sich authentifizieren möchten.

      Im Bereich Details wird die Versionsrichtlinie angezeigt. Wenn für das Repository eine Richtlinie für Snapshot-Versionen gilt, gibt das Feld Überschreibungen von Snapshots zulassen an, ob Snapshots übereinstimmende Snapshot-Versionen im Repository überschreiben können.

   gcloud

   Führen Sie den folgenden Befehl aus, um eine Beschreibung eines Repositorys aufzurufen.

   gcloud artifacts repositories describe REPOSITORY \
         --project=PROJECT \
         --location=LOCATION
   

   Dabei gilt:

   • REPOSITORY ist die ID des Repositorys. Wenn Sie ein Standard-Artifact Registry-Repository konfiguriert haben, wird es verwendet, wenn dieses Flag im Befehl ausgelassen wird.
   • PROJECT ist die Projekt-ID. Wenn dieses Flag nicht angegeben ist, wird das aktuelle Projekt oder das Standardprojekt verwendet.
   • LOCATION ist der regionale oder multiregionale Standort für das Repository.

   Die Ausgabe des Befehls enthält unter mavenConfig Informationen zur Versionsrichtlinie. In diesem Beispiel gibt es für das Repository eine Richtlinie für Snapshot-Versionen und Snapshots können keine identischen Versionen im Repository überschreiben.

   Encryption: Google-managed key
   createTime: '2021-10-04T19:39:10.897404Z'
   format: MAVEN
   mavenConfig:
     allowSnapshotOverwrites: false
     versionPolicy: SNAPSHOT
   

   Wenn für ein Repository keine Versionsrichtlinie festgelegt ist, ist der Wert von mavenConfig {}.

Übersicht

Artifact Registry unterstützt die folgenden Authentifizierungsmethoden.

Authentifizierungshelfer verwenden

Diese Option bietet die größte Flexibilität. Wenn Sie den Helper in die Maven- oder Gradle-Konfiguration aufnehmen, sucht Artifact Registry nach Dienstkonto-Anmeldedaten in der Umgebung.

Dienstkontoschlüssel als Anmeldedaten angeben

Verwenden Sie diese Option, wenn eine Anwendung die Standardanmeldedaten für Anwendungen nicht unterstützt, jedoch die Authentifizierung mit einem Nutzernamen und Passwort unterstützt.

Dienstkontoschlüssel sind langlebige Anmeldedaten. Verwenden Sie die folgenden Richtlinien, um den Zugriff auf Ihre Repositories einzuschränken:

• Verwenden Sie ein dediziertes Dienstkonto für die Interaktion mit Repositories.
• Erteilen Sie die vom Dienstkonto erforderliche Artifact Registry-Mindestrolle. Weisen Sie z. B. Artifact Registry-Reader einem Dienstkonto zu, das nur Artefakte herunterlädt.
• Wenn Gruppen in Ihrer Organisation verschiedene Zugriffsebenen für bestimmte Repositories benötigen, erteilen Sie den Zugriff auf Repository-Ebene und nicht auf Projektebene.
• Folgen Sie den Best Practices für die Verwaltung von Anmeldedaten.

Mit Credential Helper authentifizieren

Artifact Registry bietet einen Maven-Wagon und ein Gradle-Plug-in als Credential Helper. Wenn Sie Credential Helper verwenden, werden Ihre Anmeldedaten nicht in Ihrem Java-Projekt gespeichert. Stattdessen sucht Artifact Registry in der folgenden Reihenfolge nach Anmeldedaten:

1. Standardanmeldedaten für Anwendungen (ADC), eine Strategie, die in der folgenden Reihenfolge nach Anmeldedaten sucht:

   1. In der Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS definierte Anmeldedaten.

   2. Anmeldedaten, die das Standarddienstkonto für Compute Engine, Google Kubernetes Engine, Cloud Run, App Engine oder Cloud Run-Funktionen bietet.

2. Von der Google Cloud CLI bereitgestellte Anmeldedaten, einschließlich Nutzeranmeldedaten aus dem Befehl gcloud auth application-default login.

Mit der Variablen GOOGLE_APPLICATION_CREDENTIALS wird das Konto für die Authentifizierung explizit angegeben, was die Fehlerbehebung erleichtert. Wenn Sie die Variable nicht verwenden, prüfen Sie, ob alle Konten, die ADC möglicherweise verwendet, die erforderlichen Berechtigungen haben. Das Standarddienstkonto für Compute Engine-VMs, Google Kubernetes Engine-Knoten und Cloud Run-Versionen hat beispielsweise Lesezugriff auf Repositories. Wenn Sie aus diesen Umgebungen mit dem Standarddienstkonto hochladen möchten, müssen Sie die Berechtigungen ändern.

Dienstkonto für einen Anmeldedaten-Hilfsprogramm einrichten

So erstellen Sie ein Dienstkonto und richten die Authentifizierung mithilfe der Umgebungsvariable ein:

1. Erstellen Sie ein Dienstkonto, das im Namen Ihrer Anwendung agieren soll, oder wählen Sie ein vorhandenes Dienstkonto für die Automatisierung aus.

   Sie benötigen den Speicherort der Dienstkonto-Schlüsseldatei, um damit die Authentifizierung bei Artifact Registry einzurichten. Auf der Seite „Dienstkonten“ können Sie die Schlüssel vorhandener Konten aufrufen und neue Schlüssel erstellen.

   Zur Seite „Dienstkonten“

   Hinweis: Dienstkontoschlüssel stellen ein Sicherheitsrisiko dar, wenn sie nicht ordnungsgemäß verwaltet werden. Sie sollten nach Möglichkeit eine sicherere Alternative zu Dienstkontoschlüsseln auswählen. Wenn Sie sich mit einem Dienstkontoschlüssel authentifizieren müssen, sind Sie für die Sicherheit des privaten Schlüssels und für andere Vorgänge verantwortlich, die unter Best Practices für die Verwaltung von Dienstkontoschlüsseln beschrieben werden. Wenn Sie keinen Dienstkontoschlüssel erstellen können, ist das Erstellen von Dienstkontoschlüsseln für Ihre Organisation möglicherweise deaktiviert. Weitere Informationen finden Sie unter Standardmäßig sichere Organisationsressourcen verwalten.

2. Weisen Sie dem Dienstkonto die Rolle Artifact Registry zu, um den Zugriff auf das Repository zu ermöglichen.

3. Weisen Sie der Variablen GOOGLE_APPLICATION_CREDENTIALS den Speicherort des Dienstkontoschlüssels zu, damit die Artifact Registry-Credential Helper Ihren Schlüssel beim Herstellen einer Verbindung zu Repositories abrufen können.

   export GOOGLE_APPLICATION_CREDENTIALS=KEY-FILE
   

   Dabei ist KEY-FILE der Pfad zur Schlüsseldatei des Dienstkontos.

Maven konfigurieren

1. Konfigurieren Sie Maven für den von Ihnen verwendeten Repository-Typ.

   Standard

   1. Führen Sie den folgenden Befehl aus, um die Repository-Konfiguration zu drucken und sie dem Java-Projekt hinzuzufügen.

      gcloud artifacts print-settings mvn \
          --project=PROJECT \
          --repository=REPOSITORY \
          --location=LOCATION
      

      Dabei gilt:

      • PROJECT ist die Projekt-ID. Wenn dieses Flag nicht angegeben ist, wird das aktuelle Projekt oder das Standardprojekt verwendet.
      • REPOSITORY ist die ID des Repositorys. Wenn Sie ein Standard-Artifact Registry-Repository konfiguriert haben, wird es verwendet, wenn dieses Flag im Befehl ausgelassen wird.
      • LOCATION ist der regionale oder multiregionale Standort für das Repository.

   2. Fügen Sie die zurückgegebenen Einstellungen in die entsprechenden Abschnitte der Datei pom.xml für Ihr Maven-Projekt ein. Weitere Informationen zur Struktur der Datei finden Sie in der POM-Referenz zu Maven.

      Das folgende Beispiel zeigt die Einstellungen für ein Repository, in dem sowohl Snapshot- als auch Release-Versionen gespeichert werden.

      <distributionManagement>
        <snapshotRepository>
          <id>artifact-registry</id>
          <url>artifactregistry://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY</url>
        </snapshotRepository>
        <repository>
          <id>artifact-registry</id>
          <url>artifactregistry://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY</url>
        </repository>
      </distributionManagement>
      
      <repositories>
        <repository>
          <id>artifact-registry</id>
          <url>artifactregistry://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY</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.2.4</version>
          </extension>
        </extensions>
      </build>
      

      Die Elemente <release> und <snapshot> geben an, ob im Repository Release- oder Snapshot-Pakete oder beides gespeichert werden. Diese Einstellungen sollten der Versionierungsrichtlinie des Repositories entsprechen.

      Das <build>-Element definiert den Artifact Registry-Wagon als Erweiterung. Informationen zu Wagon finden Sie in der Dokumentation zu den Maven-Tools für Artifact Registry.

   Remote oder virtuell

   Bearbeiten Sie die Datei pom.xml in Ihrem Projekt. Weitere Informationen zur Struktur der Datei finden Sie in der POM-Referenz zu Maven.

   Das folgende Beispiel zeigt die Einstellungen für ein Remote-Repository, in dem sowohl Snapshot- als auch Release-Versionen gespeichert werden. In diesem Beispiel ist das Projekt von einer Version des Guava-Pakets abhängig.

   <?xml version="1.0" encoding="UTF-8"?>
   <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">
     <modelVersion>4.0.0</modelVersion>
   
     <groupId>com.google.hello</groupId>
     <artifactId>repo-config</artifactId>
     <version>4.1-SNAPSHOT</version>
     <description>version 1 release</description>
   
     <properties>
       <maven.compiler.source>1.8</maven.compiler.source>
       <maven.compiler.target>1.8</maven.compiler.target>
     </properties>
     <dependencies>
       <dependency>
         <groupId>com.google.guava</groupId>
         <artifactId>guava</artifactId>
         <version>28.0-jre</version>
       </dependency>
     </dependencies>
   
     <repositories>
       <repository>
         <id>central</id>
         <name>Maven Central remote repository</name>
         <url>artifactregistry://LOCATION-maven.pkg.dev/PROJECT_ID/REMOTE-REPOSITORY-NAME</url>
         <layout>default</layout>
         <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.2.4</version>
         </extension>
       </extensions>
     </build>
   </project>
   

   • Im Abschnitt <repositories> wird das Artifact Registry-Repository definiert. Bei einem Remote-Repository muss das Element <id> auf central gesetzt sein. Mit dieser Einstellung wird der Standardwert für die central-Repository-ID überschrieben, der aus der Super POM übernommen wird.

   • Im Abschnitt <build> wird der Artifact Registry-Wagon als Erweiterung festgelegt. Informationen zu Wagon finden Sie in der Dokumentation zu den Maven-Tools für Artifact Registry.

   • In diesem Beispiel wird im Abschnitt <dependencies> eine Abhängigkeit von der Paketversion 28.0-jre von Guava festgelegt.

2. Maven löst einige Abhängigkeiten auf, bevor ein in pom.xml definierter Wagon angewendet wird, darunter:

   • Verweise in einem untergeordneten Maven-Projekt auf ein übergeordnetes Projekt mit dem Element <parent>.
   • In Artifact Registry gespeicherte Plug-in-Abhängigkeiten.

   Wenn diese Abhängigkeiten in Ihrem Projekt aufgelöst werden müssen, müssen Sie den Mechanismus Core Extensions verwenden, damit Maven übergeordnete POM-Dateien und Plug-ins finden kann.

   Erstellen Sie in Ihrem Projekt die Datei ${maven.projectBasedir}/.mvn/extensions.xml mit folgendem Inhalt. Das <extension>-Element definiert das Wagon.

   <extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
     <extension>
       <groupId>com.google.cloud.artifactregistry</groupId>
       <artifactId>artifactregistry-maven-wagon</artifactId>
       <version>2.2.4</version>
     </extension>
   </extensions>
   

   Maven kann übergeordnete oder Plug-in-Abhängigkeiten jetzt von Artifact Registry auflösen.

Die Authentifizierungskonfiguration ist abgeschlossen.

Gradle konfigurieren

1. Konfigurieren Sie Gradle für den von Ihnen verwendeten Repository-Typ.

   Standard

   1. Führen Sie den folgenden Befehl aus, um die Repository-Konfiguration zu drucken und sie dem Java-Projekt hinzuzufügen.

      gcloud artifacts print-settings gradle \
          --project=PROJECT \
          --repository=REPOSITORY \
          --location=LOCATION
      

      Dabei gilt:

      • PROJECT ist die Projekt-ID. Wenn dieses Flag nicht angegeben ist, wird das aktuelle Projekt oder das Standardprojekt verwendet.
      • REPOSITORY ist die ID des Repositorys. Wenn Sie ein Standard-Artifact Registry-Repository konfiguriert haben, wird es verwendet, wenn dieses Flag im Befehl ausgelassen wird.
      • LOCATION ist der regionale oder multiregionale Standort für das Repository.

   2. Fügen Sie die Repository-Einstellungen der Datei build.gradle hinzu. Das folgende Beispiel zeigt die relative Position der gedruckten Abschnitte.

      plugins {
        id "maven-publish"
        id "com.google.cloud.artifactregistry.gradle-plugin" version "2.2.4"
      }
      
      publishing {
        publications {
          mavenJava(MavenPublication) {
            groupId 'maven.example.id'
            from components.java
           }
        }
        repositories {
          maven {
            url "artifactregistry://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY"
          }
        }
      }
      repositories {
        maven {
          url "artifactregistry://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY"
        }
      }
      

      • Im Abschnitt plugins wird das Artifact Registry-Plug-in deklariert. Informationen zum Plug-in finden Sie in der Dokumentation zu den Maven-Tools für Artifact Registry.

      • Im Abschnitt publishing werden die hochzuladenden Dateien und das Ziel-Artifact Registry-Repository definiert. Sie können die Dateiliste im Abschnitt publications aktualisieren, wenn Sie die Datei hochladen können. Informationen zu den Veröffentlichungseinstellungen finden Sie in der Dokumentation zum Maven-Publish-Plug-in.

   Remote oder virtuell

   Fügen Sie die Repository-Einstellungen der Datei build.gradle hinzu.

   Das folgende Beispiel zeigt die Einstellungen für ein Remote-Repository. In diesem Beispiel hat das Projekt eine Abhängigkeit von einer Version des Guava-Pakets.

   plugins {
     id 'java'
     id "maven-publish"
     id "com.google.cloud.artifactregistry.gradle-plugin" version "2.2.4"
     id 'maven'
   }
   
   repositories {
     maven {
       url "artifactregistry://LOCATION-maven.pkg.dev /PROJECT_ID/REMOTE-REPOSITORY-NAME"
     }
   }
   dependencies {
     compile "com.google.guava:guava:31.1-jre"
   }
   

   • Im Abschnitt plugins wird das Artifact Registry-Plug-in deklariert. Informationen zum Plug-in finden Sie in der Dokumentation zu den Maven-Tools für Artifact Registry.

   • Im Abschnitt repositories wird das Artifact Registry-Repository definiert.

   • In diesem Beispiel wird im Abschnitt dependencies eine Abhängigkeit von der Paketversion 31.1-jre von Guava festgelegt.

   Definieren Sie die Abhängigkeiten für Ihr Paket im Abschnitt dependencies.

2. Wenn Sie Repositories in der Datei init.gradle oder settings.gradle verwenden möchten, können Sie die Plug-in-Konfiguration in diese Dateien einfügen.

   Fügen Sie für init.gradle die folgende Konfiguration hinzu:

   initscript {
     repositories {
       maven {
         url "https://plugins.gradle.org/m2/"
       }
     }
     dependencies {
       classpath "gradle.plugin.com.google.cloud.artifactregistry:artifactregistry-gradle-plugin:2.2.4"
     }
   }
   apply plugin: com.google.cloud.artifactregistry.gradle.plugin.ArtifactRegistryGradlePlugin
   

   Fügen Sie für „settings.gradle” die folgende Konfiguration hinzu:

   buildscript {
     repositories {
       maven {
         url "https://plugins.gradle.org/m2/"              }
       }
     dependencies {
       classpath "gradle.plugin.com.google.cloud.artifactregistry:artifactregistry-gradle-plugin:2.2.4"
     }
   }
   apply plugin: "com.google.cloud.artifactregistry.gradle-plugin"
   

Die Authentifizierungskonfiguration ist abgeschlossen.

Passwortauthentifizierung konfigurieren

Verwenden Sie diesen Ansatz, wenn Ihre Java-Anwendung eine Authentifizierung mit einem angegebenen Nutzernamen und Passwort erfordert.

Dienstkonto für die Passwortauthentifizierung einrichten

So erstellen Sie ein Dienstkonto:

1. Erstellen Sie ein Dienstkonto, das im Namen Ihrer Anwendung agieren soll, oder wählen Sie ein vorhandenes Dienstkonto für die Automatisierung aus.

   Sie benötigen den Speicherort der Dienstkonto-Schlüsseldatei, um damit die Authentifizierung bei Artifact Registry einzurichten. Auf der Seite „Dienstkonten“ können Sie die Schlüssel vorhandener Konten aufrufen und neue Schlüssel erstellen.

   Zur Seite „Dienstkonten“

   Hinweis: Dienstkontoschlüssel stellen ein Sicherheitsrisiko dar, wenn sie nicht ordnungsgemäß verwaltet werden. Sie sollten nach Möglichkeit eine sicherere Alternative zu Dienstkontoschlüsseln auswählen. Wenn Sie sich mit einem Dienstkontoschlüssel authentifizieren müssen, sind Sie für die Sicherheit des privaten Schlüssels und für andere Vorgänge verantwortlich, die unter Best Practices für die Verwaltung von Dienstkontoschlüsseln beschrieben werden. Wenn Sie keinen Dienstkontoschlüssel erstellen können, ist das Erstellen von Dienstkontoschlüsseln für Ihre Organisation möglicherweise deaktiviert. Weitere Informationen finden Sie unter Standardmäßig sichere Organisationsressourcen verwalten.

2. Wenn Sie das Dienstkonto in der aktuellen gcloud-Befehlszeilensitzung aktivieren möchten, führen Sie den folgenden Befehl aus:

   gcloud auth activate-service-account ACCOUNT --key-file=KEY-FILE
   

   Dabei gilt:

   • ACCOUNT ist das Nutzer- oder Dienstkonto.
   • KEY-FILE ist der Pfad zur JSON-Schlüsseldatei des Dienstkontos.

Maven konfigurieren

1. Konfigurieren Sie Maven für den von Ihnen verwendeten Repository-Typ.

   Standard

   1. Führen Sie den folgenden Befehl aus, um die Repository-Konfiguration zu drucken und sie dem Java-Projekt hinzuzufügen.

      gcloud artifacts print-settings mvn \
          --project=PROJECT \
          --repository=REPOSITORY \
          --location=LOCATION \
          --json-key=KEY-FILE
      

      Dabei gilt:

      • PROJECT ist die Projekt-ID. Wenn dieses Flag nicht angegeben ist, wird das aktuelle Projekt oder das Standardprojekt verwendet.
      • REPOSITORY ist die ID des Repositorys. Wenn Sie ein Standard-Artifact Registry-Repository konfiguriert haben, wird es verwendet, wenn dieses Flag im Befehl ausgelassen wird.
      • LOCATION ist der regionale oder multiregionale Standort für das Repository.
      • KEY-FILE ist der Pfad zur JSON-Schlüsseldatei des Dienstkontos.

   Der Befehl gibt Einstellungen zurück, die in Ihr Java-Projekt aufgenommen werden sollen, einschließlich einer Base64-codierten Version Ihres privaten Schlüssels.

   Hinweis: Wenn Sie die Passwortauthentifizierung mit einem Ansatz einrichten, der in dieser Anleitung nicht beschrieben ist, müssen Sie Ihren privaten Schlüssel base64 codieren. Sie können beispielsweise den Befehl base64 -w 0 KEY-FILE verwenden.

   1. Fügen Sie die zurückgegebenen Repository-Einstellungen im Element <project> den entsprechenden Abschnitten der Datei pom.xml für Ihr Maven-Projekt hinzu. Weitere Informationen zur Struktur der Datei finden Sie in der POM-Referenz zu Maven.

   <project>
     <distributionManagement>
       <snapshotRepository>
         <id>artifact-registry</id>
         <url>https://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY</url>
       </snapshotRepository>
       <repository>
         <id>artifact-registry</id>
         <url>https://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY</url>
       </repository>
     </distributionManagement>
   
     <repositories>
       <repository>
         <id>artifact-registry</id>
         <url>https://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY</url>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>true</enabled>
         </snapshots>
       </repository>
     </repositories>
   </project>
   

   Die Elemente <release> und <snapshot> geben an, ob im Repository Release- oder Snapshot-Pakete oder beides gespeichert werden. Diese Einstellungen sollten der Versionierungsrichtlinie des Repositories entsprechen.

   1. Fügen Sie die zurückgegebenen Authentifizierungseinstellungen im Element <settings> zum Abschnitt <servers> der Datei ~/.m2/settings.xml hinzu. Im folgenden Beispiel ist KEY der base64-codierte Schlüssel aus Ihrer Schlüsseldatei.

   Weitere Informationen finden Sie in der Referenz zu Maven-Einstellungen.

   <settings>
     <servers>
       <server>
         <id>artifact-registry</id>
         <configuration>
           <httpConfiguration>
             <get>
               <usePreemptive>true</usePreemptive>
             </get>
             <head>
               <usePreemptive>true</usePreemptive>
             </head>
             <put>
               <params>
                 <property>
                   <name>http.protocol.expect-continue</name>
                   <value>false</value>
                 </property>
               </params>
             </put>
           </httpConfiguration>
         </configuration>
         <username>_json_key_base64</username>
         <password>KEY</password>
       </server>
     </servers>
   </settings>
   

   Remote oder virtuell

   1. Fügen Sie die Repository-Einstellungen den entsprechenden Abschnitten der Datei pom.xml für Ihr Maven-Projekt hinzu. Weitere Informationen zur Struktur der Datei finden Sie in der POM-Referenz zu Maven.

      <repositories>
        <repository>
           <id>central</id>
           <name>Maven Central remote repository</name>
           <url>artifactregistry://LOCATION-maven.pkg.dev/PROJECT_ID/REMOTE-REPOSITORY-NAME</url>
           <layout>default</layout>
           <releases>
             <enabled>true</enabled>
           </releases>
           <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
      

   Im Abschnitt <repositories> wird das Artifact Registry-Repository definiert. Bei einem Remote-Repository muss das Element <id> auf central gesetzt sein. Mit dieser Einstellung wird der Standardwert für die central-Repository-ID überschrieben, der aus der Super POM übernommen wird.

   1. Codieren Sie die Schlüsseldatei mit dem folgenden Befehl mit Base64. Ersetzen Sie KEY-FILE durch den Namen Ihrer Schlüsseldatei.

      base64 -w 0 KEY-FILE
      

   2. Fügen Sie die Authentifizierungseinstellungen im Element <settings> zum Abschnitt <servers> der Datei ~/.m2/settings.xml hinzu.

   Weitere Informationen finden Sie in der Referenz zu Maven-Einstellungen.

   <settings>
     <servers>
       <server>
         <id>artifact-registry</id>
         <configuration>
           <httpConfiguration>
             <get>
               <usePreemptive>true</usePreemptive>
             </get>
             <head>
               <usePreemptive>true</usePreemptive>
             </head>
             <put>
               <params>
                 <property>
                   <name>http.protocol.expect-continue</name>
                   <value>false</value>
                 </property>
               </params>
             </put>
           </httpConfiguration>
         </configuration>
         <username>_json_key_base64</username>
         <password>KEY</password>
       </server>
     </servers>
   </settings>
   

   Hinweis :Wenn Sie die Passwortauthentifizierung mit einem Ansatz einrichten, der in dieser Anleitung nicht beschrieben ist, müssen Sie Ihren privaten Schlüssel base64 codieren. Sie können beispielsweise den Befehl base64 -w 0 KEY-FILE verwenden.

Die Authentifizierungskonfiguration ist abgeschlossen.

Gradle konfigurieren

1. Konfigurieren Sie Gradle für den von Ihnen verwendeten Repository-Typ.

   Standard

   1. Führen Sie den folgenden Befehl aus, um die Repository-Konfiguration zu drucken und sie dem Java-Projekt hinzuzufügen.

      gcloud artifacts print-settings gradle \
          --project=PROJECT \
          --repository=REPOSITORY \
          --location=LOCATION \
          --json-key=KEY-FILE
      

      Dabei gilt:

      • PROJECT ist die Projekt-ID.
      • REPOSITORY ist die ID oder die vollständig qualifizierte Kennzeichnung für das Repository. Wenn Sie ein Standard-Artifact Registry-Repository konfiguriert haben, wird es verwendet, wenn dieses Flag im Befehl ausgelassen wird.
      • KEY-FILE ist der Pfad zur JSON-Schlüsseldatei des Dienstkontos. Wenn Sie den Befehl zur Aktivierung Ihres Dienstkontos ausgeführt haben, können Sie dieses Flag weglassen.

      Der Befehl gibt Einstellungen zurück, die in Ihr Java-Projekt aufgenommen werden sollen, einschließlich einer Base64-codierten Version Ihres privaten Schlüssels.

   2. Die folgende Zeile aus der zurückgegebenen Konfiguration definiert eine Variable mit dem Namen artifactRegistryMavenSecret für Ihren Dienstkontoschlüssel. Fügen Sie diese Zeile der Datei ~/.gradle/gradle.properties hinzu, damit der Schlüssel in den Builds oder Ihrem Quellkontroll-Repository nicht sichtbar ist.

      artifactRegistryMavenSecret = KEY
      

      In dieser Zeile ist KEY der private Schlüssel in Ihrer Dienstkonto-Schlüsseldatei. Bei _json_key_base64 ist artifactRegistryMavenSecret auf den base64-codierten Schlüssel als Passwort festgelegt.

   3. Geben Sie in build.gradle die Repository-Einstellungen an:

      plugins {
        id "maven-publish"
      }
      
      publishing {
        publications {
          mavenJava(MavenPublication) {
            groupId 'maven.example.id'
            from components.java
          }
        }
        repositories {
          maven {
            url "https://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY"
            credentials {
              username = "_json_key_base64"
              password = "$artifactRegistryMavenSecret"
            }
            authentication {
              basic(BasicAuthentication)
            }
          }
        }
      }
      repositories {
        maven {
          url "https://LOCATION-maven.pkg.dev/PROJECT/REPOSITORY"
          credentials {
            username = "_json_key_base64"
            password = "$artifactRegistryMavenSecret"
          }
          authentication {
            basic(BasicAuthentication)
          }
        }
      }
      

      • Im Abschnitt repositories werden die Repository-URL und die Anmeldedaten für die Authentifizierung festgelegt.
      • Im Abschnitt publishing werden die hochzuladenden Dateien und das Ziel-Artifact Registry-Repository definiert. Sie können die Dateiliste im Abschnitt publications aktualisieren, wenn Sie die Datei hochladen können. Informationen zu den Veröffentlichungseinstellungen finden Sie in der Dokumentation zum Maven-Publish-Plug-in.

   Remote oder virtuell

   1. Codieren Sie die Schlüsseldatei mit dem folgenden Befehl mit Base64. Ersetzen Sie KEY-FILE durch den Namen Ihrer Schlüsseldatei.

      base64 -w 0 KEY-FILE
      

   2. Fügen Sie der Datei ~/.gradle/gradle.properties die folgende Zeile hinzu, damit der Schlüssel in den Builds oder Ihrem Quellkontroll-Repository nicht sichtbar ist.

      artifactRegistryMavenSecret = KEY
      

      In dieser Zeile ist KEY der Inhalt Ihrer base64-codierten Schlüsseldatei.

   3. Fügen Sie die Repository-Einstellungen der Datei build.gradle hinzu.

   Das folgende Beispiel zeigt die Konfiguration eines Remote-Repositories.

   plugins {
     id 'java'
     id "maven-publish"
     id 'maven'
   }
   
   repositories {
     maven {
       url "artifactregistry://LOCATION-maven.pkg.dev /PROJECT_ID/REMOTE-REPOSITORY-NAME"
       credentials {
       username = "_json_key_base64"
       password = "$artifactRegistryMavenSecret"
     }
     authentication {
       basic(BasicAuthentication)
     }
     dependencies {
       compile "com.google.guava:guava:31.1-jre"
     }
   

   • Im Abschnitt repositories wird das Artifact Registry-Repository definiert.

   • In diesem Beispiel wird im Abschnitt dependencies eine Abhängigkeit von der Paketversion 31.1-jre von Guava festgelegt.

   Definieren Sie die Abhängigkeiten für Ihr Paket im Abschnitt dependencies.

Die Authentifizierungskonfiguration ist abgeschlossen.

Nächste Schritte

• Repositories verwalten
• Pakete verwalten