Se connecter à un hôte Bitbucket Server

Cette page explique comment connecter un hôte Bitbucket Server à Cloud Build. La connexion à un hôte Bitbucket Server permet d'intégrer vos dépôts Bitbucket Server à Cloud Build. Vous pouvez ainsi configurer des déclencheurs de compilation pour créer des dépôts à partir de Bitbucket Server et créer des dépôts à partir de Bitbucket Server dans un réseau privé.

Avant de commencer

  • Enable the Cloud Build, Secret Manager, and Compute Engine APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  • Préparez votre code source dans un dépôt Bitbucket Server.
  • Vous devez disposer d'un fichier de configuration Dockerfile ou Cloud Build dans votre dépôt source Bitbucket Server.
  • Si vous n'avez pas installé d'instance Bitbucket Server, consultez le guide d'installation de Bitbucket Server pour obtenir des instructions.

Autorisations IAM requises

Pour obtenir les autorisations nécessaires pour vous connecter à votre hôte Bitbucket Server, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre compte utilisateur :

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Si votre instance Bitbucket Server est hébergée dans un réseau privé, consultez Créer des dépôts à partir de Bitbucket Server dans un réseau privé pour en savoir plus sur les rôles IAM supplémentaires requis pour configurer une connexion hôte.

Créer des jetons d'accès personnels

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

  1. Connectez-vous à votre instance Bitbucket Server.

  2. Suivez les instructions pour créer des jetons d'accès HTTP pour votre compte utilisateur.

    1. Créez un jeton d'accès avec le champ d'application repository admin (administrateur de dépôt) pour l'utiliser afin de connecter et de déconnecter des dépôts.

    2. Créez un jeton d'accès avec le champ d'application repository read pour vous assurer que les dépôts Cloud Build peuvent accéder au code source des dépôts.

  3. Enregistrez vos valeurs de jeton de manière sécurisée. Vous les utiliserez pour vous connecter à votre dépôt Bitbucket Server.

Se connecter à un hôte Bitbucket Server

Console

Pour connecter votre hôte Bitbucket Server à Cloud Build à l'aide de la console  Google Cloud  :

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

    Ouvrir la page "Dépôts"

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

  3. Cliquez sur Connecter un hôte.

  4. Sélectionnez Bitbucket Server dans le menu déroulant.

    Le panneau Connecter un hôte s'affiche.

    Saisissez les informations suivantes pour connecter votre instance Bitbucket Server à Cloud Build :

    1. Région : sélectionnez la région de votre connexion.

    2. Nom : saisissez un nom pour votre connexion.

    3. URL de l'hôte : URL de l'hôte de votre instance Bitbucket Server. Exemple : https://bbs.example-test.com:7990.

    4. Clé APIGoogle Cloud  : saisissez la clé API utilisée pour authentifier vos identifiants.

    5. Certificat CA : votre certificat autosigné. Votre certificat ne doit pas dépasser 10 Ko et doit être au format PEM (.pem, .cer ou .crt). Si vous laissez cette section vide, Google Cloud utilise un certificat de l'ensemble de certificats par défaut.

    6. Nom d'utilisateur : nom d'utilisateur de votre compte Bitbucket Server. Ce compte doit disposer d'un accès administrateur aux dépôts que vous souhaitez connecter à Cloud Build.

    7. Jeton d'accès en lecture seule : saisissez le jeton d'accès personnel de votre compte Bitbucket Server avec les autorisations de lecture.

    8. Jeton d'accès administrateur : saisissez le jeton d'accès personnel de votre compte Bitbucket Server avec les autorisations d'administrateur sur les projets et les dépôts.

    9. Sous Type de réseau, sélectionnez l'une des options suivantes :

      1. Internet public : sélectionnez cette option si votre instance est accessible via l'Internet public.

      2. Réseau privé : sélectionnez cette option si votre instance est hébergée sur un réseau privé.

        1. Projet : sélectionnez l'ID de votre projet Google Cloud .

        2. Réseau : sélectionnez votre réseau dans le menu déroulant. Si vous n'avez pas encore créé de réseau, consultez Créer et gérer des réseaux VPC pour découvrir comment en créer un.

        3. Plage d'adresses IP : saisissez la plage d'adresses IP internes qui peuvent être attribuées aux VM dans la plage allouée d'un réseau appairé.

          Vous pouvez spécifier la plage à l'aide de la notation CIDR (Classless Inter-Domain Routing) au format STARTING_IP/SUBNET_PREFIX_SIZE. Par exemple, 192.0.2.0/24 a une longueur de préfixe de 24. Les 24 premiers bits de la plage d'adresses IP sont utilisés comme masque de sous-réseau (192.0.2.0), tandis que les adresses d'hôte possibles vont de 192.0.2.0 à 192.0.2.255.

          La valeur de la longueur de votre préfixe ne doit pas dépasser /29. Si aucune valeur n'est spécifiée pour la plage, la valeur par défaut /24 est automatiquement attribuée. Si aucune valeur n'est spécifiée pour la longueur du préfixe, des adresses IP sont automatiquement attribuées dans le réseau VPC appairé. Si aucune valeur n'est spécifiée pour l'adresse IP, une plage est automatiquement attribuée à l'adresse IP dans le réseau VPC appairé.

  5. Cliquez sur Connecter un hôte.

    Si votre instance Bitbucket Server se trouve sur un réseau appairé, la connexion de votre hôte peut prendre plusieurs minutes.

    Vous serez redirigé vers le panneau Connecter un dépôt.

    Une fois la connexion à l'hôte créée, vos jetons d'accès personnels et le secret du webhook seront stockés de manière sécurisée dans Secret Manager. Vous pouvez afficher et gérer vos secrets sur la page Secret Manager.

gcloud

Pour connecter votre hôte Bitbucket Server à Cloud Build à l'aide des commandes gcloud, vous devez exécuter la commande gcloud alpha builds enterprise-config bitbucketserver create dans votre terminal. Contrairement à la connexion de votre hôte à l'aide de la consoleGoogle Cloud , vous devrez stocker manuellement vos jetons d'accès personnels et le code secret du webhook dans Secret Manager avant d'exécuter la commande suivante :

gcloud alpha builds enterprise-config bitbucketserver create
    --name=CONFIG_NAME \
    --user-name=USERNAME \
    --host-uri=HOST_URI \
    --admin-access-token-secret-version=ADMIN_ACCESS_TOKEN_SECRET_VERSION \
    --read-access-token-secret-version=READ_ACCESS_TOKEN_SECRET_VERSION \
    --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION \
    --api-key=API_KEY \
    --peered-network=PEERED_NETWORK \
    --peered-network-ip-range=PEERED_NETWORK_IP_RANGE \
    --ssl-ca-file=SSL_CA_FILE

Où :

  • CONFIG_NAME est le nom de votre configuration Bitbucket Server.
  • USERNAME est votre nom d'utilisateur Bitbucket Server.
  • HOST_URI est l'URI de l'hôte de votre instance Bitbucket Server.
  • ADMIN_ACCESS_TOKEN_SECRET_VERSION est le nom de ressource de votre jeton d'accès administrateur stocké dans Secret Manager. Le format attendu pour les secrets stockés dans Secret Manager est projects/${PROJECT_ID}/secrets/${SECRET_NAME}/versions/${VERSION_NUMBER}. Vous pouvez spécifier latest comme version pour utiliser la dernière version de votre secret. Cela s'applique à chaque ressource stockée dans Secret Manager.
  • READ_ACCESS_TOKEN_SECRET_VERSION est le nom de ressource de votre jeton d'accès en lecture stocké dans Secret Manager.
  • WEBHOOK_SECRET_SECRET_VERSION est le nom de ressource de votre secret de webhook stocké dans Secret Manager.
  • API_KEY est la clé API Google Cloud .

  • Facultatif : PEERED_NETWORK est le réseau VPC auquel se connecter pour vos instances Bitbucket Server sur site. Pour en savoir plus, consultez Créer des dépôts à partir de Bitbucket Server dans un réseau privé.

  • Facultatif : PEERED_NETWORK_IP_RANGE correspond à la plage d'adresses IP internes pouvant être attribuées aux VM dans la plage allouée d'un réseau appairé.

  • SSL_CA_FILE est le chemin d'accès à un fichier local contenant votre certificat SSL à utiliser pour les requêtes adressées à Bitbucket Server. Le certificat doit être au format PEM.

API

Pour connecter votre hôte Bitbucket Server à Cloud Build à l'aide de l'API, utilisez le modèle JSON suivant. Contrairement à la connexion de votre hôte à l'aide de la console Google Cloud , vous devez stocker manuellement vos jetons d'accès personnels et le secret du webhook dans Secret Manager avant d'appeler l'API :

{
    "hostUri": "HOST_URI",
    "username": "USERNAME",
    "apiKey": "API_KEY",
    "secrets": {
      "adminAccessTokenVersionName": "ADMIN_ACCESS_TOKEN_SECRET_VERSION",
      "readAccessTokenVersionName": "READ_ACCESS_TOKEN_SECRET_VERSION",
      "webhookSecretVersionName": "WEBHOOK_SECRET_SECRET_VERSION",
    },
    "peeredNetwork": "PEERED_NETWORK",
    "peeredNetworkIpRange": "PEERED_NETWORK_IP_RANGE",
    "sslCa": "SSL_CERTIFICATE"
}

Où :

  • HOST_URI est l'URI de l'hôte de votre instance Bitbucket Server.
  • USERNAME est votre nom d'utilisateur Bitbucket Server.
  • API_KEY est la clé API Google Cloud .

  • ADMIN_ACCESS_TOKEN_SECRET_VERSION est le nom de ressource de votre jeton d'accès administrateur stocké dans Secret Manager. Vous devrez peut-être attribuer le rôle Accesseur de secrets Secret Manager à votre agent de service Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Pour en savoir plus, consultez Attribuer le rôle Secret Manager à votre compte de service.

  • READ_ACCESS_TOKEN_SECRET_VERSION est le nom de ressource de votre jeton d'accès en lecture stocké dans Secret Manager.

  • WEBHOOK_SECRET_SECRET_VERSION est le nom de ressource de votre secret de webhook stocké dans Secret Manager.

  • (Facultatif) PEERED_NETWORK est le réseau VPC auquel établir une connexion d'appairage pour vos instances Bitbucket Server sur site.

    Vous pouvez spécifier la plage à l'aide de la notation CIDR (Classless Inter-Domain Routing) au format STARTING_IP/SUBNET_PREFIX_SIZE. Par exemple, 192.0.2.0/24 a une longueur de préfixe de 24. Les 24 premiers bits de la plage d'adresses IP sont utilisés comme masque de sous-réseau (192.0.2.0), tandis que les adresses d'hôte possibles vont de 192.0.2.0 à 192.0.2.225.

  • Facultatif : PEERED_NETWORK_IP_RANGE correspond à la plage d'adresses IP internes pouvant être attribuées aux VM dans la plage allouée d'un réseau appairé.

  • Facultatif : SSL_CERTIFICATE est le certificat SSL utilisé pour vos instances Bitbucket Server sur site.

Saisissez la commande curl suivante dans votre terminal :

  curl -X POST -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/bitbucketServerConfigs/?bitbucketServerConfigId=CONFIG_NAME -d @config.json

Où :

  • PROJECT_ID est l'ID de votre projet Google Cloud .
  • REGION correspond à la région associée à votre configuration Bitbucket Server.
  • CONFIG_NAME est le nom de votre configuration Bitbucket Server.

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Operation.

Saisissez la commande curl suivante dans votre terminal :

  curl -X GET -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8"  -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/operations/OPERATION_ID

Où :

  • PROJECT_NUMBER est le numéro de votre projet Google Cloud .
  • PROJECT_ID est l'ID de votre projet Google Cloud .
  • REGION correspond à la région associée à votre configuration Bitbucket Server.
  • OPERATION_ID est l'ID de l'opération de création de la configuration Bitbucket Server.

Vous devrez peut-être continuer à exécuter la commande d'API GetOperation jusqu'à ce que la réponse contienne done: true, ce qui indique que l'opération est terminée. Si la configuration Bitbucket Server est créée, elle s'affiche dans le champ response.value. Sinon, consultez le champ error pour obtenir un rapport d'erreur détaillé.

Étapes suivantes