Verbindung zu einem GitLab-Host herstellen

Auf dieser Seite wird erläutert, wie Sie einen GitLab-Host mit Cloud Build verbinden.

Hinweis

  • Aktivieren Sie die Cloud Build und Secret Manager APIs.

    Erforderliche Rollen zum Aktivieren von APIs

    Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen.

    APIs aktivieren

Verbindung zu einem GitLab-Host herstellen

Bevor Sie eine Hostverbindung für Ihre GitLab-Instanz erstellen, müssen Sie persönliche Zugriffstokens in GitLab erstellen. Gehen Sie dazu so vor:

  1. Melden Sie sich in Ihrer GitLab-Instanz an.

  2. Klicken Sie auf der GitLab-Seite für Ihre Instanz rechts oben auf Ihren Avatar.

  3. Klicken Sie auf Profil bearbeiten.

  4. Wählen Sie in der linken Seitenleiste Zugriffstokens aus.

    Die Seite „Persönliche Zugriffstokens“ wird angezeigt.

  5. Erstellen Sie ein Zugriffstoken mit dem Bereich api, das zum Verbinden und Trennen von Repositories verwendet wird.

  6. Erstellen Sie ein Zugriffstoken mit dem Bereich read_api, damit Cloud Build-Repositories auf den Quellcode in Repositories zugreifen können.

Console

So verbinden Sie Ihren GitLab-Host mit Cloud Build:

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

    Zur Seite „Repositories“

    Die Seite Repositories wird angezeigt.

  2. Wählen Sie oben auf der Seite den Tab 2. Generation aus.

  3. Wählen Sie in der Projektauswahl in der oberen Leiste Ihr Google Cloud Projekt aus.

  4. Klicken Sie auf Hostverbindung erstellen , um einen neuen Host mit Cloud Build zu verbinden.

  5. Wählen Sie im linken Bereich GitLab als Quellanbieter aus.

  6. Geben Sie im Abschnitt Verbindung konfigurieren die folgenden Informationen ein:

    • Region: Wählen Sie eine Region für Ihre Verbindung aus.

    • Name: Geben Sie einen Namen für Ihre Verbindung ein.

  7. Wählen Sie im Abschnitt Hostdetails unter GitLab-Host die Option GitLab.com aus.

  8. Optional: Wenn Sie die Verschlüsselungsschlüssel verwalten möchten, die zum Verschlüsseln der Zugriffstokens für Ihre GitLab-Repositories verwendet werden, rufen Sie den Abschnitt Verschlüsselung auf und wählen Sie einen Cloud Key Management Service-Schlüssel aus. Weitere Informationen finden Sie unter Kundenverwaltete Verschlüsselungsschlüssel für Secret Manager aktivieren.

  9. Geben Sie im Abschnitt Persönliche Zugriffstokens die folgenden Informationen ein:

    • API-Zugriffstoken: Geben Sie das Token mit dem Bereichszugriff api ein. Dieses Token wird zum Verbinden und Trennen von Repositories verwendet.

    • API-Zugriffstoken mit Leseberechtigung: Geben Sie das Token mit dem Bereichszugriff read_api ein. Cloud Build-Trigger verwenden dieses Token, um auf den Quellcode in Repositories zuzugreifen.

  10. Klicken Sie auf Verbinden.

    Nachdem Sie auf die Schaltfläche Verbinden geklickt haben, werden Ihre persönlichen Zugriffstokens sicher in Secret Manager gespeichert. Nach der Hostverbindung erstellt Cloud Build auch in Ihrem Namen ein Webhook-Secret. Sie können Ihre Secrets auf der Seite Secret Manager ansehen und verwalten.

Sie haben jetzt eine GitLab-Verbindung erstellt.

gcloud

Bevor Sie Ihren GitLab-Host mit Cloud Build verbinden, führen Sie die folgenden Schritte aus, um Ihre Anmeldedaten zu speichern:

  1. Speichern Sie Ihr Token in Secret Manager.

  2. Erstellen Sie in Secret Manager ein Webhook-Secret, indem Sie den folgenden Befehl ausführen:

     cat /proc/sys/kernel/random/uuid | tr -d '\n' | gcloud secrets create my-gle-webhook-secret --data-file=-

  3. Wenn Sie Ihre Secrets in einem anderen Google Cloud Projekt speichern als dem, das Sie zum Erstellen einer Hostverbindung verwenden möchten, geben Sie den folgenden Befehl ein, um Ihrem Projekt Zugriff auf den Cloud Build-Dienst-Agenten zu gewähren:

    PN=$(gcloud projects describe PROJECT_ID --format="value(projectNumber)")
CLOUD_BUILD_SERVICE_AGENT="service-${PN}@gcp-sa-cloudbuild."
gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:${CLOUD_BUILD_SERVICE_AGENT}" \
  --role="roles/secretmanager.admin"

    Wobei:

    • PROJECT_ID ist Ihre Google Cloud Projekt-ID.

Sie können jetzt Ihren GitLab-Host mit Cloud Build verbinden.

Gehen Sie folgendermaßen vor:

So verbinden Sie Ihren GitLab-Host mit Cloud Build:

  1. Geben Sie den folgenden Befehl ein, um eine GitLab-Verbindung zu erstellen:

    gcloud builds connections create gitlab CONNECTION_NAME \
  --host-uri=HOST_URI \
  --project=PROJECT_ID \
  --region=REGION \
  --authorizer-token-secret-version=projects/PROJECT_ID/secrets/API_TOKEN/versions/SECRET_VERSION \
  --read-authorizer-token-secret-version=projects/PROJECT_ID/secrets/READ_TOKEN/versions/SECRET_VERSION \
  --webhook-secret-secret-version=projects/PROJECT_ID/secrets/WEBHOOK_SECRET/versions/SECRET_VERSION

    Wobei:

    • CONNECTION_NAME ist ein Name für Ihre GitLab-Hostverbindung in Cloud Build.
    • HOST_URI ist die URI Ihrer GitLab-Instanz. Beispiel: https://my-gle-server.net.
    • PROJECT_ID ist Ihre Google Cloud Projekt-ID.
    • REGION ist die Region für Ihre Verbindung.
    • API_TOKEN ist der Name Ihres Tokens mit dem Bereich api.
    • READ_TOKEN ist der Name Ihres Tokens mit dem Bereich read_api.
    • SECRET_VERSION ist die Version Ihres Secrets.
    • WEBHOOK_SECRET ist Ihr Webhook-Secret.

Sie haben jetzt eine GitLab-Verbindung erstellt.

Alte oder abgelaufene GitLab-Zugriffstokens rotieren

Rotieren Sie Ihre Zugriffstokens, damit die Cloud Build-Hostverbindung die Verbindung zu Ihrem GitLab-Repository aufrechterhalten kann. Wenn Ihr GitLab-Zugriffstoken abläuft, wird die Cloud Build-Hostverbindung von ihrem GitLab-Repository getrennt. In diesem Fall können Sie die Verbindung erst deaktivieren oder ein Repository verknüpfen, wenn Sie das abgelaufene Token rotieren. Außerdem treten unter den folgenden Umständen Fehler auf:

  • Auf der Seite Verbindungsdetails für Ihre Verbindung wird eine Fehlermeldung angezeigt: Connection is disconnected due to an invalid or expired access token.

  • Wenn Sie versuchen, ein Repository mit einer Verbindung zu verknüpfen, die ein abgelaufenes Token hat, wird die Meldung Ungültiges Zugriffstoken angezeigt. Wenn Sie auf Verbindung ansehen klicken, gelangen Sie zur Seite Verbindungsdetails für die Verbindung mit dem abgelaufenen Token.

Mit Cloud Build können Sie Zugriffstokens rotieren, indem Sie neue Tokenwerte eingeben und sie in Secret Manager in der neuesten Secret-Version für diese Tokens speichern. So rotieren Sie Ihre Zugriffstokens:

  1. Rotieren Sie jedes Zugriffstoken in GitLab:

    1. Rufen Sie das GitLab-Repository auf, das mit Ihrer Cloud Build-Hostverbindung verbunden ist.

    2. Folgen Sie der Anleitung in der GitLab-Dokumentation, um ein Zugriffstoken zu rotieren. Wenn Sie ein Token rotieren, erstellt GitLab ein neues Token mit neuen Anmeldedaten und macht die vorherige Version dieses Tokens ungültig. Das rotierte Token hat dieselben Berechtigungen und denselben Bereich wie das ursprüngliche Token.

    3. Kopieren Sie die IDs der rotierten Tokens.

  2. Aktualisieren Sie Ihr Zugriffstoken in Cloud Build:

    1. Rufen Sie die Seite Verbindungsdetails für Ihre Verbindung auf.

    2. Wählen Sie Zugriffstokens aktualisieren aus.

    3. Geben Sie im Menü Tokenrotation Ihre neuen Tokens in die Felder API-Zugriffstoken und Zugriffstoken mit Leseberechtigung ein.

    4. Optional: Wenn Ihre Verbindung immer die neueste Version des Secrets für Ihre Tokens verwenden soll, wählen Sie Verbindung aktualisieren, damit immer die aktuelle Version verwendet wird aus. Wenn Ihre Verbindung eine bestimmte Secret-Versionsnummer verwendet, kann es hilfreich sein, diese Option nicht auszuwählen.

    5. Wählen Sie Aktualisieren aus, um die Änderungen zu speichern.

      Cloud Build speichert die neuen Zugriffstokens als neueste Version Ihres Secrets in Secret Manager.

Weitere Informationen finden Sie in der GitLab-Dokumentation unter Access token expiration (Ablauf von Zugriffstokens).

Nächste Schritte