Installing GitHub Enterprise Server on Google Cloud Platform

To install GitHub Enterprise Server on Google Cloud Platform, you must deploy onto a supported machine type and use a persistent standard disk or a persistent SSD.

Dans cet article

Prerequisites

Hardware considerations

Configuration minimale requise

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 le minimum requis, cela améliorera les performances et la mise à l’échelle de votre instance.

Licences utilisateurProcesseurs virtuels x86-64MémoireStockage racineStockage (de données) attaché
Essai, démonstration ou 10 utilisateurs légers432 Go200 Go150 Go
10 à 3 000848 Go200 Go300 Go
3 000 à 5 0001264 Go200 Go500 Go
5 000 à 8 0001696 Go200 Go750 Go
8 000 à 10 000+20160 Go200 Go1 000 Go

Si vous envisagez d’activer GitHub Actions pour les utilisateurs de votre instance, d’autres ressources sont requises.

Pour plus d’informations sur ces configurations requises, consultez « Getting started with GitHub Actions for 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 « Getting started with GitHub Packages for your enterprise ».

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 ».

Pour configurer GitHub Actions, vous devez fournir un stockage d’objets blob externe. Pour plus d’informations, consultez « Getting started with GitHub Actions for 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 Aarch64 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 « Getting started with GitHub Actions for 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.

Avertissement : 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 ».

Determining the machine type

Before launching votre instance GitHub Enterprise Server on Google Cloud Platform, you'll need to determine the machine type that best fits the needs of your organization. To review the minimum requirements for GitHub Enterprise Server, see "Minimum requirements."

Vous pouvez toujours effectuer un scale-up de votre UC ou de votre mémoire en redimensionnant votre instance. La modification des ressources disponibles pour votre instance nécessite un temps d’arrêt pour vos utilisateurs. Alors GitHub recommande de surprovisionner les ressources pour tenir compte de la mise à l’échelle.

GitHub recommends a general-purpose, high-memory machine for GitHub Enterprise Server. For more information, see "Machine types" in the Google Compute Engine documentation.

Selecting the GitHub Enterprise Server image

  1. Using the gcloud compute command-line tool, list the public GitHub Enterprise Server images:

    gcloud compute images list --project github-enterprise-public --no-standard-images

  2. Take note of the image name for the latest GCE image of GitHub Enterprise Server.

Configuring the firewall

GCE virtual machines are created as a member of a network, which has a firewall. For the network associated with the GitHub Enterprise Server VM, you'll need to configure the firewall to allow the required ports listed in the table below. We recommend opening network ports selectively based on the network services you need to expose for administrative and user purposes. For more information, see "Network ports," and Firewall Rules Overview in the Google Cloud Platform documentation.

  1. Using the gcloud compute command-line tool, create the network. For more information, see gcloud compute networks create in the Google documentation.

    gcloud compute networks create NETWORK-NAME --subnet-mode auto

  2. Create a firewall rule for each of the ports in the table below. For more information, see gcloud compute firewall-rules in the Google documentation.

    $ gcloud compute firewall-rules create RULE-NAME \
--network NETWORK-NAME \
--allow tcp:22,tcp:25,tcp:80,tcp:122,udp:161,tcp:443,udp:1194,tcp:8080,tcp:8443,tcp:9418,icmp

    This table identifies the required ports and what each port is used for.

    PortServiceDescription
    22SSHAccè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.
    25SMTPPrise en charge de SMTP avec chiffrement (STARTTLS).
    80HTTPAccès aux applications web. Toutes les requêtes sont redirigées vers le port HTTPS lorsque SSL est activé.
    122SSHAccè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/UDPSNMPNécessaire au fonctionnement du protocole de supervision de réseau.
    443HTTPSAccès aux applications web et à Git via HTTPS.
    1194/UDPVPNTunnel de réseau de réplication sécurisé dans une configuration à haute disponibilité. Chiffré à l’aide de WireGuard.
    8080HTTPManagement Console web en texte brut. Non obligatoire, sauf si SSL est désactivé manuellement.
    8443HTTPSManagement Console web sécurisée. Requis pour l’installation et la configuration de base.
    9418GitPort 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 « Enforcing repository management policies in your enterprise ».

Allocating a static IP and assigning it to the VM

If this is a production appliance, we strongly recommend reserving a static external IP address and assigning it to the GitHub Enterprise Server VM. Otherwise, the public IP address of the VM will not be retained after restarts. For more information, see the Google guide Reserving a Static External IP Address.

In production High Availability configurations, both primary and replica appliances should be assigned separate static IP addresses.

Creating the GitHub Enterprise Server instance

To create the GitHub Enterprise Server instance, you'll need to create a GCE instance with your GitHub Enterprise Server image and attach an additional storage volume for your instance data. For more information, see "Hardware considerations."

  1. Using the gcloud compute command-line tool, create a data disk to use as an attached storage volume for your instance data, and configure the size based on your user license count. For more information, see gcloud compute disks create in the Google documentation.

    gcloud compute disks create DATA-DISK-NAME --size DATA-DISK-SIZE --type DATA-DISK-TYPE --zone ZONE

  2. Then create an instance using the name of the GitHub Enterprise Server image you selected, and attach the data disk. For more information, see gcloud compute instances create in the Google documentation.

    $ gcloud compute instances create INSTANCE-NAME \
--machine-type n1-standard-8 \
--image GITHUB-ENTERPRISE-IMAGE-NAME \
--disk name=DATA-DISK-NAME \
--metadata serial-port-enable=1 \
--zone ZONE \
--network NETWORK-NAME \
--image-project github-enterprise-public

Configuring the instance

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.

Avertissement : 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.

  1. Copiez le nom DNS public de la machine virtuelle et collez-le dans un navigateur web.
  2. À 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 ».
  3. Dans la Management Console, configurez et enregistrez les paramètres de votre choix. For more information, see "Configuring GitHub Enterprise."
  4. L’instance redémarre automatiquement.
  5. Cliquez sur Accéder à votre instance.

Further reading