Selbstgehostete Linux-Agents

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Zum Ausführen Ihrer Aufträge benötigen Sie mindestens einen Agent. Ein Linux-Agent kann verschiedene Arten von Apps erstellen und bereitstellen, einschließlich Java- und Android-Apps. Eine Liste der unterstützten Linux-Distributionen finden Sie unter Überprüfen der Voraussetzungen.

Informationen zu Agents

Wenn Sie bereits wissen, was ein Agent ist und wie er funktioniert, können Sie direkt mit den folgenden Abschnitten fortfahren. Wenn Sie jedoch mehr Hintergrundinformationen zu ihren Aufgaben und ihrer Funktionsweise benötigen, lesen Sie Azure Pipelines-Agents.

Überprüfen der Voraussetzungen

Sie sollten die Einrichtung des Agents beim ersten Mal manuell ausführen. Nachdem Sie ein Gefühl dafür bekommen haben, wie Agents funktionieren, oder wenn Sie die Einrichtung vieler Agents automatisieren möchten, sollten Sie die unbeaufsichtigte Konfiguration verwenden.

Vorbereiten von Berechtigungen

Informationssicherheit für selbstgehostete Agents

Der Benutzer, der den Agent konfiguriert, benötigt Pooladministratorberechtigungen, der Benutzer, der den Agent ausführt, jedoch nicht.

Die Ordner, die vom Agent gesteuert werden, sollten auf so wenige Benutzer wie möglich beschränkt werden, da sie Geheimnisse enthalten, die entschlüsselt oder exfiltriert werden können.

Der Azure Pipelines-Agent ist ein Softwareprodukt, das zum Ausführen von Code entwickelt wurde, der aus externen Quellen heruntergeladen wird. Es kann von Natur aus ein Ziel für RCE-Angriffe (Remote Code Execution, Remotecodeausführung) sein.

Daher ist es wichtig, das Bedrohungsmodell zu berücksichtigen, das jede einzelne Verwendung von Pipelines-Agents zum Ausführen von Aufgaben umgibt, und zu entscheiden, welche Mindestberechtigungen dem Benutzer, der den Agent ausführt, dem Computer, auf dem der Agent ausgeführt wird, den Benutzern, die Schreibzugriff auf die Pipelinedefinition haben, den Git-Repositorys, in denen die YAML-Datei gespeichert ist, oder der Gruppe von Benutzern, die den Zugriff auf den Pool für neue Pipelines steuern, erteilt werden können.

Es empfiehlt sich, die Identität, mit der der Agent ausgeführt wird, von der Identität mit Berechtigungen zum Verbinden des Agents mit dem Pool zu unterscheiden. Der Benutzer, der die Anmeldeinformationen (und andere Agent-bezogene Dateien) generiert, unterscheidet sich von dem Benutzer, der sie lesen muss. Daher ist es sicherer, den Zugriff auf den Agent-Computer selbst und die Agent-Ordner, die vertrauliche Dateien wie Protokolle und Artefakte enthalten, sorgfältig zu prüfen.

Es ist sinnvoll, nur DevOps-Administratoren und der Benutzeridentität, die den Agent-Prozess ausführt, Zugriff auf den Agent-Ordner zu gewähren. Administratoren müssen möglicherweise das Dateisystem untersuchen, um Buildfehler zu verstehen, oder Protokolldateien abrufen, um Azure DevOps-Fehler melden zu können.

Entscheiden, welchen Benutzer Sie verwenden möchten

In einem einmaligen Schritt müssen Sie den Agent registrieren. Jemand mit Berechtigung zum Verwalten der Agent-Warteschlange muss diese Schritte ausführen. Der Agent verwendet die Anmeldeinformationen dieser Person nicht im täglichen Betrieb, sie sind aber erforderlich, um die Registrierung abzuschließen. Erfahren Sie mehr über die Kommunikation von Agents.

Vergewissern Sie sich, dass der Benutzer über die Berechtigung verfügt

Vergewissern Sie sich, dass das Benutzerkonto, das Sie verwenden möchten, über die Berechtigung zum Registrieren des Agents verfügt.

Ist der Benutzer ein Azure DevOps-Organisationsbesitzer- oder TFS- oder Azure DevOps Server-Administrator? Dann müssen Sie nichts weiter tun: Sie verfügen über die nötige Berechtigung.

Andernfalls:

1. Öffnen Sie einen Browser, und navigieren Sie zur Registerkarte Agent-Pools für Ihre Azure Pipelines-Organisation oder Azure DevOps Server- oder TFS-Server:

   1. Melden Sie sich bei Ihrem organization (https://dev.azure.com/{yourorganization}) an.

   2. Wählen Sie Azure DevOps, Organisationseinstellungen aus.

      

   3. Wählen Sie Agentpools aus.

      

   1. Melden Sie sich bei Ihrer Projektsammlung unter http://your-server/DefaultCollection an.

   2. Wählen Sie Azure DevOps > Sammlungseinstellungen aus.

      

   3. Wählen Sie Agentpools aus.

      

   1. Wählen Sie Azure DevOps > Sammlungseinstellungen aus.

      

   2. Wählen Sie Agentpools aus.

      

2. Wählen Sie rechts auf der Seite den Pool aus, und klicken Sie dann auf Sicherheit.

3. Sollte das Benutzerkonto, das Sie verwenden möchten, nicht angezeigt werden, bitten Sie einen Administrator, es hinzuzufügen. Der Administrator kann ein Agent-Pooladministrator, Azure DevOps-Organisationsbesitzer oder TFS- oder Azure DevOps Server-Administrator sein.

   Wenn es sich um einen Bereitstellungsgruppen-Agent handelt, kann der Administrator ein Bereitstellungsgruppenadministrator, Azure DevOps-Organisationsbesitzer oder TFS- oder Azure DevOps Server-Administrator sein.

   Sie können der Administratorrolle der Bereitstellungsgruppe in Azure Pipelines auf der Seite Bereitstellungsgruppen auf der Registerkarte Sicherheit einen Benutzer hinzufügen.

Herunterladen und Konfigurieren des Agents

Server-URL

Authentifizierungsart

Wählen Sie bei der Registrierung eines Agents aus den folgenden Authentifizierungstypen aus. Sie werden daraufhin von der Agent-Einrichtung aufgefordert, die spezifischen zusätzlichen Informationen anzugeben, die für jeden Authentifizierungstyp erforderlich sind. Weitere Informationen finden Sie unter Authentifizierungsoptionen für selbstgehostete Agents.

Interaktive Ausführung

Informationen dazu, ob der Agent im interaktiven Modus oder als Dienst ausgeführt werden muss, finden Sie im Artikel „Azure Pipelines-Agents“ unter Interaktiv vs. Dienst.

So führen Sie den Agent interaktiv aus

1. Wenn Sie den Agent als Dienst ausgeführt haben, deinstallieren Sie den Dienst.

2. Führen Sie den Agent aus.

   ./run.sh
   

Um den Agent neu zu starten, drücken Sie STRG+C, und führen Sie dann run.sh aus, um ihn neu zu starten.

Um Ihren Agent zu verwenden, führen Sie einen Auftrag mithilfe des Agent-Pools aus. Wenn Sie keinen anderen Pool ausgewählt haben, wird Ihr Agent im Pool Standard platziert.

Einmalige Ausführung

Für Agents, die für die interaktive Ausführung konfiguriert sind, können Sie festlegen, dass der Agent nur einen einzelnen Auftrag akzeptieren soll. So führen Sie diese Konfiguration aus

./run.sh --once

Agents in diesem Modus akzeptieren nur einen einzelnen Auftrag und werden dann ordnungsgemäß heruntergefahren. (Dies ist nützlich für die Ausführung in Docker unter einem Dienst wie Azure Container Instances.)

Ausführung als systemd-Dienst

Wenn Ihr Agent unter diesen Betriebssystemen ausgeführt wird, können Sie den Agent als systemd-Dienst ausführen:

• Ubuntu 16 LTS oder höher
• Red Hat 7.1 oder höher

Wir stellen ein Beispielskript ./svc.sh bereit, mit dem Sie Ihren Agent als systemd-Dienst ausführen und verwalten können. Dieses Skript wird generiert, nachdem Sie den Agent konfiguriert haben. Wir empfehlen Ihnen, das Skript zu überprüfen und bei Bedarf zu aktualisieren, bevor Sie es ausführen.

Einige wichtige Einschränkungen:

• Wenn Sie Ihren Agent als Dienst ausführen, können Sie den Agentdienst nicht als root-Benutzer ausführen.
• Benutzer, die SELinux ausführen, haben Probleme mit dem bereitgestellten svc.sh-Skript gemeldet. Beziehen Sie sich auf dieses Agent-Problem als Ausgangspunkt. SELinux ist keine offiziell unterstützte Konfiguration.

Befehle

Wechseln zum Agent-Verzeichnis

Wenn Sie beispielsweise im Unterordner myagent Ihres Basisverzeichnisses installiert haben:

cd ~/myagent$

Installieren

Befehl:

sudo ./svc.sh install [username]

Dieser Befehl erstellt eine Dienstdatei, die auf ./runsvc.sh verweist. Dieses Skript richtet die Umgebung ein (weitere Details unten) und startet den Agentshost. Wenn der Parameter username nicht angegeben ist, wird der Benutzername aus der Umgebungsvariablen „$SUDO_USER“ übernommen, die mit dem Befehl sudo festgelegt wird. Diese Variable ist immer gleich dem Namen des Benutzers, der den Befehl sudo aufgerufen hat.

Start

sudo ./svc.sh start

Status

sudo ./svc.sh status

Beenden

sudo ./svc.sh stop

Deinstallieren

Sie sollten vor der Deinstallation beenden.

sudo ./svc.sh uninstall

Aktualisieren der Umgebungsvariablen

Wenn Sie den Dienst konfigurieren, benötigt er eine Momentaufnahme einiger nützlicher Umgebungsvariablen für Ihren aktuellen Anmeldebenutzer, z. B. PATH, LANG, JAVA_HOME, ANT_HOME und MYSQL_PATH. Wenn Sie die Variablen aktualisieren müssen (z. B. nach der Installation einer neuen Software):

./env.sh
sudo ./svc.sh stop
sudo ./svc.sh start

Die Momentaufnahme der Umgebungsvariablen wird in der Datei .env (PATH ist in .pathgespeichert) im Stammverzeichnis des Agents gespeichert. Sie können diese Dateien auch direkt ändern, um Änderungen an Umgebungsvariablen anzuwenden.

Ausführen von Anweisungen vor dem Starten des Diensts

Sie können auch eigene Anweisungen und Befehle ausführen, die beim Start des Diensts ausgeführt werden sollen. So können Sie beispielsweise die Umgebung einrichten oder Skripts aufrufen.

1. Bearbeiten Sie runsvc.sh.

2. Ersetzen Sie die folgende Zeile durch Ihre Anweisungen:

   # insert anything to setup env when running as a service
   

Dienstdateien

Wenn Sie den Dienst installieren, werden einige Dienstdateien eingerichtet.

systemd-Dienstdatei

Eine systemd-Dienstdatei wird erstellt:

/etc/systemd/system/vsts.agent.{tfs-name}.{agent-name}.service

Sie haben beispielsweise einen Agent (siehe oben) mit dem Namen our-linux-agent konfiguriert. Die Dienstdatei ist entweder:

• Azure Pipelines: der Name Ihrer Organisation. Wenn Sie z. B. eine Verbindung mit https://dev.azure.com/fabrikam herstellen, lautet der Dienstname /etc/systemd/system/vsts.agent.fabrikam.our-linux-agent.service

• TFS oder Azure DevOps Server: der Name Ihres lokalen Servers. Wenn Sie z. B. eine Verbindung mit http://our-server:8080/tfs herstellen, lautet der Dienstname /etc/systemd/system/vsts.agent.our-server.our-linux-agent.service

sudo ./svc.sh install generiert diese Datei aus dieser Vorlage: ./bin/vsts.agent.service.template

.service file

sudo ./svc.sh start findet den Dienst durch Lesen der .service-Datei, die den Namen der oben beschriebenen systemd-Dienstdatei enthält.

Alternative Dienstmechanismen

Wir stellen das ./svc.sh-Skript als bequeme Möglichkeit zur Ausführung und Verwaltung Ihres Agents als systemd-Dienst bereit. Sie können jedoch den von Ihnen bevorzugten Dienstmechanismus (z. B. initd oder upstart) verwenden.

Sie können die oben beschriebene Vorlage verwenden, um das Generieren anderer Arten von Dienstdateien zu erleichtern.

Verwenden einer cgroup zur Vermeidung von Agentfehlern

Es ist wichtig, Situationen zu vermeiden, in denen der Agent ausfällt oder unbrauchbar wird, da der Agent andernfalls keine Pipelineprotokolle streamen oder Pipeline-Status an den Server zurück streamen kann. Sie können das Risiko, dass diese Art von Problem durch hohen Arbeitsspeicherdruck verursacht wird, minimieren, indem Sie cgroups und einen niedrigeren oom_score_adj-Wert verwenden. Daraufhin fordert Linux den Systemspeicher von den Pipeline-Job-Prozessen zurück, bevor es den Speicher vom Agentprozess zurückfordert. Erfahren Sie, wie Sie cgroups und die OOM-Bewertung konfigurieren.

Ersetzen eines Agents

Um einen Agent zu ersetzen, führen Sie die Schritte unter Herunterladen und Konfigurieren des Agents erneut aus.

Wenn Sie einen Agent konfigurieren und dabei den Namen eines bereits vorhandenen Agents verwenden, werden Sie gefragt, ob Sie den vorhandenen Agent ersetzen möchten. Wenn Sie mit Y antworten, stellen Sie sicher, dass Sie den Agent entfernen (siehe unten), den Sie ersetzen. Andernfalls wird einer der Agents nach einigen Minuten des Konflikts heruntergefahren.

Entfernen und erneutes Konfigurieren eines Agents

So entfernen Sie den Agent

1. Beenden und deinstallieren Sie den Dienst, wie im vorherigen Abschnitt erläutert.

2. Entfernen Sie den Agent.

   ./config.sh remove
   

3. Geben Sie Ihre Anmeldeinformationen ein.

Nachdem Sie den Agent entfernt haben, können Sie ihn erneut konfigurieren.

Unbeaufsichtigte Konfiguration

Der Agent kann ohne menschliche Interaktion über ein Skript eingerichtet werden. Sie müssen --unattended und die Antworten auf alle Fragen übergeben.

./config.sh --help: listet immer die neuesten erforderlichen und optionalen Antworten auf.

Diagnose

Wenn Sie Probleme mit Ihrem selbstgehosteten Agent haben, können Sie versuchen, Diagnosen auszuführen. Nach dem Konfigurieren des Agents:

./run.sh --diagnostics

Dadurch wird eine Diagnosesuite ausgeführt, die Ihnen bei der Problembehandlung helfen kann. Das Diagnosefeature ist ab Agent-Version 2.165.0 verfügbar.

Hilfe zu anderen Optionen

So erfahren Sie mehr über andere Optionen

./config.sh --help

Die Hilfe enthält Informationen zu Authentifizierungsalternativen und zur unbeaufsichtigten Konfiguration.

Funktionen

Die Funktionen Ihres Agents werden katalogisiert und im Pool angekündigt, sodass ihm nur die Builds und Releases zugewiesen werden, die er bewältigen kann. Weitere Informationen finden Sie unter Funktionen von Build- und Release-Agents.

In vielen Fällen müssen Sie nach der Bereitstellung eines Agents Software oder Hilfsprogramme installieren. Im Allgemeinen sollten Sie alle Softwarekomponenten und Tools, die Sie auf Ihrem Entwicklungscomputer verwenden, auf Ihren Agents installieren.

Wenn Ihr Build beispielsweise die npm-Aufgabe enthält, wird der Build nur ausgeführt, wenn im Pool ein Build-Agent mit einer npm-Installation vorhanden ist.

Häufig gestellte Fragen

Wo erhalte ich weitere Informationen über die neue v3 -Agentsoftware?

Informationen und häufig gestellte Fragen zur v3-Agentsoftware finden Sie unter Agent-Softwareversion 3.

Wie kann ich sicherstellen, dass ich über die neueste Version des Agents verfüge?

1. Navigieren Sie zur Registerkarte Agent-Pools:

   1. Melden Sie sich bei Ihrem organization (https://dev.azure.com/{yourorganization}) an.

   2. Wählen Sie Azure DevOps, Organisationseinstellungen aus.

      

   3. Wählen Sie Agentpools aus.

      

   1. Melden Sie sich bei Ihrer Projektsammlung unter http://your-server/DefaultCollection an.

   2. Wählen Sie Azure DevOps > Sammlungseinstellungen aus.

      

   3. Wählen Sie Agentpools aus.

      

   1. Wählen Sie Azure DevOps > Sammlungseinstellungen aus.

      

   2. Wählen Sie Agentpools aus.

      

2. Klicken Sie auf den Pool, der den Agent enthält.

3. Stellen Sie sicher, dass der Agent aktiviert ist.

4. Navigieren Sie zur Registerkarte „Funktionen“:

   1. Wählen Sie auf der Registerkarte Agent-Pools den gewünschten Agent-Pool aus.

      

   2. Wählen Sie Agents und dann den gewünschten Agent aus.

      

   3. Wählen Sie die Registerkarte Funktionen aus.

      

      Hinweis

      Von Microsoft gehostete Agents zeigen keine Systemfunktionen an. Eine Liste der auf von Microsoft gehosteten Agents installierten Software finden Sie unter Verwenden eines von Microsoft gehosteten Agents.

   1. Wählen Sie auf der Registerkarte Agentpools den gewünschten Agentpool aus.

      

   2. Wählen Sie Agents und dann den gewünschten Agent aus.

      

   3. Wählen Sie die Registerkarte Funktionen aus.

      

   1. Wählen Sie auf der Registerkarte Agentpools den gewünschten Agentpool aus.

      

   2. Wählen Sie Agents und dann den gewünschten Agent aus.

      

   3. Wählen Sie die Registerkarte Funktionen aus.

      

5. Suchen Sie nach der Agent.Version-Funktion. Sie können diesen Wert anhand der neuesten veröffentlichten Agent-Version überprüfen. Weitere Informationen finden Sie unter Azure Pipelines-Agent. Suchen Sie auf der Seite nach der höchsten Versionsnummer.

6. Jeder Agent aktualisiert sich automatisch, wenn er eine Aufgabe ausführt, die eine neuere Version des Agents erfordert. Wenn Sie einige Agents manuell aktualisieren möchten, klicken Sie mit der rechten Maustaste auf den Pool, und wählen Sie Alle Agents aktualisieren aus.

Warum wird sudo benötigt, um die Dienstbefehle auszuführen?

./svc.sh verwendet systemctl, das sudo benötigt.

Quellcode: systemd.svc.sh.template auf GitHub

Wie kann ich den Agent mit einem selbstsigniertem Zertifikat ausführen?

Ausführen des Agents mit selbstsigniertem Zertifikat

Wie kann ich den Agent hinter einem Webproxy ausführen?

Ausführen des Agents hinter einem Webproxy

Wie kann ich den Agent neu starten?

Wenn Sie den Agent interaktiv ausführen, lesen Sie die Neustartanweisungen unter Interaktiv ausführen. Wenn Sie den Agent als systemd-Dienst ausführen, führen Sie die Schritte unter Beenden und dann Starten des Agents aus.

https://login.microsoftonline.com
https://app.vssps.visualstudio.com 
https://{organization_name}.visualstudio.com
https://{organization_name}.vsrm.visualstudio.com
https://{organization_name}.vstmr.visualstudio.com
https://{organization_name}.pkgs.visualstudio.com
https://{organization_name}.vssps.visualstudio.com

https://dev.azure.com
https://*.dev.azure.com
https://login.microsoftonline.com
https://management.core.windows.net
https://vstsagentpackage.azureedge.net
https://vssps.dev.azure.com

TFVC-Voraussetzungen

Wenn Sie TFVC verwenden, benötigen Sie auch Oracle Java JDK 1.6 oder höher. (Oracle JRE und OpenJDK sind für diesen Zweck nicht ausreichend.)

Das TEE-Plug-In wird für TFVC-Funktionen verwendet. Es verfügt über eine EULA, die Sie während der Konfiguration akzeptieren müssen, wenn Sie mit TFVC arbeiten möchten.

Da das TEE-Plug-In nicht mehr gepflegt wird und einige veraltete Java-Abhängigkeiten enthält, ist es ab Agent 2.198.0 nicht mehr in der Agent-Distribution enthalten. Das TEE-Plug-In wird jedoch während der Ausführung der Checkoutaufgabe heruntergeladen, wenn Sie ein TFVC-Repository auschecken. Das TEE-Plug-In wird nach der Auftragsausführung entfernt.

Wenn der Agent hinter einem Proxy oder einer Firewall ausgeführt wird, müssen Sie den Zugriff auf die folgende Website sicherstellen: https://vstsagenttools.blob.core.windows.net/. Das TEE-Plug-In wird von dieser Adresse heruntergeladen.

Wenn Sie einen selbstgehosteten Agent verwenden und Probleme beim Herunterladen von TEE auftreten, können Sie TEE manuell installieren:

1. Legen Sie die Umgebungs- oder Pipelinevariable DISABLE_TEE_PLUGIN_REMOVAL auf true fest. Diese Variable verhindert, dass der Agent das TEE-Plug-In nach dem Auschecken des TFVC-Repositorys entfernt.
2. Laden Sie TEE-CLC Version 14.135.0 manuell von GitHub aus „Releases“ für Team Explorer Everywhere herunter.
3. Extrahieren Sie den Inhalt des Ordners TEE-CLC-14.135.0 in <agent_directory>/externals/tee.