GitLab ist eines der beliebtesten Quellcodeverwaltungssysteme, das eine breite Palette von Tools für die Softwareentwicklung bietet. Ein solches Tool ist GitLab Runner, mit dem Sie die Prozesse zum Erstellen, Testen und Bereitstellen von Software automatisieren können. In diesem Artikel erfahren Sie, wie Sie einen Läufer Schritt für Schritt mit Ihrer GitLab-Instance verbinden.
Schritt 1: Installieren Sie GitLab Runner. Bevor Sie beginnen, stellen Sie sicher, dass Sie Zugriff auf den Server haben, auf dem GitLab Runner installiert wird. Führen Sie dann den folgenden Befehl an der Eingabeaufforderung Ihres Servers aus:
curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo bash
Schritt 2: Installieren Sie den Läufer. Nachdem Sie das GitLab Runner-Repository erfolgreich installiert haben, führen Sie die folgenden Befehle aus:
sudo apt-get install gitlab-runner
Schritt 3: Registrieren Sie den Läufer. Jetzt, da Sie GitLab Runner installiert haben, müssen Sie ihn bei GitLab registrieren. Führen Sie dazu den folgenden Befehl aus:
sudo gitlab-runner register
Befolgen Sie die Anweisungen in der Befehlszeile und geben Sie die URL Ihrer GitLab-Instance, das Registrierungstoken des Läufers und andere erforderliche Informationen ein. Nach erfolgreicher Registrierung ist dein Läufer bereit zu gehen!
Installieren des Hitlab-Läufers auf dem Server
1. Laden Sie die neueste Version von Hitlab Runner gemäß der offiziellen GitLab-Dokumentation herunter und installieren Sie sie auf Ihrem Server. Sie benötigen Administratorrechte, um diese Schritte auszuführen.
2. Öffnen Sie nach der Installation eine Eingabeaufforderung auf dem Server und führen Sie den Befehl aus, um den Läufer zu registrieren:
| Das Team | Die Beschreibung |
|---|---|
| sudo gitlab-runner register | Läufer registrieren |
3. Führen Sie während der Registrierung die folgenden Schritte aus:
| Parameter | Die Beschreibung |
|---|---|
| URL GitLab | Geben Sie die URL Ihres GitLab-Servers an |
| Registrierungs-Token | Geben Sie das Registrierungstoken aus den Projekteinstellungen in GitLab an |
| Beschreibung des Läufers | Geben Sie dem Läufer einen aussagekräftigen Namen, um ihn auf dem GitLab-Server zu identifizieren |
| Läufer-Tags | Optional können Sie Tags für den Läufer angeben, um seine Verwendung einzuschränken |
| Verwenden Sie Docker | Optional geben Sie an, ob Sie Docker zum Ausführen von Läuferaufgaben verwenden |
4. Nach erfolgreicher Registrierung wird der Läufer automatisch zur Liste der Läufer Ihres Projekts in GitLab hinzugefügt. Sie können es jetzt verwenden, um CI/CD-Aufgaben in Ihrem Projekt auszuführen.
Erstellen eines Registrierungstoken in Hitlab
Um ein Registrierungstoken zu generieren, benötigen Sie Administratorrechte in Ihrem Hitlab.
Führen Sie die folgenden Schritte aus, um ein Registrierungstoken zu erstellen:
- Öffnen Sie die Hitlab-Weboberfläche und gehen Sie zu Einstellungen.
- Wählen Sie auf der Seite "Einstellungen" die Registerkarte "Registrierungstoken" aus
- Klicken Sie auf die Schaltfläche Registrierungstoken erstellen und legen Sie die gewünschten Zugriffsrechte fest.
- Kopieren Sie das generierte Registrierungstoken.
Nachdem Sie ein Registrierungstoken erstellt haben, können Sie es verwenden, wenn Sie einen Läufer einrichten, um sich mit Hitlab zu verbinden. Stellen Sie sicher, dass Sie das Token an einem sicheren Ort aufbewahren und es nicht mit anderen Personen teilen, da dieses Token Zugriff auf Ihr Konto in Hitlab ermöglicht.
Läufer-Konfiguration auf dem Server
1. Erstellen einer Konfigurationsdatei
Sie müssen eine Datei mit dem Namen "config" auf dem Server erstellen.toml", das die Konfigurationsparameter des Läufers enthält. Dies kann mit einem beliebigen Texteditor erfolgen.
2. Füllen der Konfigurationsdatei
Öffnen Sie die erstellte Datei "config.toml" und fügen Sie die folgenden Optionen hinzu:
Hier ist "Rangername" ein eindeutiger Name für Ihren Läufer, "GitLab-URL" ist die Adresse Ihres GitLab-Servers und "Ranger-Token" ist das Token, das Sie bei der Registrierung des Läufers erhalten haben.
Sie können auch andere Konfigurationsoptionen wie executor, limit usw. hinzufügen, je nach Ihren Bedürfnissen.
3. Speichern und Starten eines Läufers
Speichern Sie die Änderungen in der Konfigurationsdatei und starten Sie den Läufer mit dem Befehl:
Ihr Läufer sollte jetzt einsatzbereit sein und mit Ihrem GitLab-Server verbunden sein.
Hitlab-Läufer-Autorun einrichten
Mit dem Autorun von Hitlab Runner können Sie Einstellungen erstellen, damit der Läufer beim Systemstart automatisch gestartet wird. Dies ist praktisch, wenn Sie sicherstellen müssen, dass der Läufer kontinuierlich läuft, ohne dass ein manueller Start erforderlich ist.
Befolgen Sie die folgenden Schritte, um den Hitlab Runner Autoplay einzurichten:
- Öffnen Sie die Konfigurationsdatei - Suchen Sie nach der Läufer-Konfigurationsdatei, die normalerweise als config bezeichnet wird.toml oder config.yaml . Öffnen Sie diese Datei in einem Texteditor.
- Konfigurieren Sie die Einstellung autostart - Suchen Sie in der Konfigurationsdatei nach dem Autostart-Parameter. Setzen Sie den Wert auf true , um die automatische Wiedergabe des Läufers zu aktivieren.
- Speichern Sie die Konfigurationsdatei - Nachdem Sie die Änderungen vorgenommen haben, speichern Sie die Konfigurationsdatei und schließen Sie den Editor.
- Starten Sie das System neu - Damit die Änderungen wirksam werden, starten Sie das System neu oder führen Sie den Befehl zum Neustart des Läufers aus.
Nachdem Sie diese Schritte ausgeführt haben, wird der Hitlab Runner beim Systemstart automatisch gestartet. Dadurch wird sichergestellt, dass der Läufer ununterbrochen arbeitet und seine Funktionen verfügbar sind.
Überprüfen der erfolgreichen Verbindung des Läufers zu Hitlab
Nachdem Sie den Runner mit GitLab verbunden haben, müssen Sie überprüfen, ob die Verbindung erfolgreich war. Befolgen Sie diese Anleitung, um sicherzustellen, dass der Läufer richtig eingestellt und einsatzbereit ist.
- Gehen Sie zu Ihrer Projektseite in GitLab.
- Klicken Sie auf die Registerkarte "Einstellungen" und wählen Sie "CI/CD" oder "Continuous Integration/Continuous Deployment".
- Im Abschnitt "Runners" sollten Sie Ihren Läufer in der Liste der verfügbaren Läufer sehen. Wenn Sie Ihren Läufer sehen, bedeutet dies, dass die Verbindung erfolgreich war.
- Wenn Ihr Läufer nicht in der Liste angezeigt wird, überprüfen Sie die Einstellungen des Läufers, insbesondere die Einstellungen für das Registrierungstoken. Stellen Sie sicher, dass Sie das Token korrekt eingegeben und die Läufer-Einstellungen aktualisiert haben.
Wenn Sie Ihren Läufer in der Liste der verfügbaren Läufer sehen, bedeutet dies, dass seine Verbindung mit GitLab erfolgreich war. Jetzt sind Sie bereit, einen Läufer zu verwenden, um Ihre CI/CD-Aufgaben auszuführen.
Erweiterte Einstellungen und Unterstützung für Hitlab Läufer
Wenn Sie einen Hitlab-Läufer mit Ihrem Projekt verbinden, müssen Sie möglicherweise zusätzliche Einstellungen vornehmen, um sicherzustellen, dass er ordnungsgemäß funktioniert und vollständig unterstützt wird. Hier sind einige hilfreiche Tipps, um Ihnen dabei zu helfen:
1. Überprüfen Sie die Version von Hitlab Runner: Stellen Sie sicher, dass Sie die neueste Version von Hitlab Runner installiert haben und alle Abhängigkeiten korrekt eingerichtet sind. Sie können die Version überprüfen, indem Sie den Befehl ausführen gitlab-runner --version in der Befehlszeile.
2. Überprüfen Sie die Verfügbarkeit des Hitlab-Servers: Stellen Sie sicher, dass Ihr Hitlab-Server verfügbar ist und ordnungsgemäß funktioniert. Sie können versuchen, den Befehl auszuführen ping gitlab.com an einer Eingabeaufforderung, um die Verfügbarkeit des Servers zu überprüfen.
3. Überprüfen Sie die Läufer-Einstellungen: Stellen Sie sicher, dass Ihr Hitlab Runner korrekt eingerichtet und im richtigen Verzeichnis platziert ist. Sie können die Runner-Einstellungsdatei überprüfen, die sich normalerweise in /etc/gitlab-runner/config.toml.
4. Überprüfen Sie die Verfügbarkeit des Repositorys: Stellen Sie sicher, dass Ihr Hitlab-Repository für Ihren Hitlab-Läufer verfügbar ist. Überprüfen Sie die Berechtigungen für das Repository und die erforderlichen Schlüssel in den Runner-Einstellungen.
5. Aktualisieren Sie die Abhängigkeiten: Wenn Sie Probleme beim Ausführen des Hitlab-Läufers haben, versuchen Sie, alle Abhängigkeiten zu aktualisieren und den Läufer neu zu installieren. Dies kann helfen, Versionsinkompatibilitätsprobleme zu beheben.
Indem Sie diese Richtlinien befolgen, können Sie den Hitlab Runner für Ihr Projekt effizient und sicher einrichten und pflegen.
