GitHub Enterprise Server auf AWS installieren

Zum Installieren von GitHub Enterprise Server auf Amazon Web Services (AWS) müssen Sie eine Amazon Elastic Compute Cloud (EC2) Instance starten und ein getrenntes Amazon Elastic Block Store-Datenvolume (EBS) erstellen und anhängen.

Vorrausetzungen

In diesem Leitfaden wird davon ausgegangen, dass Sie mit den folgenden AWS-Konzepten vertraut sind:

For an architectural overview, see the "AWS Architecture Diagram for Deploying GitHub Enterprise Server".

This guide recommends the principle of least privilege when setting up your GitHub Enterprise Server instance on AWS. For more information, refer to the AWS Identity and Access Management (IAM) documentation.

Grundlegendes zur Hardware

Minimum requirements

We recommend different hardware configurations depending on the number of user licenses for your GitHub Enterprise Server instance. If you provision more resources than the minimum requirements, your instance will perform and scale better.

BenutzerlizenzenvCPUsArbeitsspeicherAttached-StorageRoot-Storage
Test, Demo oder 10 Benutzer mit eingeschränkten Funktionen432 GB150 GB200 GB
10–3000848 GB300 GB200 GB
3000–50001264 GB500 GB200 GB
5000–80001696 GB750 GB200 GB
8000–10000+20160 GB1000 GB200 GB

If you plan to enable GitHub Actions for the users of your instance, review the requirements for hardware, external storage, and runners in "Getting started with GitHub Actions for GitHub Enterprise Server."

For more information about adjusting resources for an existing instance, see "Increasing storage capacity" and "Increasing CPU or memory resources."

Speicher

We recommend a high-performance SSD with high input/output operations per second (IOPS) and low latency for GitHub Enterprise Server. Workloads are I/O intensive. If you use a bare metal hypervisor, we recommend directly attaching the disk or using a disk from a storage area network (SAN).

Your instance requires a persistent data disk separate from the root disk. Weitere Informationen findest Du unter „Systemübersicht“.

To configure GitHub Actions, you must provide external blob storage. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

You can resize your instance's root disk by building a new instance or using an existing instance. Weitere Informationen findest Du unter „Speicherkapazität erhöhen“.

CPU and memory

The CPU and memory resources that GitHub Enterprise Server requires depend on the levels of activity for users, automations, and integrations.

If you plan to enable GitHub Actions for the users of your GitHub Enterprise Server instance, you may need to provision additional CPU and memory resources for your instance. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

When you increase CPU resources, we recommend adding at least 6.5 GB of memory for each vCPU (up to 16 vCPUs) that you provision for the instance. When you use more than 16 vCPUs, you don't need to add 6.5 GB of memory for each vCPU, but you should monitor your instance to ensure it has enough memory.

Warning: We recommend that users configure webhook events to notify external systems of activity on GitHub Enterprise Server. Automated checks for changes, or polling, will negatively impact the performance and scalability of your instance. For more information, see "About webhooks."

For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."

You can increase your instance's CPU or memory resources. For more information, see "Increasing CPU or memory resources."

Instanztyp bestimmen

Before launching your GitHub Enterprise Server instance on AWS, 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."

Hinweis: Du kannst Deine CPU oder Deinen Arbeitsspeicher jederzeit hochskalieren, indem Du die Größe Deiner Instanz anpasst. Da das Anpassen Deiner CPU- oder Arbeitsspeichergröße jedoch Ausfallzeiten für Deine Benutzer bedeutet, empfehlen wir ein Over-Provisioning der zu skalierenden Ressourcen.

GitHub recommends a memory-optimized instance for GitHub Enterprise Server. For more information, see Amazon EC2 Instance Types on the Amazon EC2 website.

AMI für GitHub Enterprise Server auswählen

Mithilfe des GitHub Enterprise Server-Portals oder der AWS CLI können Sie ein Amazon Machine Image (AMI) für GitHub Enterprise Server auswählen.

AMIs für GitHub Enterprise Server sind in der AWS-Region „GovCloud“ („US-East“ und „US-West“) verfügbar. Dadurch können US-Kunden mit bestimmten gesetzlichen Anforderungen GitHub Enterprise Server in einer föderal konformen Cloud-Umgebung betreiben. Weitere Informationen zur AWS-Compliance mit föderalen und anderen Standards finden Sie auf den Seiten AWS's GovCloud (US) und AWS-Compliance.

GitHub Enterprise Server-Portl zur AMI-Auswahl verwenden

  1. Navigieren Sie zur GitHub Enterprise Server-Downloadseite.
  2. Klicken Sie auf Get the latest release of GitHub Enterprise Server (Neueste Version von GitHub Enterprise Server abrufen).
  3. Klicken Sie im Dropdownmenü „Select your platform“ (Ihre Plattform auswählen) auf Amazon Web Services.
  4. Wählen Sie im Dropdownmenü „Select your AWS“ (Ihren AWS auswählen) Ihre gewünschte Region aus.
  5. Notieren Sie sich die angezeigte AMI-ID.

AWS CLI zur AMI-Auswahl verwenden

  1. Rufen Sie mithilfe der AWS CLI eine Liste der GitHub Enterprise Server-Images ab, die von den AWS-Inhaber-IDs (025577942450 für GovCloud und 895557238572 für andere Regionen) von GitHub veröffentlicht wurden. Weitere Informationen finden Sie unter „describe-images“ in der AWS-Dokumentation.
    aws ec2 describe-images \
    --owners OWNER ID \
    --query 'sort_by(Images,&Name)[*].{Name:Name,ImageID:ImageId}' \
    --output=text
  2. Notieren Sie sich die AMI-ID für das neueste GitHub Enterprise Server-Image.

Sicherheitsgruppe erstellen

Bei der ersten AMI-Verwendung müssen Sie eine Sicherheitsgruppe erstellen und für jeden in der folgenden Tabelle angegebenen Port eine neue Sicherheitsgruppenregel hinzufügen. Weitere Informationen finden Sie im AWS-Leitfaden zur „Verwendung von Sicherheitsgruppen“.

  1. Erstellen Sie an der AWS CLI eine neue Sicherheitsgruppe. Weitere Informationen finden Sie unter „create-security-group“ in der AWS-Dokumentation.

    $ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION"
  2. Notieren Sie sich die Sicherheitsgruppen-ID (sg-xxxxxxxx) Ihrer neu erstellten Sicherheitsgruppe.

  3. Erstellen Sie eine Sicherheitsgruppenregel für jeden der Ports in der folgenden Tabelle. Weitere Informationen finden Sie unter „authorize-security-group-ingress“ in der AWS-Dokumentation.

    $ aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE

    Diese Tabelle zeigt, wofür jeder Port verwendet wird.

    PortDienstBeschreibung
    22SSHGit über SSH-Zugriff. Unterstützt das Klonen, Abrufen und Übertragen von Vorgängen an öffentliche/private Repositorys.
    25SMTPSMTP mit Verschlüsselung (STARTTLS) wird unterstützt.
    80HTTPWebanwendungszugriff. Alle Anforderungen werden an den HTTPS-Port weitergeleitet, wenn SSL aktiviert ist.
    122SSHShellzugriff auf die Instanz. Der standardmäßige SSH-Port (22) ist für den Git- und SSH-Netzwerk-Traffic der Anwendung vorgesehen.
    161/UDPSNMPFür Netzwerküberwachungs-Protokollvorgänge erforderlich.
    443HTTPSWebanwendung und Git über HTTPS-Zugriff.
    1194/UDPVPNSicherer Replikationsnetzwerktunnel in einer hochverfügbaren Konfiguration.
    8080HTTPWebbasierte Managementkonsole in Nur-Text. Nur erforderlich, wenn SSL manuell deaktiviert wird.
    8443HTTPSSichere webbasierte Managementkonsole. Für die grundlegende Installation und Konfiguration erforderlich.
    9418GitEinfacher Git-Protokollport. Nur Klon- und Abrufvorgänge zu öffentlichen Repositorys. Unencrypted network communication. If you have enabled private mode on your instance, then opening this port is only required if you also enabled anonymous Git read access. For more information, see "Enforcing repository management policies in your enterprise."

GitHub Enterprise Server-Instanz erstellen

Zum Erstellen der Instanz müssen Sie eine EC-Instanz mit Ihrem GitHub Enterprise Server-AMI starten und ein zusätzliches Storage-Volume für Ihre Instanzdaten anhängen. Weitere Informationen finden Sie unter „Grundlegendes zur Hardware“.

Hinweis: Sie können die Daten-Disk verschlüsseln, um eine zusätzliche Sicherheitsebene zu schaffen und sicherzustellen, dass alle Daten, die Sie auf Ihre Instanz schreiben, geschützt sind. Die Verwendung verschlüsselter Disks wirkt sich geringfügig auf die Leistung aus. Wenn Sie Ihr Volume verschlüsseln möchten, wird dringend empfohlen, dies zu erledigen, bevor Sie Ihre Instanz erstmals starten. Weitere Informationen finden Sie im Leitfaden „Amazon EBS Encryption“.

Warnung: Wenn Sie die Verschlüsselung nach der Konfiguration Ihrer Instanz aktivieren, müssen Sie Ihre Daten zum verschlüsselten Volume migrieren, was Ausfallzeiten für Ihre Benutzer zur Folge hat.

EC-Instanz starten

Starten Sie an der AWS-CLI eine EC2-Instanz mit Ihrem AMI und der von Ihnen erstellten Sicherheitsgruppe. Hänge ein neues Blockgerät an, das als ein Speicher-Volume für Deine Instanzdaten verwendet werden soll, und konfiguriere die Größe anhand der Anzahl Deiner Benutzerlizenzen. Weitere Informationen finden Sie unter „run-instances“ in der AWS-Dokumentation.

aws ec2 run-instances \
  --security-group-ids SECURITY_GROUP_ID \
  --instance-type INSTANCE_TYPE \
  --image-id AMI_ID \
  --block-device-mappings '[{"DeviceName":"/dev/xvdf","Ebs":{"VolumeSize":SIZE,"VolumeType":"TYPE"}}]' \
  --region REGION \
  --ebs-optimized

Elastic IP zuordnen und mit der Instanz verknüpfen

Wenn es sich hierbei um eine Produktionsinstanz handelt, wird dringend empfohlen, eine Elastic IP (EIP) zuzuordnen und sie mit der Instanz zu verknüpfen, bevor Sie zur GitHub Enterprise Server-Konfiguration weitergehen. Andernfalls wird die öffentliche IP-Adresse der Instanz nach dem Neustart der Instanz nicht beibehalten. Weitere Informationen finden Sie unter „Zuweisen einer Elastic IP-Adresse“ und „Zuordnen einer Elastic IP-Adresse zu einer laufenden Instance“ in der AWS-Dokumentation.

Den primären und Replikatinstanzen sollten in Hochverfügbarkeitskonfigurationen in der Produktion separate EIPs zugewiesen werden. Weitere Informationen finden Sie unter „GitHub Enterprise Server für Hochverfügbarkeit konfigurieren“.

GitHub Enterprise Server-Instanz konfigurieren

  1. Kopiere den Namen des öffentlichen DNS der virtuellen Maschine, und füge ihn in einen Webbrowser ein.
  2. Lade an der Eingabeaufforderung Deine Lizenzdatei hoch, und lege das Passwort für die Managementkonsole fest. For more information, see "Managing your license for GitHub Enterprise."
  3. Konfigurieren Sie in der Managementkonsole Ihre gewünschten Einstellungen, und speichern Sie sie. Weitere Informationen finden Sie unter „GitHub Enterprise Server-Appliance konfigurieren“.
  4. Die Instanz wird automatisch neu gestartet.
  5. Klicke auf Visit your instance (Instanz aufrufen).

Weiterführende Informationen

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.