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.
Connecter GitHub
GitHub l'intégration permet à l' AWS DevOps agent d'accéder aux référentiels de code et de recevoir les événements de déploiement lors des enquêtes sur les incidents. Cette intégration suit un processus en deux étapes : enregistrement au niveau du compte GitHub, suivi de la connexion de référentiels spécifiques à des espaces d'agent individuels.
AWS DevOps L'agent prend en charge les instances GitHub .com (SaaS) et GitHub Enterprise Server (auto-hébergées).
Conditions préalables
Avant de vous connecter GitHub, assurez-vous d'avoir :
Accès à la console d'administration de AWS DevOps l'agent
Un compte GitHub utilisateur ou une organisation avec des autorisations d'administrateur
Autorisation d'installer GitHub des applications dans votre compte ou votre organisation
Pour GitHub Enterprise Server, vous devez également :
Une instance de serveur GitHub d'entreprise (version 3.x ou ultérieure) accessible via HTTPS
L'URL HTTPS de votre instance de serveur GitHub d'entreprise (par exemple,
https://github.example.com)(Facultatif) Une connexion privée, si votre instance de serveur GitHub d'entreprise n'est pas accessible au public
Inscription GitHub (au niveau du compte)
GitHub est enregistré au niveau du AWS compte et partagé entre tous les espaces d'agent de ce compte. Vous ne devez vous inscrire qu' GitHub une seule fois par AWS compte.
Étape 1 : Accédez aux fournisseurs de pipelines
Connectez-vous à la console AWS de gestion
Accédez à la console de AWS DevOps l'agent
Accédez à l'onglet Fonctionnalités
Dans la section Pipeline, cliquez sur Ajouter
Sélectionnez GitHubdans la liste des fournisseurs disponibles
Si ce GitHub n'est pas encore le cas, il vous sera demandé de l'enregistrer d'abord.
Étape 2 : Choisissez le type de connexion
Sur l'écran « Enregistrer un GitHub compte/une organisation », indiquez si vous vous connectez en tant qu'utilisateur ou en tant qu'organisation :
Utilisateur — Votre GitHub compte personnel avec un nom d'utilisateur et un profil
Organisation — Un GitHub compte partagé où plusieurs personnes peuvent collaborer sur de nombreux projets à la fois
Si vous vous connectez à une instance de serveur GitHub d'entreprise, cochez la case Utiliser un serveur GitHub d'entreprise et entrez l'URL HTTPS de votre instance (par exemple,https://github.example.com).
Si votre instance GitHub Enterprise Server n'est pas accessible au public, vous pouvez éventuellement configurer une connexion privée pour permettre à l' AWS DevOps agent d'accéder à votre instance en toute sécurité. Pour de plus amples informations, veuillez consulter Connexion à des outils hébergés en privé.
Note
N'incluez /api/v3 aucun chemin de fin dans l'URL ; entrez uniquement l'URL de base.
Étape 3 : configurer l' GitHub application
Cliquez sur Soumettre pour démarrer le processus de configuration de l'application. Les étapes suivantes varient selon que vous vous connectez à GitHub .com ou à GitHub Enterprise Server.
Pour GitHub .com
Vous serez redirigé GitHub vers l' GitHub application AWS DevOps Agent pour y installer.
Sélectionnez le compte ou l'organisation dans lequel vous souhaitez installer l'application.
L'application permet à l' AWS DevOps agent de recevoir des événements provenant de référentiels connectés, y compris des événements de déploiement.
Pour GitHub Enterprise Server
GitHub Enterprise Server utilise un flux GitHub App Manifest, qui configure automatiquement une nouvelle GitHub application sur votre instance. Cela implique deux redirections vers votre instance de serveur GitHub d'entreprise.
Votre navigateur sera redirigé vers la page « Créer une GitHub application » de votre instance GitHub Enterprise Server.
Vous verrez le nom de l'application prérempli. N'hésitez pas à modifier le nom selon vos besoins. Cliquez sur Créer une GitHub application.
Vous serez redirigé vers l' AWS DevOps Agent, qui échange le code manifeste contre les informations d'identification de l'application.
Étape 4 : sélectionner les référentiels et terminer l'installation
Vous verrez la page d'installation et d'autorisation de l' GitHub application.
Sélectionnez les référentiels auxquels l'application doit accéder :
Tous les référentiels : accordez l'accès à tous les référentiels actuels et futurs
Sélectionnez uniquement les référentiels : choisissez des référentiels spécifiques à partir de votre compte ou de votre organisation
Cliquez sur Installer et autoriser.
Vous serez redirigé vers la console de l' AWS DevOps agent, où GitHub vous serez enregistré au niveau du compte.
Connexion de référentiels à un espace d'agents
Une fois enregistré GitHub au niveau du compte, vous pouvez connecter des référentiels spécifiques à des espaces d'agent individuels :
Dans la console AWS DevOps Agent, sélectionnez votre espace agent
Accédez à l'onglet Fonctionnalités
Dans la section Pipeline, cliquez sur Ajouter
Sélectionnez GitHubdans la liste des fournisseurs disponibles
Sélectionnez le sous-ensemble de référentiels correspondant à cet espace agent
Cliquez sur Ajouter pour terminer la connexion
Vous pouvez connecter différents ensembles de référentiels à différents espaces d'agent en fonction des besoins de votre organisation.
Comprendre l' GitHub application
L' GitHub application AWS DevOps Agent :
Demande l'accès à vos référentiels : vous pouvez consulter les autorisations spécifiques lors de l'installation de GitHub l'application
Reçoit les événements de déploiement et autres événements du référentiel
Permet à AWS DevOps l'agent de corréler les modifications de code avec les incidents opérationnels
Peut être désinstallé à tout moment via vos GitHub paramètres
Pour GitHub Enterprise Server, l' GitHub application est automatiquement créée sur votre instance lors de l'enregistrement. Vous pouvez gérer l'accès au référentiel de l'application ou la désinstaller via Paramètres > Applications > GitHub Applications installées. Pour supprimer complètement la définition de l'application, accédez à Réglages > Paramètres du développeur > GitHub Applications.
GitHub Mises à jour des autorisations de
AWS DevOps L'agent peut demander des mises à jour des autorisations après avoir installé l' GitHub application pour prendre en charge les nouvelles fonctionnalités. Lorsque cela se produit :
Vous recevrez une notification GitHub concernant la demande de mise à jour des autorisations.
Consultez les détails de la mise à jour pour comprendre quelles nouvelles autorisations sont demandées.
Acceptez la demande d'octroi des autorisations mises à jour.
Aucune modification n'est requise dans votre service ou votre application. Une fois que vous avez accepté les autorisations mises à jour, le jeton d'accès à l'installation suivant demandé par GitHub l' AWS DevOps agent inclura automatiquement les nouvelles autorisations.
Note
Jusqu'à ce que vous acceptiez une mise à jour des autorisations, l' AWS DevOps agent continue de fonctionner avec les autorisations précédemment accordées. Les nouvelles fonctionnalités qui dépendent des autorisations mises à jour ne seront pas disponibles tant que vous n'aurez pas approuvé la demande.
Gestion des GitHub connexions
Mise à jour de l'accès aux référentiels : pour modifier les référentiels auxquels GitHub l'application peut accéder, accédez aux paramètres de votre GitHub compte ou de votre organisation (ou aux paramètres de votre instance GitHub Enterprise Server), accédez aux GitHub applications installées et modifiez la configuration de l'application AWS DevOps Agent.
Affichage des référentiels connectés : dans la console de l' AWS DevOps agent, sélectionnez votre espace agent et accédez à l'onglet Fonctionnalités pour afficher les référentiels connectés dans la section Pipeline.
Suppression de la GitHub connexion : pour vous déconnecter GitHub d'un espace agent, sélectionnez la connexion dans la section Pipeline et cliquez sur Supprimer. Pour désinstaller complètement l' GitHub application, désinstallez-la dans les paramètres de votre GitHub compte ou de votre organisation. Pour GitHub Enterprise Server, étant donné que l' GitHub application est créée directement sur votre instance lors de l'enregistrement, vous pouvez éventuellement nettoyer entièrement l'application en effectuant les deux opérations suivantes :
Désinstallez l'application : accédez à Paramètres > Applications > GitHub Applications installées, cliquez sur Configurer dans l'application, puis désinstallez-la.
Supprimer l'application : accédez à Réglages > Paramètres du développeur > GitHub Applications, sélectionnez l'application, accédez à l'onglet Avancé, puis choisissez Supprimer GitHub l'application. Avertissement : La suppression de l' GitHub application est définitive et ne peut pas être annulée. Si vous le supprimez, vous devrez réenregistrer GitHub Enterprise Server depuis le début dans la console de l' AWS DevOps agent pour créer une nouvelle application.
