Prérequis
- Vous devez disposer d’un fichier de licence GitHub Enterprise. Pour plus d’informations, consultez « Configuration d’un essai de GitHub Enterprise Server » et « À propos des licences pour GitHub Enterprise ».
- Vous devez avoir accès à une installation d’OpenStack Horizon, l’interface utilisateur web pour les services OpenStack. Pour plus d’informations, consultez la documentation Horizon.
Considérations matérielles
Exigences minimales recommandées
Nous recommandons différentes configurations matérielles en fonction du nombre de licences utilisateur pour votre instance GitHub Enterprise Server. Si vous approvisionnez plus de ressources que les exigences minimales recommandées, cela améliorera les performances et la mise à l’échelle de votre instance.
Licences utilisateur | Processeurs virtuels x86-64 | Mémoire | Stockage racine | Stockage (de données) attaché |
---|---|---|---|---|
Essai, démonstration ou 10 utilisateurs légers | 4 | 32 Go | 200 Go | 150 Go |
10 à 3 000 | 8 | 48 Go | 200 Go | 300 Go |
3 000 à 5 000 | 12 | 64 Go | 200 Go | 500 Go |
5 000 à 8 000 | 16 | 96 Go | 200 Go | 750 Go |
8 000 à 10 000+ | 20 | 160 Go | 200 Go | 1 000 Go |
Si vous envisagez d’activer GitHub Actions ou GitHub Advanced Security pour les utilisateurs de votre instance, d’autres ressources sont requises.
- GitHub Actions - augmenter l'unité centrale et la mémoire d'au moins 25 %
- GitHub Advanced Security - augmenter le CPU et la mémoire d'au moins 25 %
Ces ajustements doivent être appliqués aux exigences de base pour chaque niveau utilisateur. Nous vous recommandons de surveiller toutes les modifications apportées à vos ressources, car d’autres augmentations peuvent être nécessaires.
Pour plus d’informations sur ces configurations requises, consultez « Bien démarrer avec GitHub Actions pour GitHub Enterprise Server ».
Si vous envisagez d’activer Container registry pour les utilisateurs de votre instance, d’autres ressources sont requises. Pour plus d’informations sur ces configurations requises, consultez « Bien démarrer avec GitHub Packages pour votre entreprise ».
Pour plus d’informations sur l’ajustement des ressources pour une instance existante, consultez « Augmentation de la capacité de stockage » et « Augmentation des ressources processeur ou mémoire ».
Stockage
Nous recommandons un disque SSD haute performance avec un nombre élevé d’IOPS et une faible latence pour GitHub Enterprise Server. Les charges de travail sont gourmandes en E/S. Si vous utilisez un hyperviseur nu, nous vous recommandons d’attacher directement le disque ou d’utiliser un disque d’un réseau de zone de stockage (SAN).
Votre instance nécessite un disque de données persistant séparé du disque racine. Pour plus d’informations, consultez « Vue d’ensemble du système ».
Warning
Le stockage racine fait référence à la taille totale du disque racine de votre instance. Lorsque l’instance est démarrée, vous verrez 100 Go restants disponibles sur le système de fichiers racine. Les 100 Go restants sont réservés aux mises à niveau. Pour plus d’informations, consultez « Vue d’ensemble du système ».
Pour configurer GitHub Actions, vous devez fournir un stockage d’objets blob externe. Pour plus d’informations, consultez « Bien démarrer avec GitHub Actions pour GitHub Enterprise Server ».
L’espace disponible sur le système de fichiers racine sera de 50 % de la taille totale du disque. Vous pouvez redimensionner le disque racine de votre instance en créant une nouvelle instance ou en utilisant une instance existante. Pour plus d’informations, consultez « Vue d’ensemble du système » et « Augmentation de la capacité de stockage ».
Processeur et mémoire
Les ressources processeur et mémoire que GitHub Enterprise Server requiert dépendent des niveaux d’activité pour les utilisateurs, les automatisations et les intégrations.
Toutes les machines virtuelles que vous provisionnez pour votre instance GitHub Enterprise Server doivent utiliser l’architecture de processeur x86-64. Les autres architectures ne sont pas prises en charge, telles que AAarch64 ou arm64.
Si vous envisagez d’activer GitHub Actions pour les utilisateurs de votre instance GitHub Enterprise Server, il se peut que vous deviez approvisionner des ressources processeur et mémoire supplémentaires pour celle-ci. Pour plus d’informations, consultez « Bien démarrer avec GitHub Actions pour GitHub Enterprise Server ».
Quand vous augmentez les ressources d’UC, GitHub vous recommande d’ajouter au moins 6,5 Go de mémoire par processeur virtuel (jusqu’à 16 processeurs virtuels) que vous approvisionnez pour l’instance. Lorsque vous utilisez plus de 16 processeurs virtuels, vous n’avez pas besoin d’ajouter 6,5 Go de mémoire par processeur virtuel, mais vous devez surveiller votre instance pour vous assurer qu’elle dispose de suffisamment de mémoire.
Warning
Nous recommandons aux utilisateurs de configurer des événements de webhook pour avertir des systèmes externes de l’activité sur GitHub Enterprise Server. Les vérifications automatisées des modifications, ou l’interrogation, auront un impact négatif sur les performances et la scalabilité de votre instance. Pour plus d’informations, consultez « À propos des webhooks ».
Pour plus d’informations sur la supervision de la capacité et des performances de GitHub Enterprise Server, consultez « Surveillance de votre instance ».
Vous pouvez augmenter les ressources processeur ou mémoire de votre instance. Pour plus d’informations, consultez « Augmentation des ressources processeur ou mémoire ».
Téléchargement de l’image de GitHub Enterprise Server
-
Téléchargez votre licence. Pour plus d’informations, consultez « Téléchargement de votre licence pour GitHub Enterprise ».
-
Accédez à l’image que vous souhaitez utiliser pour votre nouvelle instance.
- Accédez aux Notes de publication.
- Sur la barre latérale droite, cliquez sur la version que vous souhaitez télécharger.
- Cliquez sur Télécharger GitHub Enterprise Server X.X.X.
-
Sous « GitHub On-premises », sélectionnez le menu déroulant « Select your hypervisor » (Sélectionnez votre hyperviseur), puis cliquez sur OpenStack KVM (QCOW2) .
-
Cliquez sur Télécharger pour OpenStack KVM (QCOW2) .
Création de l’instance GitHub Enterprise Server
Pour créer l’instance, vous devez importer l’image GitHub Enterprise Server sur votre machine virtuelle et attacher un volume de stockage supplémentaire pour vos données d’instance. Pour plus d’informations, consultez « Considérations matérielles ».
-
Dans OpenStack Horizon, chargez l’image de GitHub Enterprise Server que vous avez téléchargée. Pour obtenir des instructions, consultez la section « Charger une image » du guide OpenStack Charger et gérer des images.
-
Créez un disque virtuel à utiliser comme volume de stockage attaché pour vos données d’instance, et configurez la taille en fonction du nombre de licences utilisateur. Si vous réutilisez un disque existant, vérifiez que le disque est vide et qu’il n’existe aucune partition. Pour obtenir des instructions, consultez le guide OpenStack « Create and manage volumes » (Créer et gérer des volumes).
-
Créez un groupe de sécurité et ajoutez une nouvelle règle de groupe de sécurité pour chaque port indiqué dans le tableau ci-dessous. Pour obtenir des instructions, consultez le guide OpenStack Configurer l’accès et la sécurité pour les instances.
Port Service Description 22 SSH Accès Git via SSH Opérations de clonage, de récupération (fetch) et d’envoi (push) sur les référentiels publics et privés pris en charge. 25 SMTP Prise en charge de SMTP avec chiffrement (STARTTLS). 80 HTTP Accès aux applications web. Toutes les requêtes sont redirigées vers le port HTTPS lorsque SSL est activé. 122 SSH Accès à l’interpréteur de commandes de l’instance. Le port SSH par défaut (22) est dédié au trafic réseau des applications Git et SSH. 161/UDP SNMP Nécessaire au fonctionnement du protocole de supervision de réseau. 443 HTTPS Accès aux applications web et à Git via HTTPS. 1194/UDP VPN Tunnel de réseau de réplication sécurisé dans une configuration à haute disponibilité. Chiffré à l’aide de WireGuard. 8080 HTTP Management Console web en texte brut. Non obligatoire, sauf si SSL est désactivé manuellement. 8443 HTTPS Management Console web sécurisée. Requis pour l’installation et la configuration de base. 9418 Git Port du protocole Git simple. Opérations de clonage et de récupération (fetch) sur référentiels publics uniquement. Communication réseau non chiffrée. Si vous avez activé le mode privé sur votre instance, l’ouverture de ce port n’est nécessaire que si vous avez également activé l’accès en lecture Git anonyme. Pour plus d’informations, consultez « Application de stratégies de gestion des dépôts dans votre entreprise ». -
Si vous le souhaitez, associez une IP flottante à l’instance. Selon votre configuration OpenStack, vous devrez peut-être allouer une IP flottante au projet et l’associer à l’instance. Contactez votre administrateur système pour déterminer si c’est le cas pour vous. Pour plus d’informations, consultez Allouer une adresse IP flottante à une instance dans la documentation OpenStack.
-
Lancez votre instance GitHub Enterprise Server en utilisant l’image, le volume de données et le groupe de sécurité créés aux étapes précédentes. Pour obtenir des instructions, consultez le guide OpenStack Lancer et gérer des instances.
Configuration de l’instance GitHub Enterprise Server
Pour configurer l’instance, vous devez charger un fichier de licence, définir le mot de passe racine Management Console, configurer les paramètres de l’instance et redémarrer l’instance.
Warning
Pour empêcher un attaquant de compromettre la nouvelle instance, veillez à définir personnellement le mot de passe racine Management Console et à créer le premier utilisateur dès que possible.
- Copiez le nom DNS public de la machine virtuelle et collez-le dans un navigateur web.
- À l’invite, chargez votre fichier de licence et définissez un mot de passe pour la console de gestion. Pour plus d’informations, consultez « Gestion de votre licence pour GitHub Enterprise ».
- Dans la Management Console, configurez et enregistrez les paramètres de votre choix. Pour plus d’informations, consultez « Configuration de GitHub Enterprise ».
- L’instance redémarre automatiquement.
- Cliquez sur Accéder à votre instance.