So richten Sie Buildbot unter FreeBSD ein

Buildbot ist ein Job-Scheduling-System, das üblicherweise zum Zweck der kontinuierlichen Integration (CI) verwendet wird. CI ist eine Softwareentwicklungspraxis, die in der Regel das automatische Erstellen und Testen Ihrer Software in regelmäßigen Abständen und bei jeder Änderung umfasst. Buildbot wird zwar häufig als CI-Plattform verwendet, kann jedoch auch für alle automatisierten Aufgaben verwendet werden, die auf einem Computer ausgeführt werden. Die Taskausführungskonfiguration von Buildbot umfasst vier Komponenten:

Buildbot funktioniert über mindestens einen Buildbot-Master, der alle Build-Konfigurationen und sonstigen Einstellungen ausführt und prüft und die tatsächlichen Builds an seine Worker verteilt. Darüber hinaus bietet der Master eine browserbasierte Unterkomponente für die Benutzeroberfläche, die, sofern aktiviert, zum Auslösen oder Anzeigen von Builds sowie zum Überprüfen von Statusberichten und anderen Einstellungen verwendet wird. Es gibt auch einen oder mehrere Buildbot-Worker, die sich mit dem Master verbinden und Befehle empfangen, um Builds auszuführen.

In diesem Handbuch verwenden Sie FreeBSD-Jails, um jede Buildbot-Komponente in einer separaten, isolierten Umgebung zu installieren und auszuführen. Anschließend bedienen Sie Buildbot über den Nginx-Webserver und greifen über einen Webbrowser auf Ihrem lokalen Computer auf dessen Weboberfläche zu. Nachdem Sie dieses Handbuch ausgefüllt haben, verfügen Sie über ein funktionsfähiges Setup mit einem Beispielprojekt, das für Ihr eigenes CI oder andere Anwendungsfälle erweitert werden kann.

Bevor Sie mit diesem Handbuch beginnen, benötigen Sie:

Wenn Sie die Buildbot-Weboberfläche mit sicherem HTTPS hosten möchten, benötigen Sie außerdem Folgendes:

Da Buildbot es externen Mitarbeitern ermöglicht, Code auf Ihrem System auszuführen, wird empfohlen, die verschiedenen Komponenten zu isolieren, um zu verhindern, dass willkürlicher oder böswilliger Code die Ressourcen Ihres Servers beansprucht. In diesem Tutorial verwenden Sie dazu FreeBSD-Jails.

Ähnlich wie LXC, Docker und andere Container-Mechanismen bieten FreeBSD-Jails eine leichte Isolierung vom Host-System. Prozesse, die in einem Gefängnis ausgeführt werden, können nur auf die Ressourcen zugreifen, auf die das Gefängnis bereits Zugriff hat. Ansonsten verhalten sie sich wie jede andere FreeBSD-Umgebung. Jails haben denselben Kernel, werden jedoch normalerweise auf einem Dateisystem ausgeführt, das eine Kopie des FreeBSD-Basissystems enthält, bei dem es sich möglicherweise um eine beliebige Version von FreeBSD handelt, die mit dem Host-Kernel kompatibel ist. Bei den meisten Workloads sind Leistungsunterschiede zwischen dem Ausführen einer Aufgabe auf dem Host und dem Ausführen in einem Jail nicht erkennbar.

Es gibt mehrere externe Softwarepakete, die bei der Erstellung und Verwaltung von FreeBSD-Jails helfen. Da keiner von ihnen de facto der Standard ist, verwenden wir den integrierten jail configuration mechanism des Betriebssystems.

Zunächst möchten wir eine separate Netzwerkschnittstelle für die Jails des Systems erstellen. In Jails schreibt der Kernel Netzwerkverbindungen an die erste IPv4 / IPv6-Adresse, die dem Jail zugewiesen wurde. Wenn zum Beispiel die erste zugewiesene IP-Adresse öffentlich ist und ein Dienst im Gefängnis auf "127.0.0.1: 1234 +" lauscht, ist der Port " 1234 " öffentlich zugänglich. Die empfohlene Vorgehensweise für https://www.freebsd.org/doc/handbook/jails-ezjail.html] besteht darin, eine separate Netzwerkschnittstelle für Gefängnisse bereitzustellen. Wir werden dieser Empfehlung des Klonens der primären Loopback-Schnittstelle (` lo0 `) in eine separate Schnittstelle (` lo1 `) folgen. Wir werden das Netzwerk " 10.0.0.0 / 24 +" verwenden, aber jedes andere nicht überlappende Netzwerk wird auch funktionieren.

Konfigurieren Sie zunächst eine geklonte Schnittstelle, die beim Booten erstellt werden soll. Dieser Befehl "+ sysrc " schreibt eine Regel in die Datei " / etc / rc.conf +", erstellt jedoch nicht die Schnittstelle selbst:

Erstellen Sie als Nächstes die Netzwerkschnittstelle mit dem folgenden Befehl:

Sie können den Schnittstellenstatus und die IP überprüfen mit:

Die Ausgabe zeigt, dass die Schnittstelle vorhanden ist, aber noch keine IP-Adressen aufgeführt und zugeordnet sind. Das Flag "+ LOOPBACK +" bedeutet, dass diese Schnittstelle nur lokal verfügbar ist und kein tatsächliches Hardwaregerät darstellt.

Öffnen Sie als Nächstes mit Ihrem bevorzugten Editor eine neue Konfigurationsdatei für das Master-Gefängnis. Hier verwenden wir "+ ee +":

Fügen Sie dann den folgenden Inhalt zur Datei hinzu, die ein Master-Gefängnis mit dem Namen "+ buildbot-master +" konfiguriert:

/etc/jail.buildbot-master.conf

Dieser Code weist der Jail-Netzwerkschnittstelle einen festen Hostnamen und eine feste IP-Adresse zu, + 10.0.0.2 +, und gibt das Root-Dateisystem an, + / usr / jails / buildbot-master +. Die hier verwendeten Werte "+ exec.start " und " exec.stop " geben an, dass sich die Dienste " start " und " stop " des Jails wie Startvorgänge verhalten und die in " / etc." / + `Verzeichnis. Mit der Option "+ persist +" kann das Gefängnis weiter ausgeführt werden, auch wenn alle Prozesse abgeschlossen sind.

Weitere Informationen zu möglichen Einstellungen für das Master-Gefängnis finden Sie auf der Manpage jail(8).

Speichern und beenden Sie den Editor, nachdem Sie diesen Inhalt hinzugefügt haben. Wenn Sie "+ ee " verwenden, drücken Sie dazu " STRG + C ", geben Sie " exit " ein und drücken Sie " ENTER +".

Die Konfigurationsdatei für das Master-Gefängnis ist von der globalen Gefängniskonfigurationsdatei "+ / etc / jail.conf +" getrennt. Aus diesem Grund müssen Sie den Namen des Master-Gefängnisses zur Liste der bekannten Gefängnisse hinzufügen:

Aktivieren Sie dann alle in + jail_list + aufgelisteten Jails, um beim Booten automatisch zu starten:

Wenn Sie auf Ihrem System bereits Jails mit der globalen Datei "+ / etc / jail.conf " konfiguriert haben, aber zuvor " jail_list " nicht verwendet haben, bedeutet das Aktivieren dieser Einstellung, dass nur die Jails in " jail_list +" automatisch ausgeführt werden -Starten Sie und Sie möchten möglicherweise Ihre vorhandenen Gefängnisse zur Liste hinzufügen.

Als nächstes erstellen wir das Stammverzeichnis des Master-Jails und extrahieren das FreeBSD-System.

Stellen Sie sicher, dass das Root-Dateisystemverzeichnis des Jails vorhanden ist. Wenn Sie die ZFS-Befehle im vorherigen Hinweis ausgeführt haben, wurde dies bereits ausgeführt, und Sie können diesen Befehl überspringen:

Laden Sie dann ein FreeBSD 11.2-Basissystemarchiv herunter. Wir installieren zuerst Root-Zertifikate, um dem Download-Server zu vertrauen:

Dieser Befehl fordert Sie auf, die Installation des Pakets + ca_root_nss + zu genehmigen. Drücken Sie dazu + y + und dann + ENTER +.

Laden Sie als nächstes das Archiv herunter:

Extrahieren Sie den Inhalt dieser Datei als Root-Dateisystem des Jails:

In diesem Handbuch wird die Installation genau eines Workers beschrieben, der sich ebenfalls in einem Gefängnis befindet. Sie konfigurieren ihn auf die gleiche Weise wie den Master und verwenden dabei das soeben heruntergeladene Basissystem. Öffnen Sie mit dem Befehl + ee + eine weitere neue Konfigurationsdatei für das Arbeitergefängnis:

Fügen Sie dieser Datei den folgenden Inhalt hinzu:

/etc/jail.buildbot-worker0.conf

Wenn Sie sich diese Zeilen ansehen, stellen Sie fest, dass das Worker-Gefängnis einen anderen Hostnamen, eine andere IP-Adresse und ein anderes Root-Dateisystemverzeichnis als der Master hat. Speichern und schließen Sie diese Datei.

Da wir eine separate Jail-Konfigurationsdatei anstelle der globalen + / etc / jail.conf + verwenden, fügen Sie den Namen der Liste der bekannten Jails hinzu:

Extrahieren Sie das bereits heruntergeladene FreeBSD 11.2-Basissystem wie für den Master:

Zu diesem Zeitpunkt sind beide Jails konfiguriert und enthalten ein FreeBSD-Basissystem, auf dem keine zusätzlichen Pakete installiert sind. Beginnen wir mit den Gefängnissen:

Überprüfen Sie, ob der Start erfolgreich war, indem Sie alle aktiven Jails auf dem System mit dem folgenden Befehl auflisten:

Dadurch wird eine Ausgabe ähnlich der folgenden zurückgegeben, die die derzeit auf Ihrem Server ausgeführten Jails anzeigt:

Dies bestätigt, dass die Jails wie erwartet ausgeführt werden. Zu diesem Zeitpunkt haben sie jedoch keinen Zugang zum Internet, was bedeutet, dass Sie die darin enthaltenen Buildbot-Pakete nicht installieren können. Lesen Sie weiter, um dieses Problem zu beheben.

Obwohl das Master- und das Worker-Gefängnis in Betrieb sind, sind beide vom Internet getrennt. Sie müssen für das Internet geöffnet werden, da sie Pakete installieren und miteinander kommunizieren können müssen.

Um dies zu beheben, kopieren Sie die DNS-Resolver-Konfiguration des Hosts in beide Jails:

Leiten Sie als Nächstes den ausgehenden Internetverkehr aus dem Gefängnis. Verwenden Sie dazu IPFW - die in FreeBSD integrierte Firewall -, um NAT-Netzwerkregeln (Network Address Translation) einzurichten. Wenn Sie diesen Schritt ausführen, wird der aus dem Jail-Netzwerk ausgehende Datenverkehr in die öffentliche IP-Adresse Ihres Hosts übersetzt.

Wenn Sie unter den Voraussetzungen der Let’s Encrypt Tutorial gefolgt sind, ist die Firewall bereits so konfiguriert, dass Sie auf Ihre zugreifen können Webserver. In diesem Fall sind einige der folgenden Schritte überflüssig, es schadet jedoch nicht, sie erneut durchzuarbeiten.

Fügen Sie mit dem folgenden Befehl die vordefinierten Firewall-Regeln für "+ Workstation " in Ihre " rc.conf " -Datei ein. Die " Workstation +" - Regeln schützen den Server, ermöglichen aber dennoch grundlegende Dienste wie das Pingen des Hosts oder das Dynamic Host Configuration Protocol:

Ermöglichen Sie als Nächstes den Zugriff auf die Webserver-Ports von außen. Der folgende Befehl ermöglicht den Datenverkehr über den Port "+ 22 " für SSH. Port ` 80 `, mit dem Buildbot über HTTP bedient werden kann; und Port ` 443 `, wodurch Buildbot über HTTPS bedient werden kann. Wenn Sie Ihren Server mit Let’s Encrypt gesichert haben, sind alle drei Ports erforderlich. Wenn Sie dies jedoch nicht vorhaben, können Sie den Port " 443 +" ausschließen:

Ermöglichen Sie den Zugriff von jeder IP-Adresse auf die in der Direktive "+ firewall_myservices +" angegebenen Ports:

Konfigurieren Sie die Firewall so, dass sie beim Booten startet:

Starten Sie dann die Firewall mit den Grundregeln. Der folgende Befehl "+ nohup " verhindert die Unterbrechung des Firewall-Starts und leitet außerdem " stderr " und " stdout +" in eine temporäre Protokolldatei um. Dies ist wichtig, um die Firewall-Regeln nicht in einem inkonsistenten Zustand zu belassen. Dies kann dazu führen, dass auf Ihren Remote-Host über SSH nicht mehr zugegriffen werden kann:

Wenn Sie die Shells "+ csh " oder " tcsh " verwenden, wird bei dieser Umleitung " Ambiguous Output Redirect. " In Ihrer Ausgabe angezeigt. Wenn Sie eine dieser Shells verwenden, führen Sie stattdessen " sudo nohup service ipfw start> & / tmp / ipfw.log " aus, um " ipfw +" zu starten:

Zu diesem Zeitpunkt wird der Firewall-Dienst gestartet und der Host wird vor Verbindungen zu ungesicherten Ports geschützt.

Als Nächstes müssen Sie die Netzwerkschnittstelle des Hosts ermitteln, der eine Verbindung zum Internet herstellt. Finden Sie dies, indem Sie Folgendes ausführen:

Dieser Befehl kann verschiedene Schnittstellen ausgeben. Die vom Host für die Verbindung zum Internet verwendete Adresse enthält die öffentliche IP-Adresse Ihres Servers. Zur Veranschaulichung zeigt die folgende Beispielausgabe, dass "+ vtnet0 +" die vom Host verwendete Netzwerkschnittstelle ist:

Notieren Sie sich diese Schnittstelle und konfigurieren Sie ihren Namen global:

Öffnen Sie die neue Firewall-Konfigurationsskriptdatei:

Fügen Sie der Datei dann den folgenden Inhalt hinzu, indem Sie die Firewall-Regeln für IPFW definieren:

/usr/local/etc/ipfw.rules

Die einzelnen Teile des Skripts haben folgende Aufgaben:

Speichern Sie die Datei und beenden Sie den Editor.

Da wir die vordefinierten, grundlegenden Firewall-Regeln durch die im Skript "+ ipfw.rules " definierten Regeln ändern möchten, müssen wir in der Datei " rc.conf +" auf dieses Skript verweisen. Mit dem folgenden Befehl wird das Skript so konfiguriert, dass es bei jedem Start der Firewall ausgeführt wird:

Dieses Setup verwendet die kernelinterne NAT-Unterstützung von IPFW, sodass Sie das System anweisen müssen, das entsprechende Kernelmodul beim Booten zu laden. Laden Sie das Modul außerdem sofort, ohne dass ein Neustart erforderlich ist:

Starten Sie die Firewall neu, um das Skript für erweiterte Firewallregeln zu aktivieren:

Wenn Sie die "+ csh " - Shell oder eines ihrer Derivate (wie " tcsh ") verwenden, führen Sie " sudo nohup service ipfw restart> & / tmp / ipfw.lo +" anstelle des vorherigen Befehls zum Neustart aus die Firewall:

Überprüfen Sie, ob die Firewall-Regeln korrekt geladen wurden:

Hier sind die Firewall-Regeln aufgeführt, gefolgt von einer Erfolgsmeldung:

Sie können installierte Firewall-Regeln auch jederzeit anzeigen, indem Sie Folgendes verwenden:

Wenn alle Firewall-Regeln vorhanden sind, können Ihre Gefängnisse jetzt auf das Internet zugreifen. Sie können dies überprüfen, indem Sie versuchen, eine Webseite aus einem Gefängnis herunterzuladen:

Damit haben Sie beide Jails erfolgreich auf die Ausführung als normales Betriebssystem vorbereitet, für jedes Jail einen Internetzugang eingerichtet und beide gestartet. In den nächsten beiden Schritten in diesem Lernprogramm werden Sie durch die Installation der Master- und der Arbeiterkomponente geführt und anschließend als Dienste ausgeführt.

Die Buildbot-Komponenten sind in mehrere Pakete aufgeteilt. Sie müssen nur das Paket "+ py36-buildbot " installieren, um die Masterkomponente auszuführen. In diesem Handbuch wird jedoch auch erläutert, wie das Webinterface-Paket " py36-buildbot-www +" installiert wird.

Da wir Jails verwenden, um die verschiedenen Komponenten zu segmentieren, öffnen Sie zunächst eine * root * -Shell im Master-Jail:

Bitte beachten Sie, dass in diesem Handbuch Shell-Befehlsblöcke mit einer anderen Farbe gekennzeichnet sind, wenn sie in einer Jail-Shell ausgeführt werden müssen. Darüber hinaus gibt die Eingabeaufforderung an, unter welchem ​​der Benutzerprofile des Jails - entweder als * root * oder als * buildbot-master * - die Befehle ausgeführt werden müssen.

Installieren Sie die Pakete:

Wenn Sie den Paketmanager "+ pkg " in diesem Gefängnis noch nicht installiert oder verwendet haben, werden Sie aufgefordert, zu bestätigen, dass Sie ihm erlauben, sich selbst zu booten. Drücken Sie dazu ` y ` und dann ` ENTER `. Genehmigen Sie dann die Installation der Buildbot-Pakete, indem Sie erneut " y +" eingeben.

Erstellen Sie als Nächstes einen regulären, nicht privilegierten Benutzer, um den Master-Service auszuführen. Mit dem folgenden Befehl wird diesem Benutzer ein zufälliges Kennwort zugewiesen, das Sie sich jedoch nicht merken müssen, da der Benutzer * root * des Hosts (außerhalb des Gefängnisses) es ändern oder jeder Benutzer innerhalb des Gefängnisses ohne Kennwort werden kann:

Erstellen Sie anschließend das Hauptverzeichnis, in dem Sie die Konfiguration speichern möchten:

Und geben Sie dem Service-Benutzer den Besitz:

Ab diesem Zeitpunkt sollten alle master-bezogenen Setups und Änderungen als nichtprivilegierter Benutzer ausgeführt werden, da dies dazu beiträgt, den Besitz und die Berechtigungen konsistent zu halten.

Wechseln Sie zu dem nicht privilegierten Benutzer:

Verwenden Sie dann das integrierte Hilfsprogramm "+ buildbot +", um ein Verzeichnis und eine Konfigurationsstruktur im angegebenen Verzeichnis zu erstellen:

Im Gegensatz zu anderen CI-Programmen wie Jenkins wird das Verhalten von Buildbot direkt in der Konfigurationsdatei definiert, die mit Python interpretiert wird. Dies ermöglicht eine optimierte Versionierung Ihrer Konfiguration, während die Verwendung einer Skriptsprache die Möglichkeit bietet, benutzerdefinierte Build-Konfigurationen zu erstellen und vorhandene Buildbot-Funktionen zu erweitern.

Das Buildbot-Paket enthält eine Muster-Master-Konfigurationsdatei, die Sie als Vorlage für Ihre eigene Konfiguration verwenden können. Kopieren Sie die Beispielkonfiguration und nennen Sie sie + master.cfg +:

Öffnen Sie dann die Basiskonfigurationsdatei mit Ihrem bevorzugten Texteditor. Hier verwenden wir "+ ee +":

Die Konfigurationsdatei enthält ein Kennwort, das die Mitarbeiter benötigen, um eine Verbindung zum Master herzustellen. Ersetzen Sie das Standardkennwort "+ pass " durch ein sicheres Kennwort Ihrer Wahl. Außerdem lautet der Name unseres Arbeitnehmers " worker0 ". Ersetzen Sie daher " example-worker " in den Abschnitten " WORKERS " und " BUILDERS " durch " worker0 +".

Wenn Sie fertig sind, sehen die Teile der Datei, die Sie bearbeiten müssen, folgendermaßen aus:

/var/buildbot-master/master.cfg

Speichern und schließen Sie diese Datei, und führen Sie dann den Befehl + exit + aus, um zum Benutzer * root * im Gefängnis zurückzukehren:

Da die Beispielkonfiguration das Git-Repository + git: // github.com / buildbot / hello-world.git + als Änderungsquelle überwacht, müssen Sie auch Git installieren:

Damit haben Sie die Hauptverzeichnisstruktur und -konfiguration erstellt, der Dienst wird jedoch noch nicht ausgeführt. Um Buildbot manuell auszuführen, könnte man den Befehl "+ buildbot start " aus dem Masterverzeichnis " / var / buildbot-master " ausführen. Dies kümmert sich jedoch nicht um den Start beim Systemstart oder eine andere systemweite Konfiguration. Stattdessen verwenden wir _rc scripts_, die Standardmethode von FreeBSD zum Ausführen von Diensten. Insbesondere verwenden wir dazu das Dienstprogramm " service".

In diesem Lernprogramm soll der Dienst bei jedem Start ausgeführt werden. Im Falle von Gefängnissen ist dies das Startereignis des Gefängnisses. Verwenden Sie den folgenden Befehl, um den Speicherort des Masterverzeichnisses zu definieren:

Geben Sie dann an, dass der Dienst unter dem Benutzer * buildbot-master * ausgeführt werden soll:

Aktivieren Sie als Nächstes den Dienst, der beim Start des Jails ausgeführt werden soll:

Zum Zeitpunkt des Schreibens weist das Paket + py36-buildbot + einen Fehler auf, der das Starten des Dienstes verhindert (siehe this bug report). . Bis dies behoben ist, müssen Sie das Startskript manuell patchen, indem Sie den folgenden Befehl in Ihrem BuildBot-Master-Jail ausführen:

Starten Sie dann den Dienst:

Der Dienst sollte ohne Fehler starten. Sie können den Erfolg überprüfen, indem Sie den Inhalt der Protokolldatei anzeigen:

Um zur Host-Shell zurückzukehren, führen Sie in der Jail-Shell "+ exit +" aus:

Sie haben den Buildbot-Master-Service erfolgreich konfiguriert und gestartet. Die zweite Komponente, der Worker, ist erforderlich, um Builds tatsächlich auszuführen. Sie werden einen Worker im nächsten Abschnitt in einem zweiten Gefängnis installieren und dann seine Verbindung zum Master-Service konfigurieren.

Obwohl der Buildbot-Master ausgeführt wird, können keine Builds ausgeführt werden, da mindestens ein Worker ausgeführt werden muss. Dieser Schritt ähnelt dem vorherigen, indem wir zuerst ein separates Gefängnis einrichten und dann den Dienst installieren. Diesmal stellt die Buildbot-Arbeiterkomponente jedoch eine Verbindung zum Master her, um auf Befehle zu warten und Ergebnisse zurückzumelden.

Die Anweisungen in diesem Schritt sind fast identisch mit dem Master-Setup, außer dass die Worker-Komponente Teil eines anderen Pakets ist und Sie lediglich Details zum Verbinden mit dem Master und einige Anzeigeinformationen zum Worker selbst hinzufügen müssen.

Stellen Sie sicher, dass Sie sich in der Host-Shell befinden und nicht in einem Gefängnis. Dann öffne eine * root * Shell im Arbeitergefängnis:

Beachten Sie, dass in diesem Handbuch Befehlsblöcke mit einer anderen Farbe gekennzeichnet sind, wenn sie in einer Jail-Shell ausgeführt werden müssen und die Befehlsaufforderungen das Benutzerprofil widerspiegeln, unter dem die Befehle ausgeführt werden sollen.

Installieren Sie das Buildbot-Arbeitspaket mit dem folgenden Befehl:

Wenn dieser Befehl ausgeführt wird, werden Sie aufgefordert, zu bestätigen, ob Sie das Paketverwaltungsdienstprogramm "+ pkg " booten möchten. Geben Sie dazu " y " ein. Außerdem werden Sie aufgefordert, zu bestätigen, dass Sie die Installation der Pakete genehmigen. Geben Sie also " y +" erneut ein, wenn Sie dazu aufgefordert werden.

Erstellen Sie als Nächstes einen regulären, nicht privilegierten Benutzer, um den Worker-Service auszuführen:

Erstellen Sie dann das Arbeiterverzeichnis. Dies ist der Ort, an dem die Konfiguration, Anzeigeinformationen und Erstellungsverzeichnisse des Workers gespeichert werden:

Geben Sie dem Dienstbenutzer den Besitz:

Ab diesem Zeitpunkt sollten alle arbeiterbezogenen Einstellungen und Änderungen als nichtprivilegierter Benutzer ausgeführt werden. Wechseln Sie zu diesem Zweck zu dem Benutzer "+ buildbot-worker +":

Verwenden Sie das integrierte Hilfsprogramm "+ buildbot-worker ", um ein Verzeichnis und eine Konfigurationsstruktur im Verzeichnis " / var / buildbot-worker " zu erstellen. Geben Sie die IP-Adresse des Master-Jails an - " 10.0.0.2 ", die wir im vorherigen Schritt ausgewählt haben -, damit der Worker eine Verbindung herstellen und " pass +" durch das in der Master-Konfigurationsdatei definierte Passwort ersetzen kann:

Geben Sie zum Abschließen des Setups einige Details zum Systemadministrator und zum Zweck des Mitarbeiters ein:

Führen Sie anschließend den Befehl + exit + aus, um zum Benutzer * root * im Gefängnis zurückzukehren:

Da die Beispielkonfiguration das Git-Repository "+ git: // github.com / buildbot / hello-world.git " klont, um das Beispielprojekt zu erstellen, müssen Sie Git auch in diesem Jail installieren. Beachten Sie, dass der Buildbot-Master auch Git benötigt, da Änderungsquellen auf dem Master ausgeführt werden. Darüber hinaus verwendet der Builder einen Test-Runner mit dem Namen " trial ", der Teil des Pakets " py27-twisted " ist. Installieren Sie ihn also zusammen mit " git-lite +":

Der eingebaute Mechanismus zum Ausführen eines Workers ist "+ buildbot-worker start", der aus dem Worker-Verzeichnis "+ / var / buildbot-worker" ausgeführt werden sollte. Dies kümmert sich jedoch nicht um den Start während des Startvorgangs und stellt nicht sicher, dass er unter dem richtigen Benutzer ausgeführt wird. Verwenden Sie wie beim Master das gepackte Skript "+ rc " mit dem Dienstprogramm " service +", um den Dienst zu verwalten.

Verwenden Sie die folgenden Befehle, um das Arbeitsverzeichnis sowie den Benutzer und die Gruppe zu definieren, unter denen der Dienst ausgeführt werden soll:

Aktivieren Sie als Nächstes den Dienst, der beim Start des Jails ausgeführt werden soll:

Zum Zeitpunkt des Schreibens weist das Paket + py36-buildbot-worker + einen Fehler auf, der das Starten des Dienstes verhindert (siehe this bug report) ). Bis dies behoben ist, müssen Sie das Startskript manuell patchen, indem Sie den folgenden Befehl in Ihrem + buildbot-worker0 + - Gefängnis ausführen:

Starten Sie abschließend die Worker-Komponente:

Der Dienst sollte ohne Fehler starten. Sie können den Erfolg überprüfen, indem Sie die neuesten Einträge in der Protokolldatei anzeigen:

Wenn der Dienst erfolgreich gestartet wurde, wird eine Meldung wie "+ Verbunden mit 10.0.0.2:9989" angezeigt. Arbeiter ist bereit + `wird in der Protokolldatei angezeigt. Wenn Sie zuvor vergessen haben, ein neues Kennwort anzugeben, kann der Dienst keine Verbindung zum Master herstellen. In diesem Fall bearbeiten Sie die Datei "+ / var / buildbot-worker / buildbot.tac " und führen dann " service buildbot-worker restart +" aus, um dieses Problem zu beheben.

Sobald der Dienst ordnungsgemäß gestartet wurde, verlassen Sie die Host-Shell, indem Sie den Befehl + exit + in der Jail-Shell ausführen:

Damit ist das zweite Gefängnis konfiguriert und Sie haben alle grundlegenden Komponenten für den Betrieb von Buildbot. Um für Ihre Benutzer problemlos verwendbar zu sein, wird empfohlen, dass Sie auch die webbasierte Benutzeroberfläche einrichten. Auf diese Weise können Sie Buildbot steuern und die Build-Ergebnisse bequemer anzeigen.

Buildbot verfügt über eine webbasierte Benutzeroberfläche, die Buildübersichten und -ergebnisse anzeigt und es Ihnen ermöglicht, Builds manuell auszulösen, wenn ein Force-Scheduler konfiguriert ist, wie dies in der Beispielkonfiguration der Fall ist.

In Ihrer Masterkonfiguration ist die Komponente "+ www " bereits so konfiguriert, dass HTTP über den Port " 8010 " bereitgestellt wird. In einer Produktionseinstellung würden Sie kein unverschlüsseltes HTTP bereitstellen oder den nicht standardmäßigen Port " 8010 +" nach außen öffnen, da dies Ihr System für Sicherheitslücken öffnen würde. Das Webinterface kann auch von einem beliebigen URL-Pfad aus bedient werden. Dies bedeutet, dass es nicht die einzige Anwendung in Ihrer Domain sein muss. Beispielsweise können Sie Ihren Benutzern Build-Ausgaben oder Protokolle bereitstellen. Daher werden wir die Benutzeroberfläche für Benutzer mit einem separaten Webserver - Nginx - bereitstellen, um HTTPS zu unterstützen, interne Ports zu schützen und die Möglichkeit zu erhalten, andere Inhalte neben der Buildbot-Weboberfläche bereitzustellen.

Öffnen Sie die Nginx-Konfigurationsdatei zum Bearbeiten:

Fügen Sie die folgenden markierten "+ location n" -Blöcke in den vorhandenen "+ server" -Block der Datei ein:

/usr/local/etc/nginx/nginx.conf

Diese Konfiguration leitet alle Anforderungen unter dem URL-Pfad "+ / buildbot / +" an die Webschnittstelle weiter und aktiviert die WebSocket-Unterstützung, die von der Schnittstelle verwendet wird, um Aktualisierungen zu erhalten, die angezeigt werden, z. B. die Protokollausgabe eines laufenden Builds.

Speichern und schließen Sie die Nginx-Konfigurationsdatei. Laden Sie dann den Nginx-Dienst neu:

Öffnen Sie Ihren bevorzugten Webbrowser auf Ihrem lokalen Computer und rufen Sie die Buildbot-Weboberfläche auf, indem Sie die folgende URL aufrufen:

Wenn Sie keinen Domainnamen für Ihren Server eingerichtet haben, müssen Sie stattdessen die öffentliche IP-Adresse Ihres Servers eingeben: "+ http: /// buildbot / +".

Wenn Sie an der Schnittstelle ankommen, sehen Sie eine Übersicht ähnlich der folgenden:

image: https://assets.digitalocean.com/articles/buildbot_freebsd/web_interface_overview_final.png [Übersicht über die Weboberfläche]

Auf der Hauptseite wird möglicherweise eine Warnung angezeigt, dass die Buildbot-URL falsch konfiguriert ist. Dies tritt auf, wenn der in der Datei "+ nginx.conf +" angegebene Hostname nicht mit den Angaben in der Master-Buildbot-Konfiguration übereinstimmt. Da E-Mails mit Build-Ergebnissen standardmäßig Links zur Buildbot-Weboberfläche enthalten, muss der Master die richtige URL kennen, über die er erreichbar ist.

Beachten Sie, dass wir in unseren Beispielkonfigurationen diesen E-Mail-Service nicht eingerichtet haben. Wenn Sie dies konfigurieren möchten, finden Sie weitere Informationen unter Dokumentation about reporters von Buildbot:

Um die Warnung zu beheben und E-Mails mit dem richtigen Inhalt zu senden, müssen Sie die Buildbot-Masterkonfiguration so bearbeiten, dass sie auf Ihre Domain verweist.

Suchen Sie die Zeile, die mit "+ c [" buildbotURL "] " beginnt, und ersetzen Sie die Standardoption durch Ihren Domainnamen, gefolgt von " / buildbot / +":

/var/buildbot-master/master.cfg

Speichern und schließen Sie die Datei. Laden Sie anschließend den Dienst + buildbot + neu, um die neue Konfiguration anzuwenden:

Aktualisieren Sie die Buildbot-Weboberfläche in Ihrem Browser, und die Warnung wird ausgeblendet.

Continuous Integration-Server dienen häufig anderen Zwecken als CI. Ein CI-Server kann beispielsweise Build-Ausgaben für FreeBSD-Pakete oder -Protokolle über HTTPS liefern. Es wird daher empfohlen, den URL-Pfad "+ / buildbot / +" für das Webinterface zu reservieren. Auf diese Weise können Sie mehr Anwendungen unter verschiedenen Pfaden hosten. Im Moment erstellen wir eine einfache Homepage, die zur Weboberfläche umleitet. Sie können weitere Links hinzufügen, sobald Sie weitere Anwendungsfälle für den Webserver implementiert haben.

Führen Sie den folgenden Befehl aus, um eine Indexdatei in Ihrem Webstamm zu öffnen. Ersetzen Sie dabei "++" durch Ihre eigene Domäne, um eine automatische Umleitung zur Buildbot-Weboberfläche zu erstellen:

Ersetzen Sie vorhandenen Dateiinhalt durch die folgenden Zeilen:

/usr/local/www/nginx/index.html

Speichern und schließen Sie diese Datei und geben Sie dann Ihren Domainnamen oder Ihre IP-Adresse in die URL-Leiste Ihres Browsers ein. Es sollte Sie automatisch zur Buildbot-Oberfläche umleiten.

Sie haben die Installation aller Buildbot-Komponenten einschließlich der webbasierten Steuerungs- und Anzeigeoberfläche abgeschlossen. Führen Sie nach alledem einen tatsächlichen Build aus, wie in der Beispielkonfiguration angegeben, die wir für den Master eingerichtet haben.

Der Builder verfügt standardmäßig über einen Force-Scheduler, mit dem Sie Ihren ersten Build auslösen können. Klicken Sie in der Webschnittstelle auf * Builds *> * Builders *> * runtests *> * force *> * Start Build * und sehen Sie, wie der Build ausgeführt wird. Wenn Fehler auftreten, überprüfen Sie die Internetverbindung des Servers und ob alle abhängigen Pakete wie zuvor beschrieben installiert wurden.

image: https://assets.digitalocean.com/articles/buildbot_freebsd/sample_build_success.png [Beispiel für einen erfolgreichen Build]

Sie finden die Artefakte aus diesem Build (und anderen), indem Sie sich den Inhalt des Build-Verzeichnisses ansehen:

Sie haben erfolgreich ein permanent lauffähiges und vielseitiges CI-System konfiguriert und können nun mit der Implementierung Ihrer eigenen Builds beginnen.

In diesem Tutorial haben Sie das Erstellen von FreeBSD-Jails geübt und einige Grundlagen des Buildbot-Automatisierungsframeworks erlernt. Das Ergebnis war eine sofort einsatzbereite Installation. Um mehr über Buildbot und seine Konfiguration zu erfahren, empfehlen wir Ihnen, die official Buildbot documentation zu lesen.

Von hier aus können Sie Ihre eigenen Continuous Integration- und Automatisierungsverfahren implementieren. Um ein sicheres, stabiles und performantes Setup für die Produktion zu erhalten, können Sie die folgenden optionalen Konfigurationsschritte ausführen: