pmanlukas / github_enterprise_deutsch_faq

Meine deutsche, unoffizielle FAQ zu GitHub Enterprise

GitHub Enterprise FAQ - Deutsch

Allgemein

• Wie unterstützen sie eine Migration von SVN?

  • Technisch, fachlich, Projekt

Zusammengefasst ist es möglich

1. auf in GitHub gehostete Repositories weiterhin mit SVN-Clients zuzugreifen, welches einen sanften Umstieg von Subversion-Entwicklern und CI-Tool-Chains ermöglicht. Für einen kombinierten Betrieb von Subversion und Git, empfehlen wir diesen Blog.

2. SVN Repositories mittels kostenfreien Werkzeugen selbst zu migrieren, GitHub Enterprise bringt Spezialwerkzeuge mit

3. Unsere Professional-Services zur Migration zu nutzen

Git und Subversion haben unterschiedliche Design-Philosophien, welches dazu führt, dass während der Migration eines Subversion-Repositories mitunter

• Mehrere Git-Repositories entstehen

• Große Dateien automatisch nach Git LFS ausgelagert werden

• Subversion-Externals in älteren Revisionen angepasst werden

Für mehr Details stehen Ihnen unser Solution Engineering Team und unser Support gerne zur Verfügung.

• Können Instanzen "isoliert" betrieben und genutzt werden? Wie können diese trotzdem interagieren? (Projektspezifische Instanzen)

GitHub empfiehlt den Betrieb möglichst aller Software-Projekte auf einer Instanz um die Idee der Projekt-Wiederverwendung und den Inner Source-Gedanken zu fördern. Die in GitHub integrierte Rechteverwaltung sorgt dafür, dass gesamte Organisationen, einzelne Repositories oder individuelle Branches sauber voneinander getrennt werden können. Technisch ist es jedoch ohne weiteres möglich, mehrere Instanzen von GitHub Enterprise zu betreiben. Da Git von Grund auf als verteiltes Versionskontrollsystem konzipiert wurde, können Repositories mühelos zwischen verschiedenen Instanzen migriert werden. Besteht der Wunsch, zusätzliche Meta-Informationen wie Pull-Requests, Issues oder Wikis auf andere Instanzen zu migrieren, stellt GitHub dafür Migrationswerkzeuge zur Verfügung. Weiterhin ist es möglich, zwischen GitHub.com und GitHub Enterprise eine automatische Synchronisation aufzusetzen.

• Ich welcher Granularität gibt es bei Github Enterprise neue Versionen? (Einzelfeatures oder Gesamtsystem)

Typischerweise steht alle 3 Monate ein neues Major-Release von GitHub Enterprise zur Verfügung, welche alle neuen Funktionalitäten, die in der Zwischenzeit auf GitHub.com released wurden enthält.

Bugfixes und nicht sicherheitskritische Updates werden in Form von einem Minor-Release pro zwei bis vier Wochen zur Verfügung gestellt. Sicherheitskritische Hotfixes werden sofort zur Verfügung gestellt. Die Verfügbarkeit von Updates kann bei bestehender Internetverbindung automatisch, oder über unsere Web-Oberfläche geprüft werden. Ein Upgrade bezieht sich dabei immer auf das Gesamtsystem und ist innerhalb weniger Minuten abgeschlossen. Anbei ein Überblick über die Sicherheit von GitHub Enterprise, sowie unser Bug Bounty Programm.

Rollen & Rechte

• Wie funktioniert ihr Rollen- und Rechtekonzept?

GitHub Enterprise bietet Lese-, Schreib- und Administrations-Rechte auf Branch-, Repository- und Organisationsebene. Zugriff wird über Teams und Collaborators innerhalb Organisationen (vergleichbar mit Rollen) sowie Default-Rechten pro Organisation und Repository-Sichtbarkeit auf Instanzebene gesteuert. Team-Mitgliedschaften können automatisch über LDAP-Gruppen synchronisiert werden.

Einen Überblick über die Konzepte finden Sie in diesem Video.

• Welche Basissystem der Unternehmen können angebunden? (LDAP, Crowd, SAML)

GitHub Enterprise unterstützt SAML, CASund LDAP als Identitätsprovider. Für eine Schritt- für-Schritt-Anleitung für die Synchronisation zwischen LDAP und GitHub Enterprise, folgen Sie diesem Video.

• Level der Rechte gibt es bei ihnen in Bezug auf administrativen Aufgaben (Repo anlegen, User berechtigen) und fachlichen Tätigkeiten?

Einen Überblick über die Bedeutung unserer Zugriffsrechte auf Organisationsebene finden Sie hier. Weiterhin existiert eine Site-Admin-Weboberfläche für Einstellungen, die die gesamte Instanz betreffen (maximale Dateigrößen, globale Pre-receive-Hooks, das Recht, neue Organisationen zu erstellen, etc).

Für fachliche Tätigkeiten, insbesondere für die projektspezifische Entscheidung, wann ein Feature /Pull Request qualitativ gut genug ist, in die Produktion übernommen zu werden, dienen GitHub’s Protected Branches mit Required Status Checks. Einen sehr guten Überblick zu fachspezifischen Quality-Gates liefert dieses Video.

Betriebsmodelle

• Wie arbeiten sie mit ihrem Support mit Unternehmens-Supportmodellen zusammen? (ITIL?)

GitHub bietet ein ticket-basiertes Support-Modell (Zendesk) an, welches Sie bereits während der Trial-Phase kostenfrei testen können. Es gibt keine Limitierung der Ticket-Anzahl und Support ist bereits in den Lizenzkosten enthalten. Alle unsere Support-Ingenieure kennen unser Produkt in- und auswendig und sind direkt bei uns angestellt. Tickets werden zumeist von derselben Person abgeschlossen, die die initiale Bearbeitung begonnen hat. Support-Ingenieure arbeiten über die gesamte Welt verteilt, davon auch mehrere in Deutschland, welche auch auf Tickets in deutscher Sprache antworten können. Bei Bedarf und gegen Aufpreis ist es möglich, einen oder mehrere designierte Support-Ingenieure zu bekommen.

• Welche Anforderungen haben sie an Infrastrukturbetrieb?

Da GitHub als Virtual Appliance geliefert wird und sämtliche Komponenten vorkonfiguriert mit sich bringt, sowie keine externen Abhängigkeiten zu Datenbanken oder anderen Diensten hat, schätzen wir den Administrationsaufwand auf 0,15 FTE pro Monat pro 2000 Nutzern ein. Updates können innerhalb weniger Minuten eingespielt werden, Disaster Recovery und High Availability sind ebenfalls je in unter einer Stunde konfiguriert. Weiterhin steht Ihnen jederzeit unser technischer Support, welcher aus hochspezialisierten Ingenieuren in Ihrer Zeitzone besteht, zur Verfügung.

Fachliche Aspekte

• Wie funktionieren Pre- und Post-Commit Reviews?

Im Gegensatz zu Subversion wurde Git mit der Hauptanforderung designed, Branching und Merging so einfach wie möglich zu machen sowie eine verteilte Arbeitsweise zu ermöglichen. Da Git-Commits bereits im lokalen Git-Repository des Entwicklers auf seinem Rechner entstehen, gehen alle etablierten Git-Review-Prozesse rein technisch gesehen von einem Post-Commit-Review aus. Der Code-Review geschieht jedoch bevor der entsprechende Commit in einen stabilen Branch auf dem Server einfließt / gemerged wird. Der dafür vorgesehene Prozess, welchen GitHub etabliert hat, wird GitHub Flow genannt. GitHub Flow ermöglicht sowohl Code-Reviews als auch High-Level Diskussion mit verschiedenen Projekt-Teams. Zusätzlich werden die Test-Resultate von CI-Systemen und anderen integrierten Werkzeugen angezeigt und können die Mergebarkeit der vorgeschlagenen Änderungen beeinflussen.

Eine ausführliche Überblick über die verschiedenen Review-Workflows und Clients, die mit GitHub möglich sind, finden Sie in diesem Video.

Gerne beantworten wir Ihre spezifischen Review- und Workflow-Fragen auch mit einer Demo vor Ort.

• Wie stellt sich die Kopplung von Reviews und Jira-Ticket dar?

Zwischen GitHub und Atlassian besteht in mehreren Bereichen eine Partnerschaft. So wurde Git LFS gemeinsam von beiden Unternehmen designed, implementiert und weiterhin vorangetrieben. Weiterhin besteht eine Jira-Integration zu GitHub. Diese ermöglicht es

• Von Jira aus alle mit Jira-Issues assoziierten GitHub-Branches und Reviews (Pull-Requests) sowie deren Status, Kommentare und Diskussionsteilnehmer zu sehen.

• Von GitHub aus, Commits und Reviews (Pull-Requests) mit Jira-Tickets zu verknüpfen sowie den Status, Kommentare und Zeiterfassung von Jira-Tickets zu verändern

• Zusätzlich gibt es ein kostenfreies Chrome-Plugin Jirafy welches es ermöglicht, sämtlichen Jira-Referenzen in GitHub-Reviews, Commits, Dokumentation, Releases und Wikis zu folgen

Alle drei Punkte zusammen führen zu einer bidirektionalen Integration der beiden Systeme ineinander. Für einen Überblick über die Funktionalitäten und die Konfiguration der Jira-Integration, steht Ihnen dieses Video zur Verfügung.

• Wie kann aus externen Tools auf Reviewergebnisse zugegriffen werden? (REST)

Sämtliche Daten innerhalb der GitHub-Plattform stehen Ihnen über unsere REST- und GraphQL-API zur Verfügung. Alle Informationen über Code-Reviews (Pull-Requests) finden Sie über diesen REST-Endpoint. Da GitHub Enterprise und GitHub.com die selbe Code-Basis teilen, sind auch die APIs identisch.

• Wie sieht die Integration von Artifactory und Git per git-lfs aus?

Git LFS wurde gemeinsam von GitHub und Atlassian konzipiert und ist sowohl in GitHub’s Benutzeroberfläche als auch in GitHub’s Desktop Client voll integriert. Für mehr Nutzerinformationen empfehlen wir dieses Video.

GitHub Enterprise erlaubt es, beliebig viele und beliebig große Git LFS-Dateien zur verwalten. Git LFS kann individuell pro Repository sowie auf Instanz- oder Organisationsebene konfiguriert werden. Bei Bedarf kann auch ein Drittanbieter wie Artifactory zur Speicherung von großen Binärdateien konfiguriert werden. Bei der Benutzung von Artefakt-Repositories ist es weiterhin möglich, die darin enthaltenen Komponenten einer Lizenz- und Sicherheitsprüfung zu unterziehen sowie das Resultat in den Pull-Request zurückzumelden, weitere Informationen finden Sie hier.

Infrastruktur

• Hochverfügbarkeit

Hochverfügbarkeit ist Teil der Standardkonfiguration von GitHub Enterprise. Durch unseren Virtual Appliance-Ansatz sind sämtliche Bestandteile einer High-Availability-Lösung innerhalb weniger Minuten konfigurierbar. Das Datenreplikationsprotokoll ist spezifisch auf die zu synchronisierten Daten optimiert (transaktional), es erfordert keine weiteren Infrastruktur-Abhängigkeiten (wie NFS oder zentrale Datenbankinstanzen).

Die Warm-Standby-Instanz, welche bei einem DNS- oder Loadbalancer-Failover genutzt wird, sollte bevorzugt in einer anderen Availability Zone stehen, jedoch idealerweise keine höhere Latenz als 1 ms zum Primär-Datenzentrum aufweisen.

• Wo liegen im Cloud-Ansatz die Daten des Repos?

GitHub Enterprise speichert die Daten auf einem Volume, welches in den Hypervisor gemounted wurde. Demzufolge können alle Sicherheits- und Verschlüsselungsoptionen des Hypervisors genutzt werden.

Neben dem Betrieb von GitHub Enterprise innerhalb Ihrer eigenen IT-Infrastruktur unterstützen wir ebenfalls die Private Clouds von Amazon (AWS) und Microsoft (Azure).

Empfehlung: Latenz < 1 ms, 40 GBit/s für angeschlossene Volumes

• Wie sieht ein Backup-Konzept aus?

Backup ist ein integraler Bestandteil unserer Lösung und kann innerhalb weniger Minuten konfiguriert werden, da alle notwendigen Programme mitgeliefert werden und durch unseren standardisierten Virtual-Appliance-Ansatz keine unnötige Komplexität entsteht. Backups können sowohl inkrementell als vollständig gemacht werden, unsere Ratschläge für ein optimales Backup-Intervall und das Sizing der Backup-Maschine finden Sie hier.

• Welche API's hat Github Enterprise (lesen/schreiben)?

GitHub stellt eine große Auswahl an REST APIs zur Erlangung von Repository-Metadaten, Repository-Inhalten, sowie Repository-Aktivität, Issues, Pull requests, Reactions und administrative Tätigkeiten zur Verfügung. Diese REST APIs können mit beliebigen Programmiersprachen angesprochen werden. Eine Auswahl von SDKs ist unter https://github.com/octokit zu finden. Falls Ihre Programmiersprache nicht im Octokit enthalten ist, besteht eine große Chance, ein alternatives SDK auf GitHub zu finden. Für Java-Programmierer bietet sich beispielsweise http://github-api.kohsuke.org an. Wenn Sie mehrere Datenquellen mit einem API-Aufruf verbinden möchten beziehungsweise eine Aggregation auf GitHub-Serverseite vornehmen wollen, so steht Ihnen auch unsere GraphQL API zur Verfügung.

• Welche Hardware/Server Anforderungen haben sie?

GitHub Enterprise wird als Virtual Appliance zur Verfügung gestellt, die auf AWS, Azure sowie VMWare, OpenStack KVM, Hyper-V, XenServer gehostet werden kann. Sämtliche Bestandteile unserer Plattform sind innerhalb der virtuellen Maschine realisiert, es gibt keine externen Abhängigkeiten (außer über den Hypervisor angeschlossene Volumes).

Eine einzelne virtuelle Maschine kann mit den Standardeinstellungen bis zu 5000 Nutzer unterstützen (solange CI-Systeme über web hooks angeschlossen sind und adäquate Hardware benutzt wird). Eine Übersicht der Hardware Anforderungen je nach verwendetem Hypervisor/Cloud Provider finden Sie hier.

Über 5000 Nutzer hinaus unterstützt GitHub Enterprise Clustering für alle Systemkomponenten (Git, Web interface, pages, search). Clustering ist mit den Standardlizenzkosten bereits abgegolten und kann dann konfiguriert werden, wenn die tatsächliche Notwendigkeit entsteht (keine Vorabplanung bei der initialen Installation nötig).

Integration in Unternehmens-Infrastruktur

• Wie erfolgt die Qualitätssicherung neuer Releases im Unternehmensumfeld beim Kunden?

Bevor ein neues Software-Release von GitHub Enterprise beim Kunden landet, hat es bereits drei Monate Tests durch über 50 Millionen-Softwareentwickler pro Monat hinter sich. Neben dieser Feuerprobe nutzt GitHub modernste Software-Entwicklungspraktiken inklusive Unit-Testing, Regressions-Testing, Security-Testing und Performance-Testing für jede einzelne Änderung (wir haben 500 Deployments pro Woche auf GitHub.com). Weiterhin gibt unser technischer Support sämtliche Fehler-Reports unserer Kunden unverzüglich an unser Engineering-Team weiter, welches diese zunächst auf GitHub.com und dann in der nächsten GitHub Enterprise-Version (spätestens drei Monate später, bei kritischen Problemen gibt es ein zeitnahes Patch-Release) behebt.

• Wie geht man damit um, wenn sich auch Schnittstellen (Bsp.: Jira, Jenkins) ändern?

Mit über 50 Millionen Software-Entwicklern, die GitHub monatlich nutzen, ist unsere Plattform typischerweise die Referenzimplementierung für Integrationen mit anderen Teilen der Software-Wertschöpfungskette. In der Vergangenheit konnten wir beobachten, dass wann immer Jira und Jenkins ihre APIs geändert hatten, am selben Tag die Integrationen zu GitHub (von Cloudbees und Atlassian geschrieben) ebenfalls angepasst worden. Unsere eigenen Programmierschnittstellen werden niemals abrupt geändert, sondern über einen definierten Prozess von Preview zu Official zu Deprecated verändert, so dass andere Hersteller und unsere Kunden sehr viel Zeit haben, ihre Integrationen anzupassen.

• Wie integriert sie Github in SSO Lösungen von Unternehmen (LDAP, Siteminder, NTLM)

GitHub Enterprise unterstützt SAML (Siteminder), CAS und LDAP als Identitätsprovider. Für eine LDAP-Synch-Schritt- für-Schritt-Anleitung, folgen Sie diesem Video. Zusätzlich steht eine Synchronisation zwischen LDAP-Zweigen und GitHub-Teammitgliedschaften zur Verfügung.

GitHub Actions und GitHub Package Registry

• Was ist GitHub Actions/ GitHub Package Registry?

GitHub Actions ist GitHubs Platform um CI/CD Aufgaben, wie das Bauen von Code oder das automatisierte Testen von Komponenten, auf GitHub abzubilden. GitHub Actions nutzt hierfür Pipelines, welche durch ein YAML-File definiert werden. Diese Pipelines bestehen aus sogenannten Actions, welche die einzelnen Schritte der Pipeline darstellen. Eine Action basiert entweder auf JavaScript Code oder einer Dockerfile und liegt in einem eigenen Repository auf GitHub. Es gibt nicht nur Actions von GitHub, sondern auch ein wachsenden Ökosystem aus Actions von anderen Anbietern (etwa Cloud-Platformen wie AWS oder Azure oder Dev-Tool-Herstellern wie Atlassian). Eine Actions Pipeline kann auf mehr als 40 Events von GitHub reagieren (wie einem Push oder Pull Request) und kann auch extern durch die API getriggered werden. Aus diesen Gründen eignet sich GitHub Actions auch für weitere Automatisierungsvorhaben auf GitHub (etwa die Moderation von Issues oder für Triage Prozesse). Auch kann man eigene Actions erstellen und diese wiederum innerhalb der Firma oder mit anderen GitHub Nutzern teilen.

GitHub Package Registry ist ein in GitHub integrierter Artefakt Storage. Dieser kann aktuell NPM, Nugget, Ruby Gem, Maven, Gradle und Docker Images speichern. Die Package Registry kann sowohl für öffentliche als auch private Projekte verwendet werden und auch direkt aus GitHub Actions als Artefakt Storage verwendet werden. Auch kann Sie in andere Anwendungen eingebunden werden. Vom Funktionsumfang ist die Package Registry aber aktuell nicht mit einem Produkt wie Artifactory vergleichbar.

• Sind GitHub Actions/ GitHub Package Registry für GitHub Enterprise verfügbar?

Aktuell sind beide Produkte für GitHub Enterprise Cloud und Github.com verfügbar. Wir planen später in 2020 die Integration in GitHub Enterprise Server.

• Kann ich Jenkinsfiles mit GitHub Actions wiederverwenden?

Es gibt die Möglichkeit eine Action zu nutzen, welche Jenkinsfiles erkennt und diese mittels eines Jenkins Single Shot Master innerhalb von GitHub Actions als Docker Container ausführt. Die Jenkins-Pipeline wird dabei innerhalb von Actions ausgeführt. Logs als auch Artefakte können hierbei von Actions abgegriffen und weiterverwendet werden. Dieser Ansatz ermöglicht die Wiederverwendung des bestehenden Jenkins Wissen. SAP nutzt dies bereits für sein Cloud SDK.

• Kann ich für GitHub Actions auch meine eigenen Agents verwenden?

GitHub Actions unterstützt sogenannte 'selfhosted runner', welche auf eigener Infrastruktur betrieben werden können. Dabei kann der Runner auf Linux, Mac und Windows betrieben werden und läuft sogar auf einem Raspberry Pi. Der Runner benötigt hierbei eine unterstützte Platform und muss über HTTPS mit GitHub kommunizieren können. Der Runner verbindet sich mit GitHub, führt neue Jobs lokal aus und sendet sowohl die Logs als auch Artefakte wieder an GitHub. Auch kann ein Runner hinter einem Proxy betrieben werden. Die Runner sind zudem ein Open Source Projekt auf GitHub.

• Welche Software befindet sich auf den von GitHub angebotenen Agenten.

Die GitHub Actions Dokumentation führt eine Liste über die verwendete Hardware als auch Software auf. Sie können auch eigene Tools installieren während der Ausführung einer Actions Pipeline. Auch gibt es die Möglichkeit weitere Tools vorzuschlagen, die Teil der Umgebung des Agent werden sollen.

• Wieviel kostet GitHub Actions/ GitHub Package Registry?

GitHub Actions und GitHub Package Registry sind umsonst für öffentliche Projekte. Bei privaten und internen Projekten bieten beide Projekte jeweils ein kostenloses Nutzungskontingent an. Darüber hinausgehende Nutzung wird wie bei anderen Cloud Lösungen verbrauchsbasiert abgerechnet (pay as you go).