From 30be7ff821dba43e75f86711b39b06decfed41af Mon Sep 17 00:00:00 2001 From: Chri$ Date: Fri, 12 Jun 2026 17:55:04 +0200 Subject: [PATCH] final final fixes + umschreibungen --- DMS_paper15_gitlab.tex | 140 +++++++++++++++++++---------------- diagrams/omnibus_arch.tex | 1 + diagrams/pipeline_stages.tex | 2 +- 3 files changed, 77 insertions(+), 66 deletions(-) diff --git a/DMS_paper15_gitlab.tex b/DMS_paper15_gitlab.tex index 0c69d68..e029c70 100644 --- a/DMS_paper15_gitlab.tex +++ b/DMS_paper15_gitlab.tex @@ -16,6 +16,7 @@ \usepackage{graphicx} \usepackage{acronym} \usepackage{hyperref} +\usepackage{xurl} \usepackage{amsmath} \usepackage{xcolor} @@ -72,6 +73,14 @@ } \addbibresource{literatur/dms.bib} +% Abstract-Titel auf "Abstract" setzen (nach babel, sonst überschreibt ngerman es) +\AtBeginDocument{\renewcommand{\abstractname}{Abstract}} +% Lange URLs in der Bibliografie umbrechen, auch im howpublished-Feld +\setcounter{biburlnumpenalty}{100} +\setcounter{biburlucpenalty}{100} +\setcounter{biburllcpenalty}{100} +\DeclareFieldFormat{howpublished}{\begingroup\urlstyle{same}\url{#1}\endgroup} + \renewcommand\familydefault{\sfdefault} % Helvetica \begin{document} @@ -87,12 +96,11 @@ \begin{abstract} \authornote{Christopher Schmitt} - GitLab vereint Versionsverwaltung, \ac{CI}/\ac{CD} und Projektorganisation in einer Plattform. Betreiben lässt es sich als gehosteter Dienst oder auf eigener Infrastruktur. Diese Arbeit untersucht GitLab als DevOps-Plattform mit Schwerpunkt auf der \ac{CI}/\ac{CD}-Pipeline und der selbstgehosteten Variante. Erklärt werden die zentralen Bausteine \emph{Runner}, \emph{Pipeline} und \emph{Job}. Danach folgt ein Anwendungsbeispiel mit einer Demo-Pipeline, die im Container \texttt{node:20-alpine} die Stages \texttt{lint}, \texttt{test} und \texttt{deploy} durchläuft. Für die selbstgehostete Lösung wurde GitLab \ac{CE} in Version 18.11 über das Omnibus-Paket auf einem Linux-Server installiert, über \texttt{gitlab.rb} konfiguriert und mit \texttt{gitlab-ctl} betrieben. Den grösseren Teil der Einrichtung erledigte die Weboberfläche, ohne dass viel an der Kommandozeile nötig war. In der Evaluierung wurde die Demo-Pipeline auf der eigenen Instanz vermessen. Die eigentliche Prüfung liegt je Job unter einer Sekunde. Den Rest verbrauchen Container-Start, Klonen und das Installieren der Abhängigkeiten. Ein unwirksamer Cache liess sich entfernen und sparte rund drei Sekunden je Job. + GitLab vereint Versionsverwaltung, \ac{CI}/\ac{CD} und Projektorganisation in einer Plattform. Betreiben lässt es sich als gehosteter Dienst oder auf eigener Infrastruktur. Diese Arbeit untersucht GitLab als DevOps-Plattform mit Schwerpunkt auf der \ac{CI}/\ac{CD}-Pipeline und der selbstgehosteten Variante. Erklärt werden die zentralen Bausteine \emph{Runner}, \emph{Pipeline} und \emph{Job}. Danach folgt ein Anwendungsbeispiel mit einer Demo-Pipeline, die im Container \texttt{node:20-alpine} die Stages \texttt{lint}, \texttt{test} und \texttt{deploy} durchläuft. Für die selbstgehostete Lösung wurde GitLab \ac{CE} in Version 18.11 über das Omnibus-Paket auf einem Linux-Server installiert, über \texttt{gitlab.rb} konfiguriert und mit \texttt{gitlab-ctl} betrieben. Den größeren Teil der Einrichtung erledigte die Weboberfläche, ohne dass viel an der Kommandozeile nötig war. In der Evaluierung wurde die Demo-Pipeline auf der eigenen Instanz vermessen. Die eigentliche Prüfung liegt je Job unter einer Sekunde. Den Rest verbrauchen Containerstart, Klonen und das Installieren der Abhängigkeiten. Ein unwirksamer Cache ließ sich entfernen und sparte rund drei Sekunden je Job. \end{abstract} - - - - + + \clearpage + \begin{multicols}{2} \tableofcontents @@ -209,17 +217,17 @@ \section{CI/CD} \authornote{Christopher Schmitt} - \ac{CI}, \ac{CD} und Continuous Deployment bauen aufeinander auf, werden in der Literatur aber oft vermischt. \ac{CI} bezeichnet das automatische Übersetzen und Testen jeder Codeänderung gegen den gemeinsamen Hauptzweig. \ac{CD} steht in dieser Arbeit für Continuous Delivery. Jeder geprüfte Stand lässt sich damit jederzeit in eine produktionsnahe Umgebung ausliefern, der eigentliche Sprung in die Produktion bleibt aber eine bewusste, manuelle Freigabe. Continuous Deployment geht einen Schritt weiter und automatisiert auch diese Freigabe. Die Abkürzung CD wird dabei für beide letztgenannten Stufen verwendet, was regelmässig zu Verwechslungen führt \cite{shahin_continuous_2017}. Alle drei Stufen bildet GitLab mit denselben Bausteinen ab: Runner, Pipelines und Jobs. Gesteuert werden sie über eine einzige Konfigurationsdatei im Repository \cite{cowell_automating_2023}. + \textbf{\ac{CI}}, \textbf{\ac{CD}} und Continuous Deployment bauen aufeinander auf. In der Literatur werden sie aber oft vermischt. \ac{CI} bezeichnet das automatische Übersetzen und Testen jeder Codeänderung gegen den gemeinsamen Hauptzweig. \ac{CD} steht in dieser Arbeit für Continuous Delivery. Jeder geprüfte Stand lässt sich damit jederzeit in eine produktionsnahe Umgebung ausliefern, der eigentliche Sprung in die Produktion bleibt aber eine bewusste, manuelle Freigabe. Continuous Deployment geht einen Schritt weiter und automatisiert auch diese Freigabe. Die Abkürzung CD wird dabei für beide letztgenannten Stufen verwendet, was regelmäßig zu Verwechslungen führt \cite{shahin_continuous_2017}. Alle drei Stufen bildet GitLab mit denselben Bausteinen ab: Runner, Pipelines und Jobs. Gesteuert werden sie über eine einzige Konfigurationsdatei im Repository \cite{cowell_automating_2023}. \subsection{GitLab Runner} - Die GitLab-Instanz führt \ac{CI}/\ac{CD}-Jobs nicht selbst aus. Das erledigt ein separater Prozess, der \emph{Runner} \cite{gitlab_gitlab_nodate}. Ein Runner registriert sich einmal mit einem Token bei der Instanz und holt sich danach selbständig offene Aufgaben ab. Diese Trennung erlaubt es, mehrere Runner parallel zu betreiben. Plattformabhängige Aufgaben laufen so auf der passenden Hardware \cite{painter_practical_2024}. Runner können auf drei unterschiedlichen Ebenen registriert werden: + Die GitLab-Instanz führt die \ac{CI}/\ac{CD}-Jobs nicht selbst aus. Das Ausführen übernimmt ein separater Prozess, der \emph{Runner} genannt wird \cite{gitlab_gitlab_nodate}. Runner werden einmal registriert, dies geschieht mittels eines Tokens, den die GitLab-Instanz selbst ausstellt. Danach holt der Runner sich selbständig offene Aufgaben zum Abarbeiten. Durch diese Trennung können mehrere Runner parallel an verschiedenen Aufgaben arbeiten. Plattformabhängige Aufgaben lassen sich so gezielt auf Runner mit passender Hardware verteilen und dort ausführen \cite{painter_practical_2024}. Runner können auf drei verschiedenen Ebenen registriert werden: \begin{itemize} - \item \textbf{Instanz} Auf Instanzebene registrierte Runner stehen allen Projekten der GitLab-Instanz zur Verfügung. Sie werden in der Regel von der Administration bereitgestellt. - \item \textbf{Gruppe} Auf Gruppenebene registrierte Runner nehmen Aufgaben aus sämtlichen Projekten innerhalb dieser Gruppe und ihrer Subgruppen an. Eingesetzt werden sie meistens dann, wenn eine Gruppe besondere Anforderungen an Hardware oder Software stellt. - \item \textbf{Projekt} Auf Projektebene registrierte Runner sind ausschliesslich an ein einzelnes Projekt gebunden. Diese Variante eignet sich für sensitive Projekte, bei denen kein gemeinsam genutzter Runner verwendet werden soll. + \item \textbf{Instanz} Runner, die auf der Instanzebene registriert werden, sind für alle Projekte des GitLab-Servers verfügbar. Diese werden meistens von der Administration erstellt und gewartet. + \item \textbf{Gruppe} Runner, die auf Gruppenebene registriert sind, nehmen nur Aufgaben aus Projekten innerhalb dieser Gruppe und ihrer Subgruppen an. Sie werden meistens dann eingesetzt, wenn die Gruppe besondere Anforderungen an Hardware oder Software stellt. + \item \textbf{Projekt} Runner, die auf Projektebene registriert werden, sind an ein einzelnes Projekt gebunden. Für sensitive Projekte eignet sich diese Variante besonders, wenn gezielt kein gemeinsamer Runner verwendet werden soll. \end{itemize} - Wie ein Runner eine konkrete Aufgabe ausführt, hängt vom konfigurierten \emph{Executor} ab. Er entscheidet, in welcher Umgebung das hinterlegte Skript läuft. Tabelle~\ref{tab:executors} listet die in der Praxis am häufigsten verwendeten Executors auf. + Der konfigurierte \emph{Executor} gibt an, wie ein Runner eine konkrete Aufgabe ausführen soll. Dieser entscheidet, in welcher Umgebung das Skript letztendlich läuft. Tabelle~\ref{tab:executors} listet die in der Praxis am häufigsten verwendeten Executors auf. \begin{table}[H] \centering \caption{Häufig verwendete Executors des GitLab Runners \cite{gitlab_gitlab_nodate}} @@ -231,22 +239,22 @@ \texttt{shell} & direkt auf dem Hostsystem & einfache Setups, Eigenbau-Server \\ \texttt{docker} & je Aufgabe ein neuer Container & in der Praxis der Standardfall \\ \texttt{docker-machine} & kurzlebige Cloud-VMs & elastische Skalierung \\ - \texttt{kubernetes} & ein Pod je Aufgabe & grosse Cluster, Autoskalierung \\ + \texttt{kubernetes} & ein Pod je Aufgabe & große Cluster, Autoskalierung \\ \texttt{ssh} & entfernter Host über SSH & Legacy-Systeme \\ \bottomrule \end{tabular}% } \end{table} - Die Wahl des Executors ist auch eine Sicherheitsfrage. Der \texttt{shell}-Executor ist am schnellsten eingerichtet, kapselt die Jobs aber nicht voneinander ab. In der Produktion wird er deshalb meist durch \texttt{docker} oder \texttt{kubernetes} ersetzt \cite{rostami_usage_2023}. Kritisch wird es, wenn mehrere Projekte denselben \texttt{shell}-Runner teilen und ein Job das Hostsystem dauerhaft verändert. Diese Änderung wirkt dann auf alle folgenden Jobs. + Die Wahl des Executors ist auch eine Sicherheitsfrage, weil sie die Ausführungsumgebung festlegt. Der \texttt{shell}-Executor ist am schnellsten eingerichtet, führt die Jobs aber direkt auf dem Hostsystem aus. Dadurch sind die Jobs nicht voneinander getrennt, sie teilen sich dasselbe Dateisystem und dieselben installierten Programme. In der Produktion wird der \texttt{shell}-Executor deshalb meist durch den \texttt{docker}- oder \texttt{kubernetes}-Executor ersetzt \cite{rostami_usage_2023}. Diese geben jedem Job eine eigene, abgekapselte Umgebung ohne vollen Zugriff auf das Hostsystem. Problematisch wird es, wenn mehrere Projekte denselben \texttt{shell}-Runner verwenden und ein Job das Hostsystem dauerhaft verändert, etwa durch das Ändern einer Softwareversion. Diese Änderung wirkt sich dann auf alle nachfolgenden Jobs aus. \subsection{Pipelines} - Eine \emph{Pipeline} ist in GitLab die oberste Ebene der Automatisierung. Sie umfasst sämtliche Schritte, die als Reaktion auf ein Ereignis im Repository ablaufen \cite{gitlab_gitlab_nodate}. Ausgelöst wird sie durch verschiedene Ereignisse. Ein Push oder das Öffnen eines \emph{Merge Requests} startet sie, ebenso ein hinterlegter Zeitplan oder ein manueller Klick in der Weboberfläche \cite{cowell_automating_2023}. Auch das Ende einer anderen Pipeline kann der Auslöser sein. + Eine \emph{Pipeline} ist in GitLab die höchste Ebene der Automatisierung. In einer Pipeline werden vordefinierte Aufgaben abgearbeitet, die bei einem Ereignis automatisch starten \cite{gitlab_gitlab_nodate}. Sie wird durch verschiedene definierte Ereignisse gestartet. Auslöser kann ein Push sein, das Öffnen eines \emph{Merge Requests}, ein vordefinierter Zeitplan oder ein Klick in der Weboberfläche \cite{cowell_automating_2023}. Auch das Ende einer anderen Pipeline kann als Auslöser dienen. - Innerhalb einer Pipeline werden die einzelnen Arbeitsschritte zu sogenannten \emph{Stages} zusammengefasst. Alle Schritte einer Stage laufen parallel und müssen erfolgreich abgeschlossen sein, bevor die nächste Stage beginnt \cite{gitlab_gitlab_nodate}. Eine typische Reihenfolge der Stages ist \texttt{lint}, \texttt{test}, \texttt{build} und \texttt{deploy}. In \texttt{lint} prüfen statische Werkzeuge den Code auf Stil und offensichtliche Fehler, danach führt \texttt{test} die automatischen Tests aus. In \texttt{build} wird die Anwendung paketiert, etwa zu einem Container-Image. \texttt{deploy} bringt das Ergebnis in eine Zielumgebung. Abbildung~\ref{fig:pipeline-stages} zeigt das Verhältnis von Pipeline, Stages und Jobs. + In einer Pipeline werden einzelne Arbeitsschritte zu sogenannten \emph{Stages} zusammengefasst. Innerhalb von Stages laufen Aufgaben parallel zueinander und müssen erfolgreich abgeschlossen sein, damit die nächste Stage beginnen kann \cite{gitlab_gitlab_nodate}. Eine typische Reihenfolge der Stages ist etwa \texttt{lint}, \texttt{test}, \texttt{build} und \texttt{deploy}. In \texttt{lint} prüfen statische Werkzeuge den Quellcode auf Stil, Formatierung und offensichtliche Fehler. Nach der \texttt{lint}-Stage führt die \texttt{test}-Stage die automatischen Tests aus. Anschließend baut \texttt{build} die Anwendung, etwa zu einem Container-Image. \texttt{deploy} bringt die fertige Anwendung dann auf das Zielsystem und startet sie. Abbildung~\ref{fig:pipeline-stages} zeigt das Verhältnis von Pipeline, Stages und Jobs. \input{diagrams/pipeline_stages} - Die gesamte Definition einer Pipeline liegt in einer einzigen Datei. Diese trägt den Namen \texttt{.gitlab-ci.yml} und befindet sich im Wurzelverzeichnis des Repositories \cite{gitlab_gitlab_nodate}. Damit folgt GitLab dem von Humble und Farley~\cite{humble_continuous_2010} eingeführten \emph{Pipeline-as-Code}-Prinzip. Die Beschreibung des Build- und Auslieferungsprozesses wird wie Anwendungscode versioniert und im Review geprüft. Listing~\ref{lst:gitlabciyml} zeigt einen minimalen Aufbau mit drei Stages. + Die gesamte Definition einer Pipeline liegt in einer einzigen Datei. Diese Datei muss \texttt{.gitlab-ci.yml} heißen und befindet sich im Wurzelverzeichnis des Repositories \cite{gitlab_gitlab_nodate}. Dadurch folgt GitLab dem \emph{Pipeline-as-Code}-Prinzip, das von Humble und Farley eingeführt wurde \cite{humble_continuous_2010}. Die Beschreibung des Build- und Auslieferungsprozesses wird so wie Anwendungscode versioniert und im Review geprüft. Listing~\ref{lst:gitlabciyml} zeigt einen minimalen Aufbau mit drei Stages. \begin{lstlisting}[language=yaml,caption={Minimaler Aufbau einer .gitlab-ci.yml},label={lst:gitlabciyml}] stages: @@ -273,32 +281,32 @@ deploy-staging: - main \end{lstlisting} - Die starre Stage-Reihenfolge lässt sich mit dem Schlüsselwort \texttt{needs} aufbrechen. Daraus entsteht ein gerichteter Graph ohne Zyklen, ein sogenannter \ac{DAG}. Ohne Zyklen heisst, dass kein Job über Umwege wieder von sich selbst abhängt. Ein Job startet, sobald seine konkret benannten Vorgänger fertig sind \cite{cowell_automating_2023}. Er wartet nicht mehr auf die gesamte vorherige Stage, unnötige Wartezeiten entfallen. Wiederkehrende Pipeline-Bausteine lassen sich über das Schlüsselwort \texttt{include} aus anderen Repositories nachladen \cite{gitlab_gitlab_nodate}. + Die starre Stage-Reihenfolge lässt sich mit dem Schlüsselwort \texttt{needs} aufbrechen. Durch \texttt{needs} entsteht ein gerichteter Graph ohne Zyklen, ein sogenannter \ac{DAG}. Ohne Zyklen heißt, dass kein Job direkt oder über Umwege wieder von sich selbst abhängt. Wenn die definierten Vorgänger eines Jobs fertig sind, startet dieser automatisch und wartet nicht auf die gesamte vorherige Stage \cite{cowell_automating_2023}. Dadurch entfallen unnötige Wartezeiten, und unabhängige Jobs können bei mehreren verfügbaren Runnern parallel laufen. Wiederkehrende Pipeline-Bausteine, die an mehreren Stellen gebraucht werden, lassen sich über \texttt{include} aus anderen Repositories nachladen \cite{gitlab_gitlab_nodate}. \subsection{Jobs} - Die eigentliche Arbeitseinheit innerhalb einer Pipeline ist der \emph{Job}. Ein Job führt ein vom Anwender festgelegtes Skript in einer isolierten Umgebung aus und ist genau einer Stage zugeordnet \cite{gitlab_gitlab_nodate}. Jobs derselben Stage sind voneinander unabhängig. Sie laufen parallel auf den verfügbaren Runnern. Ob die Pipeline weiterläuft, hängt vom Ergebnis sämtlicher Jobs einer Stage ab. + Eine Pipeline besteht aus \emph{Jobs}, die abgearbeitet werden. Jobs werden vom Anwender über ein Skript festgelegt, das in der Regel in einer isolierten Umgebung ausgeführt wird \cite{gitlab_gitlab_nodate}. Jeder Job ist genau einer Stage zugeordnet. Jobs derselben Stage laufen unabhängig voneinander und bei mehreren verfügbaren Runnern sogar parallel. Ob die Pipeline weiterläuft, hängt vom Ergebnis aller Jobs einer Stage ab. - Mit dem Schlüsselwort \texttt{rules} wird pro Job festgelegt, unter welchen Bedingungen dieser ausgeführt wird. Beispiele sind die Beschränkung auf bestimmte Branches, die Ausführung nur bei Änderungen an bestimmten Dateien oder die Abhängigkeit vom Ergebnis vorheriger Jobs \cite{cowell_automating_2023}. Ein als \texttt{manual} markierter Job läuft erst nach einer expliziten Freigabe über die Weboberfläche. Das wird für Auslieferungen in produktive Umgebungen genutzt. + Über \texttt{rules} wird festgelegt, unter welchen Bedingungen ein Job ausgeführt wird. Beispiele sind die Beschränkung eines Jobs auf einen bestimmten Branch, die Ausführung nur bei Änderungen an bestimmten Dateien oder die Abhängigkeit vom Ergebnis vorheriger Jobs \cite{cowell_automating_2023}. Ein als \texttt{manual} markierter Job wird erst gestartet, wenn ihn ein Nutzer über die Weboberfläche anstößt. Dieses Vorgehen wird für die Auslieferung von Anwendungen in Produktivumgebungen genutzt. - Ein Job erzeugt während seiner Ausführung oft Dateien, die spätere Jobs weiterverarbeiten. Beispiele sind ein gebautes Bundle, ein Container-Image oder ein Testbericht. GitLab unterscheidet dafür zwei Mechanismen mit unterschiedlicher Lebensdauer: + Manche Jobs erzeugen während ihrer Ausführung Dateien, die spätere Jobs weiterverarbeiten. Beispiele sind ein gebautes Bundle, ein Container-Image oder ein Testbericht. GitLab unterscheidet dafür zwei Mechanismen mit unterschiedlicher Lebensdauer: \begin{itemize} - \item \textbf{Artefakte} sind benannte Ergebnisse eines Jobs \cite{gitlab_gitlab_nodate}. Sie werden nach dem erfolgreichen Abschluss eines Jobs an die GitLab-Instanz hochgeladen, stehen dort zum Download bereit und werden an spätere Jobs der Pipeline weitergegeben. - \item \textbf{Caches} dienen ausschliesslich dazu, wiederholte Ausführungen zu beschleunigen. Typisch ist das Zwischenspeichern heruntergeladener Abhängigkeiten zwischen Pipeline-Läufen. Über Jobgrenzen hinweg ist der Cache nicht garantiert verfügbar. + \item \textbf{Artefakte} sind die benannten Dateien, die ein Job als Ergebnis festhält \cite{gitlab_gitlab_nodate}. Nach einem erfolgreichen Durchlauf werden sie an die GitLab-Instanz hochgeladen, stehen dort zum Download bereit und lassen sich an spätere Jobs der Pipeline weitergeben. + \item \textbf{Caches} dienen ausschließlich dazu, wiederholte Ausführungen zu beschleunigen. Häufig werden heruntergeladene Abhängigkeiten zwischengespeichert. Das spart Bandbreite und Zeit und umgeht die Rate Limits der Paketquellen. Ein Cache wird nicht automatisch angelegt, sondern im Job über \texttt{cache} mit Pfaden und einem Schlüssel definiert. Er liegt zudem meist lokal auf dem Runner, der ihn erzeugt hat. Holt sich ein späterer Job einen anderen Runner, ist der Cache dort nicht zwangsläufig vorhanden. GitLab behandelt ihn deshalb als Beschleunigung auf Best-Effort-Basis, nicht als verlässliche Datenquelle. \end{itemize} - Das Ziel einer Auslieferung beschreibt das Konzept der \emph{Environments} \cite{cowell_automating_2023}. Ein Environment fasst alle Auslieferungen in eine bestimmte Zielumgebung zusammen. In der Weboberfläche wird zusätzlich protokolliert, welche Version dort gerade läuft. Einen Sonderfall bilden \emph{Review-Apps}. Für jeden offenen Merge Request erzeugt GitLab automatisch eine isolierte, kurzlebige Auslieferung, in der die geänderte Anwendung vor dem Merge begutachtet werden kann \cite{gitlab_gitlab_nodate}. Nach Rostami Mazrae et al.~\cite{rostami_usage_2023} ist diese direkte Kopplung zwischen Review und laufender Vorschau eines der Merkmale, mit denen sich GitLab von alternativen Plattformen abgrenzt. + Ein \emph{Environment} benennt das Ziel einer Auslieferung \cite{cowell_automating_2023}. Ein Environment fasst alle Auslieferungen in eine bestimmte Zielumgebung zusammen. In der Weboberfläche wird zusätzlich protokolliert, welche Version dort gerade läuft. Einen Sonderfall bilden \emph{Review-Apps}. Für jeden offenen Merge Request erzeugt GitLab automatisch eine isolierte, kurzlebige Auslieferung, in der die geänderte Anwendung vor dem Merge begutachtet werden kann \cite{gitlab_gitlab_nodate}. Nach Rostami Mazrae et al.~\cite{rostami_usage_2023} ist diese direkte Kopplung zwischen Review und laufender Vorschau eines der Merkmale, mit denen sich GitLab von alternativen Plattformen abgrenzt. - Auch die Pipeline-Definition selbst kann schlecht gebaut sein. Zampetti et al.~\cite{zampetti_empirical_2020} sammeln typische Fehler aus realen CI-Konfigurationen. Zwei davon treten besonders oft auf. Stages laufen nacheinander, obwohl sie parallel könnten. Ausserdem werden Cache und Artefakte vermischt, sodass ein späterer Job auf Dateien zugreift, die nicht zuverlässig vorhanden sind. Die Pipeline schlägt dann unregelmässig fehl, je nachdem, ob die Datei gerade im Cache liegt. + Auch eine Pipeline kann schlecht aufgebaut sein. Zampetti et al.~\cite{zampetti_empirical_2020} haben typische Fehler aus realen CI-Konfigurationen analysiert. Zwei treten besonders oft auf. Einmal laufen Stages nacheinander, obwohl sie parallel laufen könnten. Zum anderen werden Cache und Artefakte vermischt, sodass ein späterer Job auf eine Datei zugreifen will, die aber nicht zuverlässig vorhanden ist. Die Pipeline schlägt dann unregelmäßig fehl, wenn die Datei gerade nicht im Cache liegt. - \subsection{CICD-Komponenten}\label{subsec:komponenten} + \subsection{CI/CD-Komponenten}\label{subsec:komponenten} - Mit dem Schlüsselwort \texttt{include} können bereits seit längerem ganze Pipeline-Fragmente aus anderen Repositories oder von einer entfernten \ac{URL} eingebunden werden \cite{gitlab_gitlab_nodate}. Zwei Probleme tauchen dabei immer wieder auf. Eingebundene Fragmente sind meist weder versioniert noch haben sie eine eigene Schnittstelle, und eine Änderung am Fragment schlägt sofort auf alle einbindenden Pipelines durch \cite{cowell_automating_2023}. + Über \texttt{include} lassen sich ganze Pipeline-Fragmente aus anderen Repositories oder von einer externen \acs{URL} einbinden \cite{gitlab_gitlab_nodate}. Dabei treten zwei Probleme häufig auf. Eingebundene Fragmente werden meist nicht versioniert und haben keine eigene Schnittstelle. Eine Änderung am Fragment schlägt deshalb sofort auf alle Pipelines durch, die es einbinden \cite{cowell_automating_2023}. - CI/CD-Komponenten lösen diese Probleme. Eingeführt wurden sie experimentell mit GitLab 16.0, allgemein verfügbar sind sie seit Version 17.0 \cite{gitlab_gitlab_nodate}. Eine Komponente ist ein versionierter und parametrisierbarer Pipeline-Baustein, der ähnlich wie eine Software-Bibliothek verwendet wird. Komponenten werden in einem eigenen Projekt entwickelt und veröffentlicht. Zu ihnen gehören: + Mit CI/CD-Komponenten lassen sich diese Probleme lösen. Eingeführt wurden sie experimentell in GitLab 16, allgemein verfügbar sind sie seit Version 17.0 \cite{gitlab_gitlab_nodate}. Eine Komponente ist ein versionierter und parametrisierbarer Baustein einer Pipeline. Komponenten werden in einem eigenen Projekt entwickelt, gespeichert und bereitgestellt. Zu ihnen gehören: \begin{itemize} - \item \textbf{Manifest} Eine Komponente beschreibt in einer YAML-Datei, meist \texttt{template.yml}, ihre Eingabeparameter mit Datentyp und Defaultwert sowie die Jobs, die sie beisteuert. - \item \textbf{Version} Komponenten werden über Git-Tags veröffentlicht. Das einbindende Projekt referenziert eine Komponente mit einer festen Version, wahlweise auch mit einem Branch oder einem Commit. Bei einer festen Version kann sich der eingebundene Stand nachträglich nicht mehr ändern. - \item \textbf{Katalog} Wird eine Komponente als Release veröffentlicht, erscheint sie im \emph{CI/CD Catalog} der GitLab-Instanz. Dort lassen sich Komponenten suchen und einbinden, ohne dass der genaue Repository-Pfad bekannt sein muss. + \item \textbf{Manifest} Jede Komponente besitzt eine Manifest-Datei, üblicherweise \texttt{template.yml}. Darin wird festgelegt, welche Eingabeparameter die Komponente annimmt, jeweils mit Datentyp und meist einem Defaultwert. Ebenso stehen dort die Jobs, die die Komponente zur Pipeline beisteuert. Das Manifest bildet damit die Schnittstelle der Komponente. Es beschreibt, was sich von außen einstellen lässt und was die Komponente an die Pipeline liefert. + \item \textbf{Version} Komponenten werden über Git-Tags veröffentlicht. Im einbindenden Projekt wird eine Komponente mit einer festen Version ausgewählt, wahlweise auch mit einem Branch oder einem Commit. Mit einer festen Version ist sichergestellt, dass sich der Stand der Komponente nachträglich nicht ändert und die Pipeline dadurch nicht unerwartet bricht. + \item \textbf{Katalog} Wird eine Komponente als Release veröffentlicht, erscheint sie automatisch im \emph{CI/CD Catalog} der GitLab-Instanz. Dort lassen sich Komponenten suchen und einem Projekt zuordnen, ohne dass der genaue Repository-Pfad bekannt sein muss. \end{itemize} Listing~\ref{lst:component} zeigt die Einbindung einer beispielhaften Lint-Komponente in eine bestehende Pipeline. @@ -314,15 +322,15 @@ stages: - test \end{lstlisting} - Anders als beim klassischen \texttt{include} hat die Komponente damit eine klar definierte Schnittstelle mit benannten Eingabeparametern. Die Werte setzt das einbindende Projekt im Block \texttt{inputs}. Innerhalb der Komponente stehen sie über die Schreibweise \texttt{\$[[ inputs. ]]} zur Verfügung \cite{gitlab_gitlab_nodate}. Der Aufruf in Listing~\ref{lst:component} verweist mit \texttt{\$CI\_SERVER\_FQDN} auf eine von GitLab vorgegebene Variable. Sie enthält den vollständigen Hostnamen der Instanz, den \ac{FQDN}, sodass der Pfad nicht fest verdrahtet werden muss. Nach Cowell et al. hält diese Trennung von Schnittstelle und Implementierung die Pipeline-Logik wartbar \cite{cowell_automating_2023}. Ein Fehler an einer Komponente lässt sich dann an einer Stelle beheben, statt in jeder einbindenden Pipeline. + Anders als beim klassischen \texttt{include} hat eine Komponente eine klar definierte Schnittstelle mit benannten Eingabeparametern. Die Werte setzt das einbindende Projekt im Block \texttt{inputs}. Innerhalb der Komponente stehen sie über die Schreibweise \texttt{\$[[ inputs. ]]} zur Verfügung \cite{gitlab_gitlab_nodate}. Der Aufruf in Listing~\ref{lst:component} greift mit \texttt{\$CI\_SERVER\_FQDN} auf eine von GitLab vorgegebene Variable zu. Sie enthält den vollständigen Hostnamen der Instanz, den \ac{FQDN}, sodass der Pfad nicht fest in der Datei stehen muss. Nach Cowell et al.~\cite{cowell_automating_2023} bleibt durch diese Trennung von Schnittstelle und Implementierung die Pipeline-Logik wartbar. Tritt in einer Komponente ein Fehler auf, wird er an einer Stelle behoben und nicht in jeder einbindenden Pipeline. \subsection{Anwendungsbeispiel} - Zur praktischen Demonstration der vorhergehenden Konzepte wurde eine kleine Webanwendung auf der in Abschnitt~\ref{sec:selfhosted} beschriebenen selbstgehosteten Instanz aufgesetzt. Die Anwendung bleibt klein, damit der Fokus auf der \ac{CI}/\ac{CD}-Konfiguration liegt und nicht auf dem Anwendungscode. + Für die praktische Demonstration der zuvor behandelten Konzepte wurde eine Webanwendung auf der in Abschnitt~\ref{sec:selfhosted} beschriebenen selbstgehosteten Instanz aufgesetzt. Die Anwendung ist bewusst klein gehalten. So liegt der Fokus auf der \ac{CI}/\ac{CD}-Konfiguration und nicht auf dem Anwendungscode. - Die Demoanwendung ist ein \texttt{HTTP}-Dienst, der in \emph{Node.js} mit dem Web-Framework \emph{Express} geschrieben ist. Bereitgestellt wird ein einzelner Endpunkt \texttt{GET /}, der eine kurze HTML-Seite mit der Bezeichnung der aktuellen Umgebung und der im Build verbauten Versionskennung ausliefert. Beide Werte werden zur Laufzeit über Umgebungsvariablen aus dem Container gelesen und im jeweiligen Deploy-Job gesetzt. Eine kleine Testsuite mit dem Framework \texttt{vitest} prüft, dass der Endpunkt eine HTML-Antwort mit Statuscode~200 und der erwarteten Versionskennung liefert. + Die Demo ist ein \texttt{HTTP}-Dienst, der in \emph{Node.js} mit dem Web-Framework \emph{Express} geschrieben wurde und einen einzelnen Endpunkt \texttt{GET /} bereitstellt. Dieser Endpunkt liefert eine kleine HTML-Seite mit der Bezeichnung der aktuellen Umgebung und der im Build verbauten Versionskennung. Beide Werte werden zur Laufzeit über Umgebungsvariablen aus dem Container gelesen und im jeweiligen Deploy-Job gesetzt. Eine kleine Testsuite mit dem Framework \texttt{vitest} prüft, ob der Endpunkt eine gültige HTML-Antwort mit Statuscode~200 liefert. Der Test prüft zudem, ob die Seite die ausgelieferte Versionskennung enthält. - Die zugehörige \texttt{.gitlab-ci.yml} definiert drei Stages: \texttt{lint}, \texttt{test} und \texttt{deploy}. Die Stage \texttt{deploy} enthält dabei zwei Jobs, die sich gegenseitig ausschliessen. Tabelle~\ref{tab:demo-pipeline} fasst zusammen, welcher Schritt unter welchen Bedingungen ausgeführt wird und welches Environment er bedient. + In der \texttt{.gitlab-ci.yml} sind drei Stages definiert: \texttt{lint}, \texttt{test} und \texttt{deploy}. Die Stage \texttt{deploy} enthält zwei Jobs, von denen pro Pipeline immer nur einer läuft. Welcher der beiden greift, hängt vom Branch ab. Tabelle~\ref{tab:demo-pipeline} fasst zusammen, welcher Schritt unter welchen Bedingungen ausgeführt wird und in welche Zielumgebung er ausliefert. \begin{table}[H] \centering \caption{Stages der Demo-Pipeline und ihre Auslöser} @@ -333,37 +341,37 @@ stages: Stage / Job & Auslöser & Ergebnis & Environment \\ \midrule \texttt{lint} & jeder Push & Stilbericht & -- \\ \texttt{unit-test} & jeder Push & Testbericht & -- \\ - \texttt{deploy:staging} & alle Branches ausser \texttt{main}, manuell & Container in Staging & \texttt{staging} \\ + \texttt{deploy:staging} & alle Branches außer \texttt{main}, manuell & Container in Staging & \texttt{staging} \\ \texttt{deploy:prod} & Push auf \texttt{main}, automatisch & Container in Produktion & \texttt{production} \\ \bottomrule \end{tabular}% } \end{table} - Die ersten beiden Stages werden bei jedem Push auf jeden Branch ausgeführt. Sie entsprechen den klassischen \ac{CI}-Schritten nach Duvall et al.~\cite{duvall_continuous_2007} und Fowler~\cite{fowler_continuous_2006}. Ihr Zweck ist ein schnelles, automatisches Feedback auf jeden Codestand. Die Stage \texttt{deploy} deckt den Continuous-Delivery-Anteil ab. Hier trennen sich zwei Pfade. Auf einem Feature-Branch steht der Job \texttt{deploy:staging} als manueller Schritt in der Pipeline-Übersicht bereit. Eine Änderung kann so bei Bedarf in einer laufenden Vorschau begutachtet werden, bevor sie in den Hauptzweig wandert. Ein Push auf \texttt{main} liefert automatisch nach \texttt{production} aus. Nach der Begriffsabgrenzung von Shahin et al.~\cite{shahin_continuous_2017} entspricht der Pfad nach \texttt{main} damit Continuous Deployment, der manuelle Pfad nach Staging klassischem Continuous Delivery. + Die ersten beiden Stages werden bei jedem Push auf jeden Branch automatisch gestartet. Sie entsprechen den klassischen \ac{CI}-Schritten nach Duvall et al.~\cite{duvall_continuous_2007} und Fowler~\cite{fowler_continuous_2006}. Ihr Zweck ist es, für jeden Codestand ein schnelles, automatisches Feedback zu liefern. Die Stage \texttt{deploy} deckt den Continuous-Delivery-Anteil ab. Hier trennen sich zwei Pfade. Auf einem Feature-Branch steht der Job \texttt{deploy:staging} als manueller Schritt bereit, der in der Pipeline-Übersicht sichtbar ist. So lässt sich eine Änderung bei Bedarf in einer laufenden Vorschau begutachten und testen, bevor sie in den Hauptzweig übernommen wird. Ein Push auf \texttt{main} baut die Anwendung automatisch und liefert sie nach \texttt{production} aus. Nach der Begriffsabgrenzung von Shahin et al.~\cite{shahin_continuous_2017} entspricht der automatische Pfad nach \texttt{main} damit Continuous Deployment, während der manuelle Pfad nach Staging dem klassischen Continuous Delivery entspricht. - Die Jobs laufen auf zwei verschiedenen Runnern. \texttt{lint} und \texttt{unit-test} nutzen einen Runner mit Docker-Executor und führen ihre Schritte im Container \texttt{node:20-alpine} aus. Über \texttt{tags} sind die Deploy-Jobs an einen zweiten Runner mit Shell-Executor gebunden. Sie bauen das Image mit \texttt{docker build} und starten es mit \texttt{docker run}. Dafür brauchen sie direkten Zugriff auf den Docker-Daemon des Zielhosts. So bleibt die Prüfung im isolierten Container, während die Auslieferung auf dem Host selbst arbeitet. + Diese Jobs laufen auf zwei verschiedenen Runnern. \texttt{lint} und \texttt{unit-test} nutzen einen gemeinsamen Runner mit Docker-Executor und führen ihre Schritte in einer Container-Umgebung mit \texttt{node:20-alpine} aus. Über \texttt{tags} sind die Deploy-Jobs an einen zweiten Runner mit Shell-Executor gebunden. Sie bauen das Image mit \texttt{docker build} und starten es anschließend mit \texttt{docker run}. Für diese Befehle braucht der Runner direkten Zugriff auf den Docker-Daemon des Hostsystems. Die Prüfung bleibt so in einem isolierten Container, während die Veröffentlichung selbst auf dem Hostsystem läuft. - Im Rahmen der Live-Präsentation wird der Lebenszyklus einer Codeänderung in drei Schritten gezeigt. Zunächst wird auf einem Feature-Branch eine sichtbare Änderung am Anwendungscode vorgenommen und in das Repository übertragen. Die Stages \texttt{lint} und \texttt{unit-test} laufen automatisch durch. Danach wird der Job \texttt{deploy:staging} über die Weboberfläche freigegeben. Die Änderung ist unmittelbar unter der Staging-Adresse sichtbar, ohne dass sie bereits im Hauptzweig liegt. Zuletzt folgt der Merge Request gegen \texttt{main}. Wird er akzeptiert, durchläuft eine neue Pipeline auf \texttt{main} erneut \texttt{lint} und \texttt{unit-test} und löst anschliessend automatisch \texttt{deploy:prod} aus. Die neue Version läuft damit ohne weiteren Eingriff in der Produktion. + Der Lebenszyklus einer Quellcodeänderung lässt sich mit dem Demo-Quellcode in drei Schritten nachvollziehen. Auf einem Feature-Branch entsteht eine sichtbare Änderung am Quellcode. Ein Commit überträgt sie in das Repository. Durch dieses Ereignis werden die Stages \texttt{lint} und \texttt{unit-test} automatisch ausgeführt und laufen im Hintergrund durch. Anschließend lässt sich der Job \texttt{deploy:staging} über die Weboberfläche starten. Bei erfolgreichem Ablauf ist die Version unter der Staging-Adresse aufrufbar, ohne dass die Änderung bereits im Hauptzweig liegt. Als letzter Schritt folgt der Merge Request gegen \texttt{main}, der von einem Nutzer manuell akzeptiert werden muss. Durch das Akzeptieren startet eine neue Pipeline auf \texttt{main} und beginnt erneut mit \texttt{lint} und \texttt{unit-test}. Danach löst sie automatisch \texttt{deploy:prod} aus, sodass die neueste Version ohne weiteren Eingriff auf dem Produktivsystem läuft. \section{Selbstgehostete Lösung}\label{sec:selfhosted} \authornote{Christopher Schmitt} - Neben dem Bezug als \ac{SaaS} lässt sich GitLab auch auf eigener Hardware selbst betreiben. Diese Variante wird von GitLab als \emph{Self-Managed} bezeichnet \cite{gitlab_gitlab_nodate}. Sie kommt hauptsächlich in zwei Fällen zum Einsatz. Entweder erlauben Datenschutz- oder Compliance-Vorgaben nicht, dass Quellcode auf fremden Servern liegt. Oder die \ac{SaaS}-Variante wird mit steigender Nutzerzahl zu teuer. Installation, Konfiguration, Aktualisierungen und Sicherungen müssen dafür allerdings selbst übernommen werden \cite{painter_practical_2024}. Im Folgenden wird beschrieben, wie eine solche Instanz im Rahmen dieser Arbeit auf einem privaten Linux-Server aufgesetzt wurde und welcher Aufwand dabei anfiel. + GitLab kann als \ac{SaaS} genutzt oder auf eigener Hardware selbst betrieben werden. Letzteres bezeichnet GitLab als \emph{Self-Managed} \cite{gitlab_gitlab_nodate}. Self-Managed-Instanzen sind dann interessant, wenn Datenschutz- oder Compliance-Vorgaben es verlangen, etwa wenn der Quellcode nicht auf fremden Servern liegen darf. Der zweite Fall ist der Kostenpunkt, denn bei steigender Nutzerzahl steigen auch die Kosten der \ac{SaaS}-Variante. Installation, Konfiguration, Aktualisierungen und Sicherungen müssen dafür allerdings selbst übernommen werden \cite{painter_practical_2024}. Im Folgenden wird beschrieben, wie eine solche Instanz im Rahmen dieses Papers auf einem privaten Linux-Server aufgesetzt wurde. Ein besonderes Augenmerk liegt dabei auf dem Aufwand für Einrichtung und Wartung. \subsection{Installation} - Für die selbstgehostete \ac{CE} bietet GitLab das sogenannte \emph{Omnibus-Paket} an \cite{painter_practical_2024}. Das Paket bündelt alle Komponenten, die GitLab im Betrieb braucht. Nach GitLab-Dokumentation \cite{gitlab_gitlab_nodate} zählen dazu der Webserver \texttt{nginx}, der Anwendungsserver \texttt{Puma}, die relationale Datenbank \texttt{PostgreSQL} und der Schlüssel-Wert-Speicher \texttt{Redis}. Weitere Hintergrundprozesse kommen hinzu. Abbildung~\ref{fig:omnibus-arch} zeigt das Zusammenspiel der einzelnen Bausteine. + Für die selbstgehostete Community Edition bietet GitLab das \emph{Omnibus-Paket} an \cite{painter_practical_2024}. Es bündelt alle Komponenten, die GitLab im Betrieb braucht, und liefert sie gleich mit. Laut der GitLab-Dokumentation \cite{gitlab_gitlab_nodate} zählen dazu der Webserver \texttt{nginx}, der Anwendungsserver \texttt{Puma}, die relationale Datenbank \texttt{PostgreSQL} und der Schlüssel-Wert-Speicher \texttt{Redis}. Weitere Hintergrundprozesse kommen hinzu. Abbildung~\ref{fig:omnibus-arch} zeigt das Zusammenspiel der einzelnen Bausteine. \input{diagrams/omnibus_arch} - Der wesentliche Vorteil des Omnibus-Paketes ist, dass die einzelnen Komponenten nicht selbst installiert und aufeinander abgestimmt werden müssen. Ein einzelner Aufruf des Paketmanagers genügt. Nach GitLab-Dokumentation \cite{gitlab_gitlab_nodate} wird auf debian-basierten Systemen einmalig das GitLab-Paketrepository hinzugefügt und anschliessend \texttt{apt install gitlab-ce} ausgeführt. + Beim Omnibus-Paket entfällt das einzelne Installieren und Abstimmen der Komponenten. Ein einzelner Aufruf des Paketmanagers genügt. Laut der GitLab-Dokumentation \cite{gitlab_gitlab_nodate} wird auf einem Debian-basierten System einmalig das GitLab-Paketrepository hinzugefügt, danach installiert \texttt{apt install gitlab-ce} den Rest. - Für diese Arbeit wurde GitLab \ac{CE} in Version 18.11 auf einem privaten Linux-Server unter Ubuntu 24.04 LTS installiert. GitLab empfiehlt für eine produktive Instanz mit bis zu 20 aktiven Nutzern mindestens vier Kerne und 8\,GiB Arbeitsspeicher \cite{gitlab_gitlab_nodate}. Der verwendete Server liegt mit einer 12-Kern-CPU, 64\,GiB Arbeitsspeicher und einer NVMe-SSD darüber. Die Installation selbst lief unauffällig. Das Paket wurde heruntergeladen und entpackt. Das mitgelieferte Skript \texttt{gitlab-ctl reconfigure} brachte die Instanz innerhalb weniger Minuten in einen lauffähigen Zustand. Eine erste Anmeldung über die Weboberfläche war direkt möglich. + In dieser Arbeit wurde die Community Edition von GitLab in Version 18.11 auf einem privaten Linux-Server unter Ubuntu 24.04 LTS installiert. GitLab empfiehlt für eine produktive Instanz mit bis zu 20 aktiven Nutzern mindestens vier Kerne und 8\,GiB Arbeitsspeicher \cite{gitlab_gitlab_nodate}. Für die Installation wurde ein Server mit einer 12-Kern-CPU, 64\,GiB Arbeitsspeicher und einer NVMe-SSD genutzt, der damit über der Empfehlung liegt. Die Installation lief ohne manuelle Eingriffe durch. Nach dem Absenden des Befehls wurden alle benötigten Pakete heruntergeladen und entpackt, woraufhin das mitgelieferte Skript \texttt{gitlab-ctl reconfigure} die gesamte GitLab-Instanz innerhalb von Minuten in einen lauffähigen Zustand brachte. Direkt nach Abschluss der Installation ließ sich die Weboberfläche öffnen, und eine erste Anmeldung war sofort möglich. - Eine Besonderheit des hier beschriebenen Aufbaus betrifft die Erreichbarkeit der Instanz. Anstatt sie über eine öffentliche Domain freizugeben, läuft die gesamte Kommunikation über ein privates Overlay-Netzwerk auf VPN-Basis. Der Webserver \texttt{nginx} bindet sich dabei nur an die lokale Schnittstelle und ist von aussen nicht direkt erreichbar. Ein Proxy des Overlay-Dienstes nimmt die Anfragen auf demselben Host entgegen, beendet die \ac{TLS}-Verbindung und reicht sie an den lokalen Port weiter. Das zugehörige Zertifikat stellt der Overlay-Dienst selbst aus. Zugriff haben nur Geräte, die im Overlay-Netzwerk freigegeben sind. Die Ports 80 und 443 sind zu keinem Zeitpunkt zum öffentlichen Internet geöffnet. + Um die Instanz nicht nur lokal aufrufen zu können, wurde sie über ein privates Overlay-Netzwerk auf VPN-Basis erreichbar gemacht. Theoretisch ließe sich die Instanz über eine öffentliche IP-Adresse ans Internet anbinden, mit einer Domain versehen und per HTTPS absichern. Das würde aber unnötig eine Angriffsfläche nach außen schaffen. Für die Demo reicht der gewählte Aufbau aus. Der Webserver \texttt{nginx} bindet sich daher nur an die lokale Schnittstelle und ist von außen nicht direkt erreichbar. Ein Proxy des Overlay-Dienstes nimmt die Anfragen auf demselben Host entgegen und reicht sie an den lokalen Port weiter. Das zugehörige Zertifikat stellt der Proxy selbst aus, sodass die Verbindung über HTTPS verschlüsselt ist. Zugriff haben nur Geräte, die im Overlay-Netzwerk freigegeben sind. Die Ports 80 und 443 sind zu keinem Zeitpunkt zum öffentlichen Internet geöffnet. \subsection{Konfiguration} - Eine Self-Managed-Instanz wird zentral über die Datei \texttt{/etc/gitlab/gitlab.rb} konfiguriert \cite{painter_practical_2024}. Sämtliche Komponenten des Omnibus-Pakets lesen ihre Einstellungen aus dieser Datei. Bei jedem Aufruf von \texttt{gitlab-ctl reconfigure} werden die Komponenten mit dem aktuellen Stand neu initialisiert. Tabelle~\ref{tab:gitlabrb} zeigt eine Auswahl der für den vorliegenden Aufbau relevanten Optionen. + Eine Self-Managed-Instanz kann über die zentrale Datei \texttt{/etc/gitlab/gitlab.rb} konfiguriert werden \cite{painter_practical_2024}. Die einzelnen Komponenten des Omnibus-Pakets lesen ihre Einstellungen aus dieser Datei. Durch den Befehl \texttt{gitlab-ctl reconfigure} werden die Komponenten mit dem aktuellen Stand neu initialisiert. Tabelle~\ref{tab:gitlabrb} zeigt eine Auswahl der für den vorliegenden Aufbau relevanten Optionen. \begin{table}[H] \centering \caption{Auswahl an Konfigurationsoptionen aus \texttt{gitlab.rb} \cite{gitlab_gitlab_nodate, painter_practical_2024}} @@ -372,7 +380,7 @@ stages: \begin{tabular}{@{}lll@{}} \toprule Option & Wert & Zweck \\ \midrule - \texttt{external\_url} & \texttt{https://} & von aussen sichtbare \ac{URL} \\ + \texttt{external\_url} & \texttt{https://} & von außen sichtbare \acs{URL} \\ \texttt{nginx['listen\_addresses']} & \texttt{['127.0.0.1']} & nur lokales Binding \\ \texttt{letsencrypt['enable']} & \texttt{false} & kein eigenes Zertifikat \\ \texttt{registry['enable']} & \texttt{true/false} & Container Registry \\ @@ -384,31 +392,33 @@ stages: } \end{table} - Eine geführte Erstkonfiguration, wie sie die \ac{SaaS}-Variante bietet, existiert für die Self-Managed-Variante nicht \cite{painter_practical_2024}. Nach der Installation läuft die Instanz in einem generischen Standardzustand. In unserem Aufbau fiel der Aufwand aber geringer aus als befürchtet. Die reine Paketinstallation war in unter zehn Minuten abgeschlossen. Danach mussten an \texttt{gitlab.rb} nur wenige Optionen angepasst werden, vor allem die Erreichbarkeit über das Overlay-Netzwerk und das lokale Binding von \texttt{nginx}. Der grösste Teil der projektspezifischen Einrichtung liess sich anschliessend über die Weboberfläche erledigen, also Gruppen und Projekte, Nutzer sowie die Registrierung der Runner. Ein tieferer Eingriff in die Konsole war dafür nicht nötig. + Die \ac{SaaS}-Variante bietet eine geführte Erstkonfiguration, die Self-Managed-Variante nicht \cite{painter_practical_2024}. Nach der Installation läuft die Instanz in einem Standardzustand. Der Aufwand der Installation war geringer als erwartet. Die reine Paketinstallation war insgesamt in unter zehn Minuten abgeschlossen. Danach mussten an der Datei \texttt{gitlab.rb} nur wenige Optionen angepasst werden, die die Erreichbarkeit über das Overlay-Netzwerk sowie das lokale Binding von \texttt{nginx} steuern. Die meisten Einstellungen ließen sich über die Weboberfläche erledigen, darunter Gruppen und Projekte, Nutzer sowie die Registrierung der Runner. \subsection{Betrieb} - Im laufenden Betrieb wird GitLab über das Kommandozeilenwerkzeug \texttt{gitlab-ctl} gesteuert. Damit lassen sich die Hintergrunddienste starten, stoppen und überwachen \cite{painter_practical_2024}. Aktualisiert wird über den Paketmanager und das von GitLab vorgegebene Versionsschema. Wer mehrere Hauptversionen überspringt, muss eine feste Reihenfolge einhalten. Die enthaltenen Datenbankmigrationen bauen aufeinander auf, und ein direkter Sprung von einer alten auf eine deutlich neuere Version kann den Datenbestand inkonsistent zurücklassen \cite{gitlab_gitlab_nodate}. Sicherungen werden über den Befehl \texttt{gitlab-backup create} erzeugt und umfassen die \texttt{PostgreSQL}-Datenbank sowie alle Repositories und Artefakte. + Die GitLab-Instanz kann über das Kommandozeilenwerkzeug \texttt{gitlab-ctl} gesteuert werden. Mit diesem lassen sich die Hintergrundprozesse starten, stoppen und überwachen \cite{painter_practical_2024}. Um GitLab zu aktualisieren, dienen der Paketmanager und das von GitLab vorgegebene Versionsschema. Falls mehrere Hauptversionen übersprungen werden sollen, muss trotzdem eine feste Reihenfolge eingehalten werden, um die Instanz nicht zu beschädigen. Die enthaltenen Datenbankmigrationen bauen aufeinander auf, und ein direkter Sprung von einer alten auf eine deutlich neuere Version kann den Datenbestand inkonsistent zurücklassen \cite{gitlab_gitlab_nodate}. Eine Sicherung kann mit dem Befehl \texttt{gitlab-backup create} erzeugt werden und umfasst die \texttt{PostgreSQL}-Datenbank sowie alle Repositories und Artefakte. - Der bereits in Abschnitt~1.3 angesprochene \textit{GitLab.com Database Incident} aus dem Jahr 2017 zeigt, was ein nicht funktionierendes Backup anrichtet. Durch eine fehlerhafte manuelle Aktion gingen sechs Stunden Nutzerdaten verloren \cite{GitLabcomDatabaseIncident}. Betroffen war zwar die \ac{SaaS}-Instanz, das Beispiel ist aber auch für eine eigene Instanz von Bedeutung. Ein Backup, das nicht regelmässig in einem Restore-Test überprüft wird, ist im Ernstfall kein Backup. Die eigentlichen Aufwände einer Self-Managed-Instanz fallen nicht bei der Erstinstallation an, sondern über deren Lebensdauer \cite{painter_practical_2024}. Sicherheitsaktualisierungen, regelmässige Restore-Tests und die Überwachung der Datenbankkonsistenz kommen laufend dazu. + Der bereits in Abschnitt~1.3 angesprochene Datenbankvorfall bei GitLab.com aus dem Jahr 2017 zeigt, was ein nicht funktionierendes Backup anrichtet. Durch eine fehlerhafte manuelle Aktion gingen sechs Stunden an Nutzerdaten verloren \cite{GitLabcomDatabaseIncident}. Betroffen war zwar die \ac{SaaS}-Instanz, das Beispiel ist aber auch für eine eigene Instanz von Bedeutung. Ein Backup, das nicht regelmäßig in einem Restore-Test überprüft wird, ist im Ernstfall kein Backup. Die eigentlichen Aufwände einer Self-Managed-Instanz fallen nicht bei der Erstinstallation an, sondern über deren Lebensdauer \cite{painter_practical_2024}. Sicherheitsaktualisierungen und regelmäßige Restore-Tests kommen laufend hinzu, ebenso die Überwachung der Datenbankkonsistenz. \section{Evaluierung} - + + Die vorigen Kapitel haben GitLabs CI/CD-Konzepte und die Einrichtung einer eigenen Instanz behandelt. Dieses Kapitel bewertet die Plattform im Eigenbetrieb anhand von sechs Kriterien. Wie dabei vorgegangen wird, legt der folgende Abschnitt offen. + \subsection{Vorgehensweise} \authornote{Christopher Schmitt} Bewertet wird GitLab als selbstbetriebene Plattform. Die Bewertung stützt sich, soweit möglich, auf die in Abschnitt~\ref{sec:selfhosted} beschriebene selbstgehostete \ac{CE}-Instanz und die \ac{CI}/\ac{CD}-Pipeline aus dem Anwendungsbeispiel. Kompatibilität, Skalierbarkeit und Dokumentation lassen sich an einer einzelnen Instanz nicht erproben und werden auf Ebene der Plattform beurteilt. - Die Bewertung folgt einem Katalog aus den Kriterien: Performanz, Nachhaltigkeit, Sicherheit, Kompatibilität, Skalierbarkeit und Dokumentation. Performanz, Sicherheit und Kompatibilität orientieren sich an etablierten Softwarequalitätsmerkmalen. Nachhaltigkeit, Skalierbarkeit und Dokumentation kommen hinzu, weil sie im Eigenbetrieb stärker ins Gewicht fallen als bei einer fertig betriebenen \ac{SaaS}-Lösung. + Die Bewertung folgt einem Katalog aus sechs Kriterien. Drei davon, Performanz, Sicherheit und Kompatibilität, orientieren sich an etablierten Softwarequalitätsmerkmalen. Nachhaltigkeit, Skalierbarkeit und Dokumentation kommen hinzu, weil sie im Eigenbetrieb stärker ins Gewicht fallen als bei einer fertig betriebenen \ac{SaaS}-Lösung. - Innerhalb jedes Kriteriums wird qualitativ argumentiert. Herangezogen werden die offizielle GitLab-Dokumentation, die im jeweiligen Abschnitt zitierte Literatur und die eigenen Beobachtungen aus Installation und Betrieb. Die Performanz bildet die Ausnahme. Hier werden die Laufzeiten der Demo-Pipeline gemessen und gegenübergestellt. + Innerhalb jedes Kriteriums wird qualitativ argumentiert. Herangezogen werden die offizielle GitLab-Dokumentation, die im jeweiligen Abschnitt zitierte Literatur und die eigenen Beobachtungen aus Installation und Betrieb. Die Performanz bildet die Ausnahme, denn dort werden die Laufzeiten der Demo-Pipeline gemessen und gegenübergestellt. - Zwei Grenzen sind vorab zu nennen. Die Instanz läuft auf einem einzelnen Server. Aussagen zur Skalierbarkeit stützen sich daher auf die Architektur und die Herstellerangaben, nicht auf einen eigenen Lasttest. Die gemessenen Laufzeiten stammen aus einer bewusst kleinen Anwendung und zeigen Grössenordnungen, keine repräsentativen Benchmarks. + Zwei Grenzen sind vorab zu nennen. Die Instanz läuft auf einem einzelnen Server. Aussagen zur Skalierbarkeit stützen sich daher auf die Architektur und die Herstellerangaben, nicht auf einen eigenen Lasttest. Die gemessenen Laufzeiten stammen aus einer bewusst kleinen Anwendung und zeigen Größenordnungen, keine repräsentativen Benchmarks. \subsection{Performanz} \authornote{Christopher Schmitt} -Die reine Nutzlast der \ac{CI}-Jobs im Anwendungsbeispiel ist winzig. Auf einem Entwicklungsrechner mit 32 Kernen, warmem npm-Cache und zuvor leerem \texttt{node\_modules} braucht \texttt{npm ci} für die 221 Pakete des Projekts rund eine Sekunde. \texttt{npm run lint} braucht etwa 0,3 Sekunden, \texttt{npm test} etwa 0,8 Sekunden. Tabelle~\ref{tab:perf-local} listet diese lokalen Referenzwerte. Sie sind keine Runner-Zeiten und sollen nur die Grössenordnung der eigentlichen Arbeit zeigen. +Die reine Nutzlast der \ac{CI}-Jobs im Anwendungsbeispiel ist winzig. Auf einem Entwicklungsrechner mit 16 Kernen braucht \texttt{npm ci} für die 221 Pakete des Projekts rund eine Sekunde, bei warmem npm-Cache und zuvor leerem \texttt{node\_modules}. \texttt{npm run lint} braucht etwa 0,3 Sekunden, \texttt{npm test} etwa 0,8 Sekunden. Tabelle~\ref{tab:perf-local} listet diese lokalen Referenzwerte. Sie sind keine Runner-Zeiten und sollen nur die Größenordnung der eigentlichen Arbeit zeigen. \begin{table}[H] \centering @@ -423,7 +433,7 @@ Die reine Nutzlast der \ac{CI}-Jobs im Anwendungsbeispiel ist winzig. Auf einem \end{tabular} \end{table} -Auf dem Runner sieht das anders aus. Gemessen wurde die Demo-Pipeline auf der selbstgehosteten Instanz, einmal in der ursprünglichen Konfiguration und einmal mit zwei Korrekturen am Cache. Tabelle~\ref{tab:perf-runner} stellt die drei Varianten gegenüber. In jeder Variante liegt die eigentliche Prüfung unter einer Sekunde. Den Rest eines Jobs verbrauchen der Start des \texttt{node:20-alpine}-Containers, das Klonen des Repositorys, die Installation der Abhängigkeiten und, je nach Konfiguration, das Sichern und Wiederherstellen des Caches. +Auf dem Runner, gemessen an der Demo-Pipeline auf der selbstgehosteten Instanz, liegen die Zeiten deutlich höher. Erfasst wurde sie einmal in der ursprünglichen Konfiguration und einmal mit zwei Korrekturen am Cache. Tabelle~\ref{tab:perf-runner} stellt die drei Varianten gegenüber. In jeder Variante liegt die eigentliche Prüfung unter einer Sekunde. Den Rest eines Jobs verbrauchen der Start des \texttt{node:20-alpine}-Containers, das Klonen des Repositorys, die Installation der Abhängigkeiten und je nach Konfiguration, das Sichern und Wiederherstellen des Caches. \begin{table}[H] \centering @@ -438,11 +448,11 @@ Auf dem Runner sieht das anders aus. Gemessen wurde die Demo-Pipeline auf der se \end{tabular} \end{table} -Die ursprüngliche Konfiguration cacht das falsche Verzeichnis. Sie legt \texttt{node\_modules} unter einem aus \texttt{package.json} berechneten Schlüssel ab. Der erste Schritt jedes Jobs ist aber \texttt{npm ci}, und dieser Befehl löscht \texttt{node\_modules} vor der Installation und baut es neu auf. Ob der Cache traf oder nicht, änderte an der Laufzeit darum nichts. Im Treffer-Lauf meldet der Runner \texttt{Successfully extracted cache}, im Lauf ohne Treffer \texttt{Cache file does not exist}, und \texttt{npm ci} installiert in beiden Fällen die 221 Pakete in rund zwei Sekunden neu. Der Cache kostet hier sogar Zeit, statt sie zu sparen. Das grosse \texttt{node\_modules}-Verzeichnis wird bei jedem Job gesichert und wiederhergestellt, ohne je genutzt zu werden. Nach Zampetti et al.~\cite{zampetti_empirical_2020} ist eine solche Fehlkonfiguration von Cache und Artefakten ein häufiger Schwachpunkt von CI-Pipelines. Genau das passiert hier. +Unsere erste Pipeline legte das falsche Verzeichnis im Cache ab. Sie speicherte \texttt{node\_modules} unter einem aus \texttt{package.json} berechneten Schlüssel. Dass das nichts bringt, fiel uns erst im Messlauf auf. Der erste Schritt jedes Jobs ist nämlich \texttt{npm ci}, und dieser Befehl löscht \texttt{node\_modules} vor der Installation und baut es neu auf. Ob der Cache traf oder nicht, änderte an der Laufzeit darum nichts. Im Treffer-Lauf meldete der Runner \texttt{Successfully extracted cache}, im Lauf ohne Treffer \texttt{Cache file does not exist}. \texttt{npm ci} installierte die 221 Pakete in beiden Fällen in rund zwei Sekunden neu. Der Cache kostete hier sogar Zeit, statt sie zu sparen. Das große \texttt{node\_modules}-Verzeichnis wurde bei jedem Job gesichert und wiederhergestellt, ohne je genutzt zu werden. Nach Zampetti et al.~\cite{zampetti_empirical_2020} ist eine solche Fehlkonfiguration von Cache und Artefakten ein häufiger Schwachpunkt von CI-Pipelines, und genau das ist uns im Anwendungsbeispiel passiert. -Zwei Korrekturen wurden gemessen. Ohne Cache entfällt das Sichern und Wiederherstellen, und der \texttt{lint}-Job sinkt von 10,5 auf 7,6 Sekunden, der \texttt{unit-test}-Job von 11,2 auf 7,8. Allein das Entfernen des unwirksamen Caches spart also rund drei Sekunden je Job. Die zweite Korrektur cacht statt \texttt{node\_modules} den npm-Paketspeicher unter \texttt{.npm} und ruft \texttt{npm ci} mit den Optionen \texttt{-{}-cache .npm} und \texttt{-{}-prefer-offline} auf. Bei einem Treffer installiert \texttt{npm ci} dann aus dem lokalen Speicher, die Installationszeit sinkt von rund zwei Sekunden auf knapp eine (981\,ms im Messlauf). Am Job ändert das hier kaum etwas, weil der eingesparte Download durch den Aufwand für den \texttt{.npm}-Cache wieder aufgewogen wird. Der Paket-Cache lohnt sich erst, wenn der Download die Installation bestimmt. Auf dieser Instanz mit schnellem Zugriff auf die Registry ist das nicht der Fall. Caches beschleunigen wiederholte Läufe also nicht von selbst. Anders als Artefakte sind sie über Jobgrenzen hinweg nicht garantiert verfügbar \cite{cowell_automating_2023}. +Daraufhin wurden zwei Korrekturen gemessen. Ohne Cache entfällt das Sichern und Wiederherstellen. Der \texttt{lint}-Job sank von 10,5 auf 7,6 Sekunden, der \texttt{unit-test}-Job von 11,2 auf 7,8. Allein das Entfernen des unwirksamen Caches sparte also rund drei Sekunden je Job. Die zweite Korrektur legt statt \texttt{node\_modules} den npm-Paketspeicher unter \texttt{.npm} im Cache ab und ruft \texttt{npm ci} mit den Optionen \texttt{-{}-cache .npm} und \texttt{-{}-prefer-offline} auf. Bei einem Treffer installierte \texttt{npm ci} dann aus dem lokalen Speicher, die Installationszeit sank von rund zwei Sekunden auf knapp eine (981\,ms im Messlauf). Am Job änderte das hier kaum etwas, weil der eingesparte Download durch den Aufwand für den \texttt{.npm}-Cache wieder aufgewogen wurde. Der Paket-Cache lohnt sich erst, wenn der Download die Installation bestimmt. Auf dieser Instanz mit schnellem Zugriff auf die Registry ist das nicht der Fall. Caches beschleunigen wiederholte Läufe also nicht von selbst. Anders als Artefakte sind sie über Jobgrenzen hinweg nicht garantiert verfügbar \cite{cowell_automating_2023}. -Der \ac{DAG} über das Schlüsselwort \texttt{needs} ist hier kaum ein Hebel. Die Demo-Pipeline läuft nahezu linear, erst \texttt{lint}, dann \texttt{test}, dann \texttt{deploy}, und bietet kaum Parallelität, die sich lohnt. Bei grösseren Pipelines sieht das anders aus. Dort ist die Parallelisierung serieller Stages der zentrale Hebel. Zampetti et al.~\cite{zampetti_empirical_2020} führen serielle Stages, die parallel laufen könnten, als typischen Konfigurationsfehler. Der \texttt{deploy:staging}-Job baut das Docker-Image neu. Das Image würde die Abhängigkeiten ein weiteres Mal installieren, doch der Docker-Layer-Cache hält den Abhängigkeits-Layer vor und überspringt diesen Schritt. So lief der Job im Messlauf in 2,3 Sekunden durch. Erst eine Änderung an \texttt{package.json} macht den Cache-Layer ungültig und löst die Installation erneut aus. +Der \ac{DAG} über \texttt{needs}, also die Verknüpfung der Jobs nach ihren Abhängigkeiten, wirkt sich hier kaum aus. Die Demo-Pipeline läuft nahezu linear, erst \texttt{lint}, dann \texttt{test}, dann \texttt{deploy}, und bietet kaum Parallelität, die sich lohnt. Bei größeren Pipelines sieht das anders aus. Dort ist die Parallelisierung serieller Stages der wichtigste Ansatzpunkt. Nach Zampetti et al.~\cite{zampetti_empirical_2020} sind serielle Stages, die parallel laufen könnten, ein typischer Konfigurationsfehler. Der \texttt{deploy:staging}-Job baut das Docker-Image neu. Das Image würde die Abhängigkeiten ein weiteres Mal installieren, doch der Docker-Layer-Cache hält den Abhängigkeits-Layer vor und überspringt diesen Schritt. So lief der Job im Messlauf in 2,3 Sekunden durch. Erst eine Änderung an \texttt{package.json} macht den Cache-Layer ungültig und löst die Installation erneut aus. \subsection{Nachhaltigkeit} @@ -603,19 +613,19 @@ Der \ac{DAG} über das Schlüsselwort \texttt{needs} ist hier kaum ein Hebel. Di \section{Zusammenfassung} \authornote{Christopher Schmitt} - \section*{Anhang} - - Ein Teil der Daten und Grafiken welche innerhalb dieses Artikels verwendet wurden können unter dem Gitea Repository \url{https://gitty.informatik.hs-mannheim.de/2211275/dms} eingesehen werden. +Diese Arbeit ist der Frage nachgegangen, wie gut sich GitLab in Version 18.11 als selbstbetriebene \ac{CI}/\ac{CD}-Plattform eignet. Betrachtet wurden die zentralen Bausteine \emph{Runner}, \emph{Pipeline} und \emph{Job}, der Aufbau einer eigenen Instanz und eine Bewertung entlang von sechs Kriterien. Den praktischen Kern bildete eine kleine \emph{Node.js}-Anwendung mit einer Pipeline aus den Stages \texttt{lint}, \texttt{test} und \texttt{deploy}. -Diese Arbeit ist der Frage nachgegangen, wie gut sich GitLab in Version 18.11 als selbstbetriebene \ac{CI}/\ac{CD}-Plattform eignet. Betrachtet wurden die zentralen Bausteine \emph{Runner}, \emph{Pipeline} und \emph{Job}, der Aufbau einer eigenen Instanz und eine Bewertung entlang von sieben Kriterien. Den praktischen Kern bildete eine kleine \emph{Node.js}-Anwendung mit einer Pipeline aus den Stages \texttt{lint}, \texttt{test} und \texttt{deploy}. +Im Vergleich zu GitHub liegt der große Unterschied beim Hosting. GitLab gibt es als SaaS-Angebot unter \url{gitlab.com} und als selbstbetreibbare Variante. Untersucht haben wir die selbstgehostete Community Edition, die sich komplett auf eigener Hardware betreiben lässt. GitHub bindet seine Nutzer dagegen an die Microsoft-Cloud. Für unsere Instanz war das Omnibus-Paket der einfache Weg. Es bringt \texttt{nginx}, \texttt{Puma}, \texttt{PostgreSQL} und \texttt{Redis} mit, ein \texttt{apt install gitlab-ce} und ein \texttt{gitlab-ctl reconfigure} genügten. Die Installation auf einem Server unter Ubuntu 24.04 LTS lief unauffällig und war in unter zehn Minuten erledigt. An der \texttt{gitlab.rb} mussten wir nur wenige Optionen anpassen, vor allem die Erreichbarkeit über das Overlay-Netzwerk und das lokale Binding von \texttt{nginx}. -Im Vergleich zu GitHub liegt der grosse Unterschied beim Hosting. GitLab lässt sich komplett auf eigener Hardware betreiben, GitHub bindet seine Nutzer an die Microsoft-Cloud. Für unsere Instanz war das Omnibus-Paket der einfache Weg. Es bringt \texttt{nginx}, \texttt{Puma}, \texttt{PostgreSQL} und \texttt{Redis} mit, ein \texttt{apt install gitlab-ce} und ein \texttt{gitlab-ctl reconfigure} genügten. Die Installation auf einem Server unter Ubuntu 24.04 LTS lief unauffällig und war in unter zehn Minuten erledigt. An der \texttt{gitlab.rb} mussten wir nur wenige Optionen anpassen, vor allem die Erreichbarkeit über das Overlay-Netzwerk und das lokale Binding von \texttt{nginx}. - -Der Aufwand verschiebt sich aber nach hinten. Nach Painter~\cite{painter_practical_2024} fallen die eigentlichen Kosten einer Self-Managed-Instanz nicht bei der Erstinstallation an, sondern über die Lebensdauer, durch Sicherheitsaktualisierungen, Restore-Tests und die Überwachung der Datenbankkonsistenz. Der GitLab.com-Vorfall von 2017 mit sechs Stunden verlorener Nutzerdaten zeigt, warum ein Backup ohne regelmässigen Restore-Test im Ernstfall kein Backup ist. +Nach Painter~\cite{painter_practical_2024} fallen die eigentlichen Kosten einer Self-Managed-Instanz nicht bei der Erstinstallation an, sondern verschieben sich über die Lebensdauer, durch Sicherheitsaktualisierungen, Restore-Tests und die Überwachung der Datenbankkonsistenz. Der GitLab.com-Vorfall von 2017 mit sechs Stunden verlorener Nutzerdaten unterstreicht, wie wichtig regelmäßige Restore-Tests der Sicherungen sind. Die Performanzmessung an der Demo-Pipeline zeigte ein klares Bild. Die eigentliche Prüfarbeit ist winzig, \texttt{npm run lint} und \texttt{npm test} laufen lokal in Sekundenbruchteilen. Auf dem Runner dominierten dagegen Containerstart, Klonen und Installation. Die ursprüngliche Konfiguration cachte ausgerechnet das \texttt{node\_modules}-Verzeichnis, das \texttt{npm ci} ohnehin bei jedem Lauf neu aufbaut. Der unwirksame Cache kostete Zeit, statt sie zu sparen. Sein Entfernen senkte den \texttt{lint}-Job von 10,5 auf 7,6 Sekunden und den \texttt{unit-test}-Job von 11,2 auf 7,8. Ein Cache des npm-Paketspeichers unter \texttt{.npm} brachte hier kaum etwas, weil der Zugriff auf die Registry schon schnell genug war. Solche Fehlkonfigurationen von Cache und Artefakten zählen nach Zampetti et al.~\cite{zampetti_empirical_2020} zu den häufigen Schwachpunkten von CI-Pipelines, und genau das hat sich in der kleinen Pipeline bestätigt. -Als selbstbetriebene Plattform ist GitLab brauchbar, wenn Datenschutz oder Compliance den Eigenbetrieb erzwingen oder die \ac{SaaS}-Variante zu teuer wird. Die Einstiegshürde ist niedriger als erwartet, der laufende Betrieb verlangt aber Disziplin bei Updates und Sicherungen. Die Aussagen zur Skalierbarkeit stützen sich auf die Architektur und die Herstellerangaben und nicht auf einen eigenen Lasttest, und die gemessenen Laufzeiten stammen aus einer bewusst kleinen Anwendung. Für ein Unternehmen, das Quellcode im eigenen Haus halten will und die Wartung einplant, ist die selbstgehostete \ac{CE} eine tragfähige Wahl. +Als selbstbetriebene Plattform ist GitLab brauchbar, wenn Datenschutz oder Compliance den Eigenbetrieb erzwingen oder die \ac{SaaS}-Variante zu teuer wird. Die Einstiegshürde ist niedriger als erwartet, der laufende Betrieb verlangt aber Disziplin bei Updates und Sicherungen. Die Aussagen zur Skalierbarkeit stützen sich auf die Architektur und die Herstellerangaben und nicht auf einen eigenen Lasttest, und die gemessenen Laufzeiten stammen aus einer bewusst kleinen Anwendung. Für ein Unternehmen, das Quellcode im eigenen Haus halten will und die Wartung einplant, ist die selbstgehostete \ac{CE} eine tragfähige Wahl. Solange GitLab quelloffen bleibt, dürfte dieser Weg auch über kommende Versionen Bestand haben. + + \section*{Anhang} + + Ein Teil der Daten und Grafiken welche innerhalb dieses Artikels verwendet wurden können unter dem Gitea Repository \url{https://gitty.informatik.hs-mannheim.de/2211275/dms} eingesehen werden. \section*{Abkürzungsverzeichnis} \begin{acronym}[Abkürzungsverzeichnis] diff --git a/diagrams/omnibus_arch.tex b/diagrams/omnibus_arch.tex index edede89..f0116af 100644 --- a/diagrams/omnibus_arch.tex +++ b/diagrams/omnibus_arch.tex @@ -46,6 +46,7 @@ \draw[arr] (puma) -- (pg); \draw[arr] (sidekiq) -- (pg); \draw[arr] (sidekiq) -- (redis); + \draw[arr] (sidekiq.south west) to[bend right=12] (gitaly.north east); \draw[arr] (puma.south east) -- (redis.north west); % Hintergrundjobs -> externer Mailversand diff --git a/diagrams/pipeline_stages.tex b/diagrams/pipeline_stages.tex index 28da153..040448f 100644 --- a/diagrams/pipeline_stages.tex +++ b/diagrams/pipeline_stages.tex @@ -50,6 +50,6 @@ \end{tikzpicture}% } - \caption{Aufbau einer Pipeline aus Stages und Jobs. Durchgezogene Pfeile zeigen die starre Stage-Reihenfolge. Der gestrichelte Pfeil ist eine \texttt{needs}-Beziehung im \acs{DAG}-Modus: \texttt{container} startet, sobald \texttt{unit} fertig ist, und wartet nicht auf \texttt{integration}.} + \caption{Aufbau einer Pipeline aus Stages und Jobs. Durchgezogene Pfeile zeigen die starre Stage-Reihenfolge. Der gestrichelte Pfeil ist eine \texttt{needs}-Beziehung, die diese Reihenfolge aufbricht: \texttt{container} startet, sobald \texttt{unit} fertig ist, und wartet nicht auf \texttt{integration}.} \label{fig:pipeline-stages} \end{figure}