Se connecter à un hôte GitLab

Cette page explique comment connecter un GitLab à Cloud Build.

Avant de commencer

  • Activez les API Cloud Build et Secret Manager.

    Rôles requis pour activer les API

    Pour activer les API, vous devez disposer de l'autorisation serviceusage.services.enable. Si vous avez créé le projet, vous disposez probablement déjà de cette autorisation via le rôle Propriétaire (roles/owner). Sinon, vous pouvez l'obtenir via le rôle Administrateur d'utilisation du service (roles/serviceusage.serviceUsageAdmin). Découvrez comment attribuer des rôles.

    Activer les API

Se connecter à un hôte GitLab

Avant de créer une connexion hôte pour votre instance GitLab, vous devez créer des jetons d'accès personnels dans GitLab en procédant comme suit :

  1. Connectez-vous à votre instance GitLab.

  2. Sur la page GitLab de votre instance, cliquez sur votre avatar en haut à droite.

  3. Cliquez sur Modifier mon profil.

  4. Dans la barre latérale de gauche, sélectionnez Jetons d'accès.

    La page Jetons d'accès personnels s'affiche.

  5. Créez un jeton d'accès avec le niveau d'accès api à utiliser pour connecter et déconnecter des dépôts.

  6. Créez un jeton d'accès avec le niveau d'accès read_api pour vous assurer que les dépôts Cloud Build peuvent accéder au code source dans les dépôts.

Console

Connecter votre hôte GitLab à Cloud Build :

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

    Ouvrir la page "Dépôts"

    La page Dépôts s'affiche.

  2. En haut de la page, sélectionnez l'onglet 2e génération.

  3. Dans le sélecteur de projet de la barre supérieure, sélectionnez votre Google Cloud projet.

  4. Cliquez sur Créer une connexion hôte pour connecter un nouvel hôte à Cloud Build.

  5. Dans le panneau de gauche, sélectionnez GitLab comme fournisseur de source.

  6. Dans la section Configurer la connexion, saisissez les informations suivantes :

    • Région : sélectionnez une région pour votre connexion.

    • Nom : saisissez un nom pour votre connexion.

  7. Dans la section Détails de l'hôte , accédez à Hôte GitLab , puis sélectionnez GitLab.com.

  8. (Facultatif) Si vous souhaitez gérer les clés de chiffrement utilisées pour chiffrer les jetons d'accès de vos dépôts GitLab, accédez à la section Chiffrement , puis choisissez une clé Cloud Key Management Service. Pour en savoir plus, consultez Activer les clés de chiffrement gérées par le client pour Secret Manager.

  9. Dans la section Jetons d'accès personnels, saisissez les informations suivantes :

    • Jeton d'accès à l'API : saisissez le jeton avec le niveau d'accès api. Ce jeton est utilisé pour connecter et déconnecter des dépôts.

    • Jeton d'accès à l'API en lecture seule : saisissez le jeton avec le niveau d'accès read_api. Les déclencheurs Cloud Build utilisent ce jeton pour accéder au code source dans les dépôts.

  10. Cliquez sur Se connecter.

    Après avoir cliqué sur le bouton Se connecter, vos jetons d'accès personnels sont stockés de manière sécurisée dans Secret Manager. Après la connexion hôte, Cloud Build crée également un secret de webhook en votre nom. Vous pouvez afficher et gérer vos secrets sur la page Secret Manager.

Vous avez créé une connexion GitLab.

gcloud

Avant de connecter votre hôte GitLab à Cloud Build, procédez comme suit pour stocker vos identifiants :

  1. Stockez votre jeton dans Secret Manager.

  2. Créez un secret de webhook dans Secret Manager en exécutant la commande suivante :

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

  3. Si vous stockez vos secrets dans un Google Cloud projet différent de celui que vous prévoyez d'utiliser pour créer une connexion hôte, saisissez la commande suivante pour accorder à votre projet l'accès à l'agent de service Cloud Build :

    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"

    Où :

    • PROJECT_ID correspond à votre Google Cloud ID de projet.

Vous pouvez maintenant connecter votre hôte GitLab à Cloud Build.

Procédez comme suit :

Connecter votre hôte GitLab à Cloud Build :

  1. Saisissez la commande suivante pour créer une connexion GitLab :

    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

    Où :

    • CONNECTION_NAME correspond au nom de votre connexion hôte GitLab dans Cloud Build.
    • HOST_URI correspond à l'URI de votre instance GitLab. Exemple : https://my-gle-server.net.
    • PROJECT_ID correspond à votre Google Cloud ID de projet.
    • REGION correspond à la région de votre connexion.
    • API_TOKEN correspond au nom de votre jeton avec le niveau d'accès api.
    • READ_TOKEN correspond au nom de votre jeton avec le niveau d'accès read_api.
    • SECRET_VERSION correspond à la version de votre secret.
    • WEBHOOK_SECRET correspond à votre secret de webhook.

Vous avez créé une connexion GitLab.

Effectuer la rotation des jetons d'accès GitLab anciens ou expirés

Effectuez la rotation de vos jetons d'accès afin que votre connexion hôte Cloud Build puisse maintenir sa connexion à votre dépôt GitLab. Si votre jeton d'accès GitLab expire, votre connexion hôte Cloud Build est déconnectée de son dépôt GitLab. Dans ce cas, vous ne pouvez pas désactiver la connexion ni associer de dépôt tant que vous n'avez pas effectué la rotation du jeton expiré. De plus, des erreurs s'affichent dans les cas suivants :

  • La page Détails de la connexion de votre connexion affiche un message d'erreur indiquant Connection is disconnected due to an invalid or expired access token (La connexion est déconnectée en raison d'un jeton d'accès non valide ou expiré).

  • Si vous tentez d'associer un dépôt à une connexion dont le jeton est expiré, le message Jeton d'accès non valide s'affiche. En cliquant sur Afficher la connexion , vous accédez à la page Détails de la connexion de la connexion dont le jeton est expiré.

Cloud Build vous permet d'effectuer la rotation des jetons d'accès en saisissant de nouvelles valeurs de jeton et en les enregistrant dans Secret Manager dans la dernière version secrète de ces jetons. Pour effectuer la rotation de vos jetons d'accès, procédez comme suit :

  1. Effectuez la rotation de chaque jeton d'accès dans GitLab :

    1. Accédez au dépôt GitLab connecté à votre connexion hôte Cloud Build.

    2. Suivez les instructions de la documentation GitLab pour effectuer la rotation d'un jeton d'accès. Lorsque vous effectuez la rotation d'un jeton, GitLab crée un jeton avec de nouveaux identifiants et invalide la version précédente de ce jeton. Votre jeton dont la rotation a été effectuée dispose des mêmes autorisations et du même niveau d'accès que le jeton d'origine.

    3. Copiez les ID de vos jetons dont la rotation a été effectuée.

  2. Mettez à jour votre jeton d'accès dans Cloud Build :

    1. Accédez à la page Détails de la connexion de votre connexion.

    2. Sélectionnez Mettre à jour les jetons d'accès.

    3. Dans le menu Rotation des jetons, saisissez vos nouveaux jetons dans les champs Jeton d'accès à l'API et Jeton d'accès en lecture seule.

    4. (Facultatif) Si vous souhaitez que votre connexion utilise toujours la dernière version du secret pour vos jetons, sélectionnez Mettre à jour la connexion pour toujours utiliser la dernière version. Il peut être utile de laisser cette option désélectionnée si votre connexion utilise un numéro de version secrète spécifique.

    5. Sélectionnez Mettre à jour pour enregistrer vos modifications.

      Cloud Build enregistre les nouveaux jetons d'accès en tant que dernière version de votre secret dans Secret Manager.

Pour en savoir plus, consultez Expiration des jetons d'accès dans la documentation GitLab.

Étape suivante