Runner-Befehle
Jeder Befehl ist champrep-code-runner <command>. Hinzufügen -h Fügen Sie „—“ vor einen beliebigen Befehl ein, um dessen Optionen anzuzeigen, zum Beispiel champrep-code-runner service -h.
Alltägliche Befehle
Abschnitt betitelt „Alltägliche Befehle“| Aufgabe | Befehl |
|---|---|
| Verbinden Sie diesen Rechner mit einem Runner | champrep-code-runner register --url https://code.champrep.com |
| Führen Sie den Befehl in diesem Terminal aus | champrep-code-runner run |
| Als Dienst installieren und starten | champrep-code-runner service install |
| Läuft er? | champrep-code-runner service status |
| Beenden Sie den Dienst (laufende Aufträge werden zuvor abgeschlossen) | champrep-code-runner service stop |
| Starten Sie ihn erneut | champrep-code-runner service start |
| Überprüfen Sie das Token des Runners | champrep-code-runner verify |
| Die installierte Version anzeigen | champrep-code-runner version |
| Überprüfen Sie die Konfigurationsdatei | champrep-code-runner check-config |
In einem Terminal ausführen
Abschnitt betitelt „In einem Terminal ausführen“champrep-code-runner runDer Runner läuft weiter und nimmt Aufträge entgegen, bis Sie ihn anhalten. Drücken Sie Strg+C Einmal drücken, um den Dienst nach Abschluss der laufenden Aufgaben zu beenden; drücken Sie erneut, um diese abzubrechen.
Als Dienst ausführen
Abschnitt betitelt „Als Dienst ausführen“Ein Dienst startet den Runner beim Systemstart und startet ihn nach einem Fehler neu. Registrieren Sie den Rechner zunächst: service install Eine Konfiguration ohne Runner wird abgelehnt.
sudo champrep-code-runner service install # install, enable at boot and startchamprep-code-runner service status # running, stopped or not installedsudo champrep-code-runner service stop # running jobs finish firstsudo champrep-code-runner service startsudo champrep-code-runner service uninstall # stop and remove the serviceservice status gibt Folgendes aus: running, stopped oder not installed. Er beendet sich mit dem Code 3, wenn der Dienst nicht läuft, sodass Skripte dies überprüfen können.
| Option | Bedeutung |
|---|---|
--config PATH | Die vom Dienst verwendete Konfiguration. |
--name NAME | Der Name des Dienstes. Verwenden Sie unterschiedliche Namen, um mehrere Runner mit unterschiedlichen Konfigurationen auf einem Rechner auszuführen. |
--user USER | Führen Sie den Dienst als diesen Benutzer statt als root oder LocalSystem aus. |
Als Root installiert der Runner einen systemd-Dienst mit dem Namen champrep-code-runner. Als anderer Benutzer wird ein Benutzerdienst installiert, der läuft, solange Sie angemeldet sind (verwenden Sie loginctl enable-linger um den Betrieb aufrechtzuerhalten). Sie können auch systemd direkt verwenden:
systemctl status champrep-code-runnerjournalctl -u champrep-code-runner -f # follow the logsFür den Docker-Executor benötigt der Dienstbenutzer Zugriff auf den Docker-Socket, was auf diesem Rechner den Rechten von „root“ entspricht. Verwenden Sie einen dedizierten Build-Rechner.
Als Root installiert der Runner einen LaunchDaemon (com.champrep.code-runner) der beim Systemstart gestartet wird. Als anderer Benutzer wird ein LaunchAgent installiert, der läuft, solange Sie angemeldet sind; dies eignet sich für Aufgaben, die den Schlüsselbund, den Simulator oder die Code-Signierung erfordern. Protokolle:
tail -f /Library/Logs/champrep-code-runner.log # LaunchDaemontail -f ~/Library/Logs/champrep-code-runner.log # LaunchAgentWindows
Abschnitt betitelt „Windows“In einer PowerShell-Eingabeaufforderung mit erhöhten Rechten:
champrep-code-runner.exe service installGet-Service champrep-code-runnerDer Dienst führt die Binärdatei direkt von ihrem aktuellen Speicherort aus, kopieren Sie sie daher zunächst an einen stabilen Speicherort. Die Protokolle werden gespeichert unter champrep-code-runner.log neben der Konfiguration (%ProgramData%\champrep-runner\).
Alle Befehle
Abschnitt betitelt „Alle Befehle“| Befehl | Was es leistet |
|---|---|
register | Überprüfen Sie ein Runner-Token und fügen Sie den Runner zur Konfiguration hinzu. |
verify [--name N] | Überprüft die Tokens der konfigurierten Runner; beendet den Vorgang mit dem Status 1, wenn eines ungültig ist. |
run | Läuft so lange, bis er gestoppt wird. --log-file PATH schreibt Protokolle in eine Datei. |
run-single [--name N] [--max-jobs 1] | Führt die Jobs eines Runners aus und beendet sich anschließend. Nützlich für kurzlebige Maschinen. |
service install|start|stop|status|uninstall | Verwalten Sie den Runner als Dienst. |
reset-token [--name N] | Beziehen Sie ein neues Token und speichern Sie es. Das alte Token bleibt für eine kurze Übergangszeit weiterhin gültig. |
unregister --name N oder --all | Entfernen Sie den Runner dieses Rechners aus der Konfiguration und aus CodeCHAMPREP. |
check-config | Überprüfen Sie die Konfigurationsdatei und geben Sie Warnungen aus. |
version | Geben Sie die Version, die Revision und die Plattform aus. |
Jeder Befehl akzeptiert --config PATH um eine andere Konfigurationsdatei zu verwenden.
Zustandsprüfungen und Metriken
Abschnitt betitelt „Zustandsprüfungen und Metriken“Starten Sie den Runner mit einer Listen-Adresse, um Endpunkte für den Betriebszustand und Metriken bereitzustellen:
champrep-code-runner run --listen-address 127.0.0.1:9252| Pfad | Bedeutung |
|---|---|
/healthz | 200, während der Prozess läuft. |
/readyz | 200, wenn jeder Runner verifiziert ist und Jobs anfordert. |
/metrics | Prometheus-Metriken: laufende, abgeschlossene und fehlgeschlagene Jobs sowie weitere Informationen. |
Protokolle sind als strukturiertes JSON angelegt und enthalten niemals Tokens, Variablen oder Job-Ausgaben.