Azure Pipelines-ügynökök

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

A kód létrehozásához vagy a szoftver Azure Pipelines használatával történő üzembe helyezéséhez legalább egy ügynökre van szükség. A kódbázis és a csapat növekedésének megfelelően több ügynökre van szüksége.

A folyamat futtatásakor a rendszer egy vagy több feladatot kezd el. Az ügynök egy olyan telepített ügynökszoftverrel rendelkező számítási infrastruktúra, amely egyszerre egy feladatot futtat.

Az Azure Pipelines számos különböző típusú ügynököt biztosít.

Saját üzemeltetésű ügynökök

A feladatok futtatásához önállóan beállított és felügyelt ügynök egy saját üzemeltetésű ügynök. Használhat saját üzemeltetésű ügynököket az Azure Pipelinesban vagy az Azure DevOps Serverben. A saját üzemeltetésű ügynökökkel jobban szabályozható a buildekhez és üzembe helyezésekhez szükséges függő szoftverek telepítése. A gépi szintű gyorsítótárak és konfigurációk futásról futtatásra is megmaradnak, ami növelheti a sebességet.

Az ügynököt Linux, macOS vagy Windows rendszerű számítógépre telepítheti. Ügynököt telepíthet Docker-tárolóba is. További információk a saját üzemeltetésű ügynök telepítéséről:

• macOS-ügynök
• Linux-ügynök
• Windows-ügynök
• Docker-ügynök

xattr -c vsts-agent-osx-x64-V.v.v.tar.gz  ## replace V.v.v with the version in the filename downloaded.

# then unpack the gzip tar file normally:

tar xvfz vsts-agent-osx-x64-V.v.v.tar.gz

Miután telepítette az ügynököt egy gépre, a feladatoknak megfelelően bármilyen más szoftvert telepíthet a gépre.

Párhuzamos feladatok

Képességek

Minden saját üzemeltetésű ügynök rendelkezik olyan képességekkel, amelyek jelzik, hogy mire képes. A képességek név-érték párok, amelyeket az ügynökszoftver automatikusan felderít, úgynevezett rendszerképességek vagy az Ön által definiált képességek, úgynevezett felhasználói képességek.

Az ügynökszoftver automatikusan meghatározza a különböző rendszerképességeket, például a gép nevét, az operációs rendszer típusát és a gépen telepített egyes szoftverek verzióit. Emellett a gépen definiált környezeti változók automatikusan megjelennek a rendszerképességek listájában.

Folyamat létrehozásakor meg kell adnia az ügynök bizonyos követelményeit . A rendszer csak azoknak az ügynököknek küldi el a feladatot, amelyek rendelkeznek a folyamatban megadott követelményeknek megfelelő képességekkel. Ennek eredményeképpen az ügynök képességei lehetővé teszik a feladatok adott ügynökökhöz való irányítását.

Igények konfigurálása

pool:
  name: Default
  demands: SpecialSoftware # exists check for SpecialSoftware

Ügynök képességeinek konfigurálása

az pipelines agent list --pool-id
                        [--agent-name]
                        [--demands]
                        [--detect {false, true}]
                        [--include-assigned-request {false, true}]
                        [--include-capabilities {false, true}]
                        [--include-last-completed-request {false, true}]
                        [--org]
                        [--subscription]

az pipelines agent list --pool-id 4 --output table

ID    Name          Is Enabled    Status    Version
----  ------------  ------------  --------  ---------
3     Hosted Agent  True          offline   2.155.1

az pipelines agent show --agent-id
                        --pool-id
                        [--detect {false, true}]
                        [--include-assigned-request {false, true}]
                        [--include-capabilities {false, true}]
                        [--include-last-completed-request {false, true}]
                        [--org]
                        [--subscription]

  <Some properties omitted for space>

  "status": "offline",
  "statusChangedOn": null,
  "systemCapabilities": {
    "ANDROID_HOME": "",
    "ANDROID_NDK_HOME": "",
    "Agent.Name": "Hosted Agent",
    "Agent.Version": "2.160.1",

    <Some capabilities omitted for space>

    "sh": "",
    "subversion": "",
    "svn": "",
    "To run tasks using Windows authentication to access an external service, the agent must run under an account with access to that service.

Kommunikáció

Az ügynök az Azure Pipelinesszal vagy az Azure DevOps Serverrel kommunikálva állapítja meg, hogy melyik feladatot kell futtatnia, és jelenti a naplókat és a feladat állapotát. Az ügynök mindig kezdeményezi ezt a kommunikációt. Az ügynök minden üzenetet HTTP-n vagy HTTPS-en keresztül küld el az Azure Pipelinesnak vagy az Azure DevOps Servernek, attól függően, hogy hogyan konfigurálta az ügynököt. Ez a lekéréses modell lehetővé teszi az ügynök konfigurálását különböző topológiákban az alábbi példák szerint.

Íme egy gyakori kommunikációs minta az ügynök és az Azure Pipelines vagy az Azure DevOps Server között.

1. A felhasználó egy ügynököt regisztrál az Azure Pipelinesban vagy az Azure DevOps Serverben egy ügynökkészlethez való hozzáadással. Ügynökkészlet-rendszergazdának kell lennie ahhoz, hogy egy ügynököt regisztráljon az adott ügynökkészletben. Az ügynökkészlet rendszergazdájának identitására csak a regisztrációkor van szükség, és nem marad meg az ügynökön. Nem használható az ügynök és az Azure Pipelines vagy az Azure DevOps Server közötti további kommunikációban. A regisztráció befejezése után az ügynök letölt egy figyelő OAuth-jogkivonatot , és a feladatsor figyelésére használja.

2. Az ügynök figyeli, hogy van-e új feladatkérés közzétéve az Azure Pipelines/Azure DevOps Server feladatsorában egy HTTP hosszú lekérdezés használatával. Ha egy feladat elérhető, az ügynök letölti a feladatot és egy feladatspecifikus OAuth-jogkivonatot. Az Azure Pipelines/Azure DevOps Server létrehoz egy rövid élettartamú jogkivonatot a folyamatban megadott hatókörű identitáshoz. A jogkivonatot az ügynök használja az Azure Pipelines vagy az Azure DevOps Server erőforrásainak elérésére vagy módosítására a feladaton belül. Például a forráskód eléréséhez vagy a teszteredmények feltöltéséhez.

3. Az ügynök a feladat befejezése után elveti a feladatspecifikus OAuth-jogkivonatot, majd visszatér annak ellenőrzéséhez, hogy van-e új feladatkérés a figyelő OAuth-jogkivonatával.

Az ügynök és az Azure Pipelines/Azure DevOps Server közötti üzenetek hasznos adattartalmát aszimmetrikus titkosítás védi. Minden ügynök rendelkezik egy nyilvános-privát kulcspárral, és a regisztráció során cserél nyilvános kulcsot a kiszolgálóval. A kiszolgáló a nyilvános kulccsal titkosítja a feladat hasznos adattartalmát, mielőtt elküldené az ügynöknek. Az ügynök a privát kulccsal oldja fel a feladat tartalmának titkosítását. Ez a módszer biztosítja a folyamatokban vagy változócsoportokban tárolt titkos kulcsokat az ügynökkel való csere során.

Hitelesítés

Az ügynök regisztrálásához a rendszergazdai szerepkör tagjának kell lennie az ügynökkészletben. Az ügynökkészlet rendszergazdájának identitására csak a regisztrációkor van szükség, és nem marad meg az ügynökön. Az ügynök és az Azure Pipelines vagy az Azure DevOps Server közötti későbbi kommunikációban nem használatos. Emellett helyi rendszergazdának is kell lennie a kiszolgálón, hogy konfigurálhassa az ügynököt.

Ügynök regisztrálásakor válasszon a következő hitelesítési típusok közül, és az ügynökbeállítás rákérdez az egyes hitelesítési típusokhoz szükséges további információkra. További információ: Saját üzemeltetésű ügynökhitelesítési lehetőségek.

Az ügynök regisztrálásához használt hitelesítési módszer csak az ügynökregisztráció során használatos. Ha többet szeretne megtudni arról, hogy az ügynökök hogyan kommunikálnak az Azure Pipelinesszal a regisztráció után, tekintse meg az Azure Pipelinesszal vagy az Azure DevOps Serverrel való kommunikációt.

Interaktív működés vagy szolgáltatás

A saját üzemeltetésű ügynököt szolgáltatásként és interaktív folyamatként is futtathatja.

Az ügynök konfigurálása után javasoljuk, hogy először interaktív módban próbálja ki, hogy biztosan működjön. Ezután, az éles használat során már ajánlott az ügynököt az alábbi módok valamelyikében futtatni, hogy megbízhatóan futó állapotban maradjon. Ezek a módok azt is biztosítják, hogy az ügynök automatikusan elinduljon a számítógép újraindításakor.

1. Szolgáltatásként. Az operációs rendszer szolgáltatáskezelőjével kezelheti az ügynök életciklusát. Emellett az ügynök automatikus felminősítésének élménye jobb, ha az ügynököt szolgáltatásként futtatja.

2. Interaktív folyamatként, amelyen engedélyezve van az automatikus bejelentkezés. Bizonyos esetekben az ügynököt szükséges lehet interaktívan futtatni éles környezetben, például a felhasználói felület teszteléséhez. Ha az ügynök úgy van konfigurálva, hogy ebben a módban fusson, akkor a képernyőkímélő is le van tiltva. Egyes tartományi szabályzatok megakadályozhatják az automatikus bejelentkezés engedélyezését vagy a képernyőkímélő letiltását. Ilyen esetekben előfordulhat, hogy kivételt kell kérnie a tartományházirend alól, vagy olyan munkacsoport-számítógépen kell futtatnia az ügynököt, ahol a tartományi szabályzatok nem érvényesek.

   Feljegyzés

   Biztonsági kockázatot jelent, ha engedélyezi az automatikus bejelentkezést, vagy letiltja a képernyőkímélőt, mert lehetővé teszi, hogy más felhasználók lépjenek fel a számítógépre, és használják azt a fiókot, amely automatikusan bejelentkezik. Ha úgy konfigurálja az ügynököt, hogy így fusson, győződjön meg arról, hogy a számítógép fizikailag védett; például egy biztonságos létesítményben található. Ha a Távoli asztal használatával éri el azt a számítógépet, amelyen egy ügynök autologonnal fut, egyszerűen zárja be a Távoli asztalt, a számítógép zárolva lesz, és az ügynökön futó felhasználói felületi tesztek sikertelenek lehetnek. A probléma elkerülése érdekében a tscon paranccsal válassza le a távoli asztalról. Példa:

   %windir%\System32\tscon.exe 1 /dest:console

Ügynökfiók

Akár szolgáltatásként, akár interaktívan futtat ügynököt, kiválaszthatja, hogy melyik számítógépfiókot használja az ügynök futtatásához. Az ügynökfiók kiválasztása kizárólag a buildelési és üzembehelyezési feladatokban futó feladatok igényeitől függ.

Ha például windowsos hitelesítéssel szeretne feladatokat futtatni egy külső szolgáltatás eléréséhez, az ügynöknek egy, a szolgáltatáshoz hozzáféréssel rendelkező fiókkal kell futnia. Ha azonban olyan felhasználói felületi teszteket futtat, mint a szelén vagy a böngészőt igénylő kódolt felhasználói felületi tesztek, a böngésző az ügynökfiók kontextusában indul el.

Windows rendszeren érdemes megfontolni egy olyan szolgáltatásfiók használatát, mint a Hálózati szolgáltatás vagy a Helyi szolgáltatás. Ezek a fiókok engedélyei korlátozottak, és a jelszavaik nem járnak le, ami azt jelenti, hogy az ügynöknek idővel kevesebb felügyeletre van szüksége.

Ezek a hitelesítő adatok eltérnek az ügynök Azure Pipelinesban vagy Azure DevOps Serverben való regisztrálásakor használt hitelesítő adatoktól.

Ügynök verziója és frissítései

Az ügynök verziójának megtekintéséhez navigáljon az ügynökkészletekre, és válassza a kívánt ügynök Képességek lapját az ügynök képességeinek konfigurálása című cikkben leírtak szerint.

Az ügynökfrissítés programozott aktiválásához használhatja az Ügynökfrissítési API-t a Hogyan aktiválhatom programozott módon az ügynökfrissítéseket az adott ügynökkészlethez? című szakaszban leírtak szerint.

Hozza létre az Ügynökök mappát, ha nincs jelen.

Ügynök katalógusstruktúra

Ha a folyamatfeladatok ügynökökön futnak, létrejön egy címtárstruktúra a forráskód, a bináris fájlok és az összetevők tárolásához.

Az ügynök kezdőkönyvtára az a könyvtár, amelyben az ügynök telepítve van. A könyvtár tipikusan itt található:

• Microsoft által üzemeltetett ügynökök: windowsosC:\agents\<agent version>, macOS /Users/runner/runners/<agent version> és Linuxon /home/vsts/agents/<agent version>.
• saját üzemeltetésű ügynökök: windowsosC:\agent, macOS rendszeren Users/<username>/agent (~/agent) és Linuxon /home/vsts/agent.

Az ügynök munkakönyvtára tartalmazza azt a munkaterületet, ahol a forrás- és feladatkimenet tárolódik. A munkakönyvtár általában itt található:

• Microsoft által üzemeltetett ügynök: windowsosC:\a, macOS-en /Users/runner/work és Linuxon/home/vsts/work.
• saját üzemeltetésű ügynök: windowsosC:\agent\_work, macOS-en ~/agent/work és Linuxon /home/agent/_work.

A munkakönyvtár struktúrája a következő:

    - /work directory
        - /1 build directory/pipeline workspace
            - /s source/working directory
            - /b binaries directory
            - /a artifacts staging directory
            - /TestResults Test results directory

A Microsoft által üzemeltetett ügynökökön minden futtatáskor más-más ügynököt használnak, ezért a munkakönyvtár nem marad meg a futtatások között. A saját üzemeltetésű ügynökök esetében a futtatások között alapértelmezés szerint csak az előkészítési könyvtárat és a teszteredmény-könyvtárakat távolítja el a rendszer. További információ a munkaterület tiszta beállításáról: Munkaterület.

Az előre definiált változókról további információt Előre definiált változókcímű témakörben talál.

GYIK

Hogyan győződjön meg arról, hogy a legújabb ügynökverzióval rendelkezem?

1. Lépjen az Ügynökkészletek lapra:

   1. Jelentkezzen be a szervezetébe (https://dev.azure.com/{yourorganization}).

   2. Válassza az Azure DevOps szervezeti beállításait.

      

   3. Válassza az Ügynökkészletek lehetőséget.

      

   1. Jelentkezzen be a projektgyűjteménybe (http://your-server/DefaultCollection).

   2. Válassza az Azure DevOps gyűjteménybeállításait.

      

   3. Válassza az Ügynökkészletek lehetőséget.

      

   1. Válassza az Azure DevOps gyűjteménybeállításait.

      

   2. Válassza az Ügynökkészletek lehetőséget.

      

2. Kattintson az ügynököt tartalmazó készletre.

3. Győződjön meg arról, hogy az ügynök engedélyezve van.

4. Lépjen a Képességek lapra:

   1. Az Ügynökkészletek lapon válassza ki a kívánt ügynökkészletet.

      

   2. Válassza ki az Ügynökök lehetőséget, és válassza ki a kívánt ügynököt.

      

   3. Válassza a Képességek lapot.

      

      Feljegyzés

      A Microsoft által üzemeltetett ügynökök nem jelenítik meg a rendszer képességeit. A Microsoft által üzemeltetett ügynökökre telepített szoftverek listáját a Microsoft által üzemeltetett ügynök használata című témakörben találja.

   1. Az Ügynökkészletek lapon válassza ki a kívánt készletet.

      

   2. Válassza ki az Ügynökök lehetőséget, és válassza ki a kívánt ügynököt.

      

   3. Válassza a Képességek lapot.

      

   1. Az Ügynökkészletek lapon válassza ki a kívánt készletet.

      

   2. Válassza ki az Ügynökök lehetőséget, és válassza ki a kívánt ügynököt.

      

   3. Válassza a Képességek lapot.

      

5. Keresse meg a Agent.Version képességet. Ezt az értéket a legújabb közzétett ügynökverzióval ellenőrizheti. Tekintse meg az Azure Pipelines-ügynököt , és ellenőrizze a listán szereplő legmagasabb verziószámot.

6. Minden ügynök automatikusan frissíti magát, amikor olyan feladatot futtat, amely az ügynök újabb verzióját igényli. Ha manuálisan szeretne frissíteni néhány ügynököt, kattintson a jobb gombbal a készletre, és válassza az Összes ügynök frissítése lehetőséget.

Vannak a saját üzemeltetésű ügynökök teljesítménybeli előnyei a Microsoft által üzemeltetett ügynökökkel szemben?

Számos esetben igen. Ezek konkrétan a következők:

• Ha saját üzemeltetésű ügynököt használ, növekményes buildeket futtathat. Ha például olyan folyamatot határoz meg, amely nem tisztítja meg az adattárat, és nem végez tiszta buildet, a buildek általában gyorsabban futnak. Ezek az előnyök csak akkor érhetők el a Microsoft által üzemeltetett ügynökkel, ha olyan funkciókat használ, mint a gyorsítótárazás , mert az ügynök a folyamat befejezése után megsemmisül.

• A Microsoft által üzemeltetett ügynökök létrehozása hosszabb időt is igénybe vehet. Bár a feladat microsoftos üzemeltetésű ügynökhöz való hozzárendelése gyakran csak néhány másodpercet vesz igénybe, a rendszer terhelésétől függően néha több percet is igénybe vehet egy ügynök lefoglalása.

Telepíthetek több saját üzemeltetésű ügynököt ugyanarra a gépre?

Igen. Ez a megközelítés jól használható az olyan ügynökök számára, amelyek olyan feladatokat futtatnak, amelyek nem használnak sok megosztott erőforrást. Kipróbálhatja például azokat az ügynököket, amelyek olyan kiadásokat futtatnak, amelyek többnyire az üzembe helyezéseket vezényelik, és nem dolgoznak sokat az ügynökön.

Előfordulhat, hogy más esetekben nem kap sok hatékonyságot, ha több ügynököt futtat ugyanazon a gépen. Előfordulhat például, hogy nem érdemes olyan ügynököknek, amelyek olyan buildeket futtatnak, amelyek sok lemezt és I/O-erőforrást használnak fel.

Akkor is problémákba ütközhet, ha a párhuzamos buildelési feladatok ugyanazt az egytonos eszköztelepítést használják, például npm-csomagokat. Az egyik build például frissíthet egy függőséget, míg egy másik build a használat közepén van, ami megbízhatatlan eredményeket és hibákat okozhat.

POST https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/messages?agentId={agentId}&api-version=6.0

POST https://{server url}/tfs/{collection}/_apis/distributedtask/pools/{poolId}/messages?agentId={agentId}&api-version=6.0