Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra. # GitHub et accès au serveur d' GitHub entreprise dans CodeBuild En GitHub effet, vous pouvez utiliser un jeton d'accès personnel, une OAuth application, un secret du Gestionnaire de Secrets ou une connexion à une GitHub application pour accéder au fournisseur source. Pour GitHub Enterprise Server, vous pouvez utiliser un jeton d'accès personnel, un secret du Gestionnaire de Secrets ou une connexion GitHub App pour accéder au fournisseur source. **Topics** + [GitHub Connexions aux applications pour GitHub et GitHub Enterprise Server](connections-github-app.md) + [GitHub et jeton d'accès au serveur GitHub Enterprise](access-tokens-github.md) + [GitHub OAuth appli](oauth-app-github.md) # GitHub Connexions aux applications pour GitHub et GitHub Enterprise Server Vous pouvez utiliser GitHub l'application pour vous connecter à CodeBuild. GitHub Les connexions aux applications sont prises en charge via [AWS CodeConnections](https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html). L'accès au fournisseur de source vous permet de déclencher une compilation en vous abonnant à [GitHub événements webhook](github-webhook.md) [ CreateWebhook](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_CreateWebhook.html)using ou [Tutoriel : Configuration d'un CodeBuild exécuteur d' GitHub actions hébergé](action-runner.md) en utilisant in CodeBuild. **Note** CodeConnections est disponible dans un nombre de régions inférieur à CodeBuild. Vous pouvez utiliser des connexions entre régions dans. CodeBuild Les connexions créées dans les régions optionnelles ne peuvent pas être utilisées dans d'autres régions. Pour plus d’informations, consultez [Points de terminaison et quotas AWS CodeConnections](https://docs.aws.amazon.com/general/latest/gr/codestar_connections.html). **Topics** + [Étape 1 : créer une connexion à GitHub l'application (console)](#connections-github-console) + [Étape 2 : Accorder l'accès au rôle IAM du CodeBuild projet pour utiliser la connexion](#connections-github-role-access) + [Étape 3 : Configuration CodeBuild pour utiliser la nouvelle connexion](#connections-github-account-credential) + [Résolution des problèmes liés à l' GitHub application](#connections-github-troubleshooting) ## Étape 1 : créer une connexion à GitHub l'application (console) Suivez ces étapes pour utiliser la CodeBuild console afin d'ajouter une connexion pour votre projet dans GitHub. **Pour créer une connexion avec GitHub** + Suivez les instructions du *guide de l'utilisateur des outils* de développement pour [créer une connexion à GitHub](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create-github.html). **Note** Au lieu de créer ou d'utiliser une connexion existante dans votre compte, vous pouvez utiliser une connexion partagée depuis un autre AWS compte. Pour plus d'informations, voir [Partager des connexions avec AWS des comptes](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-share.html). ## Étape 2 : Accorder l'accès au rôle IAM du CodeBuild projet pour utiliser la connexion Vous pouvez accorder l'accès au rôle IAM du CodeBuild projet pour utiliser les GitHub jetons vendus par votre connexion. **Pour accorder l'accès CodeBuild au rôle IAM du projet** 1. Créez un rôle IAM pour votre CodeBuild projet en suivant les instructions correspondant [CodeBuild Autoriser l'interaction avec d'autres AWS services](setting-up-service-role.md) à votre CodeBuild projet. 1. Tout en suivant les instructions, ajoutez la politique IAM suivante à votre rôle de CodeBuild projet pour autoriser l'accès à la connexion. ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "codeconnections:GetConnectionToken", "codeconnections:GetConnection" ], "Resource": [ "arn:aws:iam::*:role/Service*" ] } ] } ``` ------ ## Étape 3 : Configuration CodeBuild pour utiliser la nouvelle connexion Vous pouvez configurer une connexion en tant qu'identifiant au niveau du compte et l'utiliser dans un projet. ------ #### [ AWS Management Console ] **Pour configurer une connexion en tant qu'identifiant au niveau du compte dans AWS Management Console** 1. Dans le **champ Source provider**, sélectionnez **GitHub**. 1. Pour **Credential**, effectuez l'une des opérations suivantes : + Choisissez **Informations d'identification source par défaut** pour utiliser les informations d'identification source par défaut de votre compte pour les appliquer à tous les projets. 1. Si vous n'êtes pas connecté à GitHub, choisissez **Gérer les informations d'identification de source par défaut**. 1. Pour le **type d'identifiant**, choisissez **GitHub App**. 1. Dans **Connexion**, choisissez d'utiliser une connexion existante ou d'en créer une nouvelle. + Choisissez **Identifiant source personnalisé pour utiliser un identifiant** source personnalisé afin de remplacer les paramètres par défaut de votre compte. 1. Pour le **type d'identifiant**, choisissez **GitHub App**. 1. Dans **Connexion**, choisissez d'utiliser une connexion existante ou d'en créer une nouvelle. ------ #### [ AWS CLI ] **Pour configurer une connexion en tant qu'identifiant au niveau du compte dans AWS CLI** + Ouvrez une invite de terminal (Linux, macOS ou Unix) ou de commande (Windows). Utilisez le AWS CLI pour exécuter la **import-source-credentials** commande, en spécifiant le `--auth-type``--server-type`, et `--token` pour votre connexion. Utilisez la commande suivante : ``` aws codebuild import-source-credentials --auth-type CODECONNECTIONS --server-type GITHUB --token ``` ------ Vous pouvez également configurer plusieurs jetons pour vos CodeBuild projets. Pour de plus amples informations, veuillez consulter [Configurer plusieurs jetons comme informations d'identification au niveau de la source](multiple-access-tokens.md#asm-source-credential). ## Résolution des problèmes liés à l' GitHub application Les informations suivantes peuvent vous aider à résoudre les problèmes courants liés à l' GitHub application. **Topics** + [Installez l' GitHub application AWS Connector for dans une région indésirable](#connections-github-troubleshooting.undesired-region) + [La connexion à GitHub l'application n'a pas accès aux référentiels](#connections-github-troubleshooting.repo-access) + [Le rôle IAM du AWS service ne dispose pas des autorisations IAM nécessaires.](#connections-github-troubleshooting.iam-permissions) ### Installez l' GitHub application AWS Connector for dans une région indésirable **Problème :** vous avez installé le AWS connecteur GitHub depuis le GitHub Marketplace, mais la connexion a été créée dans une région indésirable. Si vous tentez de reconfigurer l'application sur le GitHub site Web, elle ne fonctionnera pas car elle est déjà installée sur votre GitHub compte. **Cause possible :** l'application étant déjà installée sur votre GitHub compte, vous ne pouvez que reconfigurer les autorisations de l'application. **Solution recommandée :** vous pouvez créer une nouvelle connexion avec l'ID d'installation dans la région souhaitée. 1. Ouvrez la CodeConnections console dans [https://console.aws.amazon.com/codesuite/Paramètres/connexions](https://console.aws.amazon.com/codesuite/settings/connections) et naviguez jusqu'à la région souhaitée à l'aide du sélecteur de région dans la barre de navigation de la AWS console. 1. Suivez les instructions du *guide de l'utilisateur des outils* de développement pour [créer une connexion à GitHub](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create-github.html). **Note** Comme vous avez déjà installé le AWS Connector pour GitHub l'application, vous pouvez le choisir au lieu d'installer une nouvelle application. ### La connexion à GitHub l'application n'a pas accès aux référentiels **Problème :** un AWS service utilisant la connexion, tel que CodeBuild ou CodePipeline, indique qu'il n'a pas accès au référentiel ou que le référentiel n'existe pas. Voici quelques messages d'erreur possibles : + `Authentication required for primary source.` + `Unable to create webhook at this time. Please try again later.` + `Failed to create webhook. GitHub API limit reached. Please try again later.` ***Cause possible :** il se peut que vous utilisiez l' GitHub application et que vous n'ayez pas accordé l'autorisation d'accès au webhook.* **Solution recommandée :** pour accorder l'étendue d'autorisation requise, suivez les instructions de la [section Navigation vers l' GitHub application que vous souhaitez consulter ou modifier](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#navigating-to-the-github-app-you-want-to-review-or-modify) pour configurer l'application installée. Dans la section des autorisations, vous verrez que l'application n'a pas d'autorisation pour les webhooks et qu'il est possible de consulter les autorisations récemment demandées. Vérifiez et acceptez les nouvelles autorisations. Pour plus d'informations, consultez la section [Approbation des autorisations mises à jour pour une application](https://docs.github.com/en/apps/using-github-apps/approving-updated-permissions-for-a-github-app). GitHub ***Cause possible :** La connexion fonctionnait comme prévu, mais elle n'a soudainement plus accès aux référentiels.* **Solution possible :** Commencez par examiner vos [autorisations](https://docs.github.com/en/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps) et vos [installations](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps), puis vérifiez que l' GitHub application est autorisée et installée. Si l'installation de l' GitHub application est suspendue, vous devez l'annuler. Si l' GitHub application n'est pas autorisée pour une connexion [UAT (User Access Token)](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user), ou si elle n'est pas installée pour une connexion [IAT (Installation Access Token)](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation), la connexion existante n'est plus utilisable et vous devrez créer une nouvelle connexion. Notez que la réinstallation de l' GitHub application ne rétablira pas la connexion précédente associée à l'ancienne installation. **Solution possible :** s'il s'agit d'une connexion UAT, assurez-vous qu'elle n'est pas utilisée simultanément, par exemple lors de plusieurs exécutions CodeBuild simultanées de génération. Cela est dû au fait qu'il invalide GitHub immédiatement un UAT précédemment émis si un jeton expirant est actualisé par la connexion. Si vous devez utiliser une connexion UAT pour plusieurs CodeBuild versions simultanées, vous pouvez créer plusieurs connexions et utiliser chaque connexion indépendamment. **Solution possible :** Si la connexion UAT n'a pas été utilisée au cours des 6 derniers mois, la connexion sera invalidée par. GitHub Pour résoudre ce problème, créez une nouvelle connexion. ***Cause possible :** vous avez peut-être utilisé une connexion UAT sans installer l'application.* **Solution recommandée :** Bien que la création d'une connexion UAT ne nécessite pas d'associer la connexion à une installation d' GitHub application, une installation est requise pour que le référentiel soit accessible. Suivez les instructions pour [vérifier les installations](https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps) afin de vous assurer que l' GitHub application est bien installée. S'il n'est pas installé, accédez à la [page de GitHub l'application](https://github.com/marketplace/aws-connector-for-github) pour installer l'application. Pour plus d'informations sur l'accès de l'UAT, consultez [À propos des jetons d'accès utilisateur](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app#about-user-access-tokens). ### Le rôle IAM du AWS service ne dispose pas des autorisations IAM nécessaires. **Problème :** l'un des messages d'erreur suivants s'affiche : + `Access denied to connection ` + `Failed to get access token from ` **Solution recommandée :** vous utilisez généralement une connexion avec un AWS service, tel que CodePipeline ou CodeBuild. Lorsque vous attribuez AWS un rôle IAM au AWS service, celui-ci peut utiliser l'autorisation du rôle pour agir en votre nom. Assurez-vous que le rôle IAM dispose des autorisations nécessaires. Pour plus d'informations sur l'autorisation IAM nécessaire, voir [Accorder l'accès au rôle IAM CodeBuild du projet pour utiliser la connexion et la](#connections-github-role-access) [gestion des identités et des accès pour les AWS CodeStar notifications et CodeConnections](https://docs.aws.amazon.com/dtconsole/latest/userguide/security-iam.html) dans le guide de l'*utilisateur de la console Developer Tools*. # GitHub et jeton d'accès au serveur GitHub Enterprise ## Prérequis de jeton d'accès Avant de commencer, vous devez ajouter les étendues d'autorisation appropriées à votre jeton GitHub d'accès. En effet GitHub, votre jeton d'accès personnel doit avoir les champs d'application suivants. + **repo** : accorde un contrôle total des référentiels privés. + **repo:status** : accorde l' read/write accès aux statuts de validation des référentiels publics et privés. + **admin:repo\$1hook** : accorde le contrôle total des hooks de référentiel. Cette règle n'est pas obligatoire si votre jeton dispose de la règle `repo`. + **admin:org\$1hook** : accorde le contrôle total des hooks de l'organisation. Cette étendue n'est requise que si vous utilisez la fonctionnalité de webhook de l'organisation. Pour plus d'informations, consultez [la section Comprendre les étendues des OAuth applications](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) sur le GitHub site Web. Si vous utilisez des jetons d'accès personnels précis, selon votre cas d'utilisation, votre jeton d'accès personnel peut nécessiter les autorisations suivantes : + **Contenu : Lecture seule** : autorise l'accès aux référentiels privés. Cette autorisation est requise si vous utilisez des référentiels privés comme source. + **Statuts de validation : lecture et écriture** : accorde l'autorisation de créer des statuts de validation. Cette autorisation est requise si le webhook est configuré dans votre projet ou si la fonctionnalité d'état de création de rapports est activée. + **Webhooks : lecture et écriture** : accorde l'autorisation de gérer les webhooks. Cette autorisation est requise si le webhook est configuré dans votre projet. + **Demandes d'extraction : en lecture seule** : accorde l'autorisation d'accéder aux demandes d'extraction. Cette autorisation est requise si votre webhook possède un `FILE_PATH` filtre sur les événements de pull request. + **Administration : lecture et écriture** : cette autorisation est requise si vous utilisez la fonctionnalité GitHub Actions Runner auto-hébergée avec CodeBuild. Pour plus de détails, voir [Créer un jeton d'enregistrement pour un référentiel](https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-a-registration-token-for-a-repository) et[Tutoriel : Configuration d'un CodeBuild exécuteur d' GitHub actions hébergé](action-runner.md). **Note** Si vous souhaitez accéder aux référentiels de l'organisation, assurez-vous de spécifier l'organisation en tant que propriétaire de la ressource du jeton d'accès. Pour plus d'informations, consultez la section [Autorisations requises pour les jetons d'accès personnels détaillés](https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28) sur le GitHub site Web. ## Connect GitHub avec un jeton d'accès (console) Pour utiliser la console afin de connecter votre projet à GitHub l'aide d'un jeton d'accès, procédez comme suit lorsque vous créez un projet. Pour plus d'informations, consultez [Création d'un projet de génération (console)](create-project.md#create-project-console). 1. Dans le **champ Source provider**, sélectionnez **GitHub**. 1. Pour **Credential**, effectuez l'une des opérations suivantes : + Choisissez d'utiliser les informations d'identification du compte pour appliquer les informations d'identification source par défaut de votre compte à tous les projets. 1. Si vous n'êtes pas connecté à GitHub, choisissez **Gérer les informations d'identification du compte**. 1. Pour le **type d'identifiant**, choisissez **jeton d'accès personnel**. + Si vous avez choisi d'utiliser les informations d'identification au niveau du compte pour le **service**, choisissez le service que vous souhaitez utiliser pour stocker votre jeton et procédez comme suit : 1. Si vous choisissez d'utiliser **Secrets Manager**, vous pouvez choisir d'utiliser une connexion secrète existante ou d'en créer un nouveau, puis choisir **Enregistrer**. Pour plus d'informations sur la création d'un nouveau secret, consultez[Créez et stockez un jeton dans un secret du Gestionnaire de Secrets](asm-create-secret.md). 1. Si vous choisissez de l'utiliser **CodeBuild**, entrez votre jeton d'accès GitHub personnel, puis choisissez **Enregistrer**. + Sélectionnez **Utiliser les informations d'identification de remplacement pour ce projet uniquement** pour utiliser des informations d'identification source personnalisées afin de remplacer les paramètres d'identification de votre compte. 1. Dans la liste des informations d'identification renseignée, choisissez l'une des options sous **Jeton d'accès personnel**. 1. Vous pouvez également créer un nouveau jeton d'accès personnel en sélectionnant **créer une nouvelle connexion par jeton d'accès personnel** dans la description. ## Connectez-vous à GitHub l'aide d'un jeton d'accès (CLI) Suivez ces étapes pour connecter votre projet AWS CLI à l' GitHub aide d'un jeton d'accès. Pour plus d'informations sur l'utilisation du AWS CLI with AWS CodeBuild, consultez le[Référence des commandes en ligne](cmd-ref.md). 1. Exécutez la commande **import-source-credentials** : ``` aws codebuild import-source-credentials --generate-cli-skeleton ``` Des données au format JSON apparaissent dans la sortie. Copiez les données dans un fichier (par exemple,`import-source-credentials.json`) situé sur l'ordinateur local ou sur l'instance où le AWS CLI est installé. Modifiez les données copiées comme suit, puis enregistrez vos résultats. ``` { "serverType": "server-type", "authType": "auth-type", "shouldOverwrite": "should-overwrite", "token": "token", "username": "username" } ``` Remplacez les éléments suivants : + *server-type*: valeur requise. Le fournisseur de source utilisé pour cette information d'identification. Les valeurs valides sont GITHUB, BITBUCKET, GITHUB\$1ENTERPRISE, GITLAB et GITLAB\$1SELF\$1MANAGED. + *auth-type*: valeur requise. Type d'authentification utilisé pour se connecter à un référentiel. Les valeurs valides sont OAUTH, BASIC\$1AUTH, PERSONAL\$1ACCESS\$1TOKEN, CODECONNECTIONS et SECRETS\$1MANAGER. Car GitHub seul PERSONAL\$1ACCESS\$1TOKEN est autorisé. BASIC\$1AUTH n'est autorisé qu'avec le mot de passe de l'application Bitbucket. + *should-overwrite*: valeur facultative. Définissez cette valeur sur `false` pour empêcher le remplacement des informations d'identification source du référentiel. Définissez cette valeur sur `true` pour remplacer les informations d'identification source du référentiel. La valeur par défaut est `true`. + *token*: valeur requise. Pour GitHub notre serveur d' GitHub entreprise, il s'agit du jeton d'accès personnel. Pour Bitbucket, il s'agit du jeton d'accès personnel ou du mot de passe de l'application. Pour le type d'authentification CODECONNECTIONS, il s'agit de l'ARN de connexion. Pour le type d'authentification SECRETS\$1MANAGER, il s'agit de l'ARN secret. + *username*: valeur facultative. Ce paramètre est ignoré pour GitHub les fournisseurs de sources GitHub Enterprise Server. 1. Pour vous connecter à votre compte avec un jeton d'accès, passez au répertoire contenant le fichier `import-source-credentials.json` que vous avez enregistré à l'étape 1 et exécutez à nouveau la commande **import-source-credentials**. ``` aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json ``` Les données au format JSON apparaissent dans la sortie avec un Amazon Resource Name (ARN). ``` { "arn": "arn:aws:codebuild:region:account-id:token/server-type" } ``` **Note** Si vous exécutez la commande **import-source-credentials** avec le même type de serveur et de auth une seconde fois, le jeton d'accès stocké est mis à jour. Une fois que votre compte est connecté par un jeton d'accès, vous pouvez l'utiliser `create-project` pour créer votre CodeBuild projet. Pour de plus amples informations, veuillez consulter [Création d'un projet de génération (AWS CLI)](create-project.md#create-project-cli). 1. Pour afficher les jetons d'accès connectés, exécutez la commande **list-source-credentials**. ``` aws codebuild list-source-credentials ``` Un objet `sourceCredentialsInfos` au format JSON apparaît dans la sortie : ``` { "sourceCredentialsInfos": [ { "authType": "auth-type", "serverType": "server-type", "arn": "arn" } ] } ``` Le `sourceCredentialsObject` contient la liste des informations d'identification de la source connectée : + L'élément `authType` est le type d'authentification utilisé par les informations d'identification. Cela peut être `OAUTH``BASIC_AUTH`,`PERSONAL_ACCESS_TOKEN`,`CODECONNECTIONS`, ou`SECRETS_MANAGER`. + Le `serverType` est le type de fournisseur de source. Cela peut être `GITHUB``GITHUB_ENTERPRISE`,`BITBUCKET`,`GITLAB`, ou`GITLAB_SELF_MANAGED`. + Le `arn` est l'ARN du jeton. 1. Pour vous déconnecter d'un fournisseur de source et supprimer ses jetons d'accès, exécutez la commande **delete-source-credentials** avec son ARN. ``` aws codebuild delete-source-credentials --arn arn-of-your-credentials ``` Des données au format JSON sont renvoyées avec un ARN des informations d'identification supprimées. ``` { "arn": "arn:aws:codebuild:region:account-id:token/server-type" } ``` # GitHub OAuth appli ## Connect GitHub en utilisant OAuth (console) Pour utiliser la console afin de connecter votre projet à GitHub une OAuth application, procédez comme suit lorsque vous créez un projet. Pour plus d'informations, consultez [Création d'un projet de génération (console)](create-project.md#create-project-console). 1. Dans le **champ Source provider**, sélectionnez **GitHub**. 1. Pour **Credential**, effectuez l'une des opérations suivantes : + Choisissez d'utiliser les informations d'identification du compte pour appliquer les informations d'identification source par défaut de votre compte à tous les projets. 1. Si vous n'êtes pas connecté à GitHub, choisissez **Gérer les informations d'identification du compte**. 1. Pour le **type d'identifiant**, choisissez **OAuth app**. + Si vous avez choisi d'utiliser les informations d'identification au niveau du compte pour le **service**, choisissez le service que vous souhaitez utiliser pour stocker votre jeton et procédez comme suit : 1. Si vous choisissez d'utiliser **Secrets Manager**, vous pouvez choisir d'utiliser une connexion secrète existante ou d'en créer un nouveau, puis choisir **Enregistrer**. Pour plus d'informations sur la création d'un nouveau secret, consultez[Créez et stockez un jeton dans un secret du Gestionnaire de Secrets](asm-create-secret.md). 1. Si vous choisissez d'utiliser, **CodeBuild**puis choisissez **Enregistrer**. + Sélectionnez **Utiliser les informations d'identification de remplacement pour ce projet uniquement** pour utiliser des informations d'identification source personnalisées afin de remplacer les paramètres d'identification de votre compte. 1. Dans la liste des informations d'identification renseignée, choisissez l'une des options sous **OAuth application**. 1. Vous pouvez également créer un nouveau jeton d' OAuth application en sélectionnant **Créer une nouvelle connexion par jeton d'application Oauth** dans la description. Pour consulter vos OAuth applications autorisées, accédez à [Applications](https://github.com/settings/applications) activées GitHub et vérifiez qu'une application nommée `AWS CodeBuild (region)` appartenant à [aws-codesuite](https://github.com/aws-codesuite) est répertoriée.