Агенты Azure Pipelines

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

Чтобы создать код или развернуть программное обеспечение с помощью Azure Pipelines, вам потребуется по крайней мере один агент. По мере роста базы кода и команды вам потребуется больше агентов.

При запуске конвейера система начинает одно или несколько заданий. Агент вычисляет инфраструктуру с установленным программным обеспечением агента, выполняющим одно задание одновременно.

Azure Pipelines предоставляет несколько различных типов агентов.

Локальные агенты

Агент, который вы настраиваете и управляете самостоятельно для выполнения заданий, является локальным агентом. Локальных агентов можно использовать в Azure Pipelines или в Azure DevOps Server, который ранее назывался Team Foundation Server (TFS). Локальные агенты обеспечивают расширенные возможности для установки зависимого программного обеспечения, необходимого для сборок и развертываний. Кроме того, кэши и конфигурации на уровне компьютера сохраняются от запуска до запуска, что может повысить скорость.

Агент можно установить на компьютер под управлением ОС Linux, macOS или Windows. Также можно установить агент в контейнере Docker. Дополнительные сведения об установке локального агента см. в следующих источниках:

• агент macOS
• Агент Linux
• Агент Windows
• Агент Docker

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

После установки агента на компьютере вы можете установить любое другое программное обеспечение на этом компьютере в соответствии с вашими заданиями.

Параллельные задания

Возможности

У каждого локального агента есть набор возможностей, указывающих на то, что он может сделать. Возможности — это пары "имя-значение", которые автоматически обнаруживаются программным обеспечением агента, называемыми системными возможностями или возможностями, которые определяются, называемые пользовательскими возможностями.

Программное обеспечение агента автоматически определяет различные системные возможности, такие как имя компьютера, тип операционной системы и версии определенного программного обеспечения, установленного на компьютере. Кроме того, переменные среды, определенные на компьютере, автоматически отображаются в списке системных возможностей.

При создании конвейера необходимо указать определенные требования агента. Система отправляет задание только агентам, имеющим возможности, соответствующие требованиям , указанным в конвейере. В результате возможности агента позволяют направлять задания определенным агентам.

Настройка требований

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

Настройка возможностей агента

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.

Коммуникации

Агент обменивается данными с Azure Pipelines или Azure DevOps Server, чтобы определить задание для запуска и сообщить о журналах и состоянии задания. Агент всегда инициирует эту связь. Все сообщения от агента в Azure Pipelines или Azure DevOps Server передаются по протоколу HTTP или HTTPS в зависимости от конфигурации агента. Эта модель извлечения позволяет агенту настраиваться в разных топологиях, как показано в следующих примерах.

Ниже приведен общий шаблон взаимодействия между агентом и Azure Pipelines или Azure DevOps Server.

1. Пользователь регистрирует агент в Azure Pipelines или Azure DevOps Server, добавив его в пул агентов. Для регистрации агента в этом пуле агентов необходимо быть администратором пула агентов. Удостоверение администратора пула агентов необходимо только во время регистрации и не сохраняется на агенте. Он не используется в дальнейшем для обмена данными между агентом и Azure Pipelines или Azure DevOps Server. После завершения регистрации агент скачивает маркер OAuth прослушивателя и использует его для прослушивания очереди заданий.

2. Агент прослушивает отправку нового запроса на задание в очереди заданий в Azure Pipelines/Azure DevOps Server с помощью длинного опроса HTTP. Когда задание доступно, агент скачивает задание и маркер OAuth для конкретного задания. Azure Pipelines/Azure DevOps Server создает кратковременный маркер для идентификатора с областью действия, указанного в конвейере. Маркер используется агентом для доступа или изменения ресурсов в Azure Pipelines или Azure DevOps Server в этом задании. Например, для доступа к исходному коду или отправке результатов теста.

3. Агент удаляет маркер OAuth для конкретного задания после завершения задания, а затем возвращается к проверке наличия нового запроса задания с помощью маркера OAuth прослушивателя.

Полезные данные сообщений, которыми обмениваются агент и Azure Pipelines или Azure DevOps Server, защищены с помощью асимметричного шифрования. Каждый агент имеет пару из открытого и закрытого ключей, причем открытый ключ обменивается данными с сервером во время регистрации. С помощью открытого ключа сервер шифрует полезные данные задания перед отправкой в агент. Агент расшифровывает содержимое задания с помощью соответствующего закрытого ключа. Этот метод защищает секреты, хранящиеся в конвейерах или группах переменных при обмене с агентом.

Аутентификация

Чтобы зарегистрировать агент, необходимо быть членом роли администратора в пуле агентов. Удостоверение администратора пула агентов необходимо только во время регистрации и не сохраняется на агенте. Он не используется при последующем взаимодействии между агентом и Azure Pipelines или Azure DevOps Server. Кроме того, чтобы настроить агента, необходимо иметь права локального администратора сервера.

При регистрации агента выберите один из следующих типов проверки подлинности, а программа установки агента запрашивает дополнительные сведения, необходимые для каждого типа проверки подлинности. Дополнительные сведения см. в разделе "Параметры проверки подлинности локального агента".

Метод проверки подлинности, используемый для регистрации агента, используется только во время регистрации агента. Дополнительные сведения о том, как агенты взаимодействуют с Azure Pipelines после регистрации, см. в статье "Взаимодействие с Azure Pipelines" или Azure DevOps Server.

Интерактивный процесс и служба

Локальный агент можно запустить как службу или как интерактивный процесс.

После настройки агента рекомендуется сначала попробовать его в интерактивном режиме, чтобы убедиться, что он работает. Для последующей эксплуатации рекомендуется запустить агент в одном из следующих режимов, чтобы он бесперебойно продолжал работу. Эти режимы также гарантируют, что агент будет запущен автоматически при перезапуске компьютера.

1. Как услуга. Для управления жизненным циклом агента можно использовать диспетчер служб операционной системы. Кроме того, при запуске агента в качестве службы лучше работать автоматически.

2. В качестве интерактивного процесса с включенным автоматическим входом в систему. В некоторых случаях может потребоваться интерактивный запуск агента для использования в рабочей среде, например для выполнения тестов пользовательского интерфейса. Когда агент настроен для работы в этом режиме, экранная заставка также отключается. Некоторые политики домена могут препятствовать включению автоматического входа в систему или отключению средства сохранения экрана. В таких случаях может потребоваться получить исключение из политики домена или запустить агент на компьютере рабочей группы, где политики домена не применяются.

   Примечание.

   При включении автоматического входа в систему или отключении средства сохранения экрана возникают риски безопасности, так как вы позволяете другим пользователям переходить к компьютеру и использовать учетную запись, которая автоматически входит в систему. Если агент настроен для работы таким образом, то вам необходимо обеспечить физическую защиту компьютера. Например, в безопасном объекте. Если вы используете удаленный рабочий стол для доступа к компьютеру, на котором работает агент с автоматическим входом, просто закрывая удаленный рабочий стол, компьютер будет заблокирован и все тесты пользовательского интерфейса, выполняемые в этом агенте, могут завершиться ошибкой. Чтобы избежать этого, используйте команду tscon для отключения от удаленного рабочего стола. Например:

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

Учетная запись агента

Независимо от того, выполняется ли агент в качестве службы или в интерактивном режиме, можно выбрать учетную запись компьютера, используемую для запуска агента. Выбор учетной записи агента зависит только от потребностей задач, выполняемых в заданиях сборки и развертывания.

Например, чтобы выполнять задачи с помощью проверка подлинности Windows для доступа к внешней службе, агент должен запустить учетную запись с доступом к этой службе. Однако при выполнении тестов пользовательского интерфейса, таких как Selenium или закодированные тесты пользовательского интерфейса, для которых требуется браузер, браузер запускается в контексте учетной записи агента.

В Windows следует использовать учетную запись службы, например сетевую службу или локальную службу. Эти разрешения учетных записей ограничены и срок действия паролей не истекает, то есть агенту требуется меньше управления с течением времени.

Эти учетные данные отличаются от учетных данных, используемых при регистрации агента в Azure Pipelines или Azure DevOps Server.

Версия агента и обновления

Вы можете просмотреть версию агента, перейдя к пулам агентов и выбрав вкладку "Возможности " для нужного агента, как описано в разделе "Настройка возможностей агента".

Чтобы активировать обновление агента программным способом, можно использовать API обновления агента, как описано в разделе "Как активировать обновления агента программным способом для конкретного пула агентов?".

Создайте папку "Агенты", если она отсутствует.

Вопросы и ответы

Разделы справки убедитесь, что у меня установлена последняя версия агента версии 2?

1. Перейдите на вкладку пулов агентов :

   1. Войдите в свою организацию (https://dev.azure.com/{yourorganization}).

   2. Выберите Azure DevOps, параметры организации.

      

   3. Выберите пулы агентов.

      

   1. Войдите в коллекцию проектов (http://your-server/DefaultCollection).

   2. Выберите Azure DevOps, параметры коллекции.

      

   3. Выберите пулы агентов.

      

   1. Выберите Azure DevOps, параметры коллекции.

      

   2. Выберите пулы агентов.

      

2. Щелкните пул, содержащий агент.

3. Убедитесь, что агент включен.

4. Перейдите на вкладку возможностей:

   1. На вкладке пулов агентов выберите нужный пул агентов .

      

   2. Выберите агенты и выберите нужный агент.

      

   3. Перейдите на вкладку " Возможности".

      

      Примечание.

      Размещенные корпорацией Майкрософт агенты не отображают системные возможности. Список программного обеспечения, установленного в агентах, размещенных корпорацией Майкрософт, см. в разделе "Использование размещенного майкрософт агента".

   1. На вкладке пулов агентов выберите нужный пул.

      

   2. Выберите агенты и выберите нужный агент.

      

   3. Перейдите на вкладку " Возможности".

      

   1. На вкладке пулов агентов выберите нужный пул.

      

   2. Выберите агенты и выберите нужный агент.

      

   3. Перейдите на вкладку " Возможности".

      

5. Agent.Version Найдите возможность. Это значение можно проверить на наличие последней опубликованной версии агента. Ознакомьтесь с агентом Azure Pipelines и проверьте страницу с наибольшим номером версии, указанным в списке.

6. Каждый агент автоматически обновляется при выполнении задачи, требующей более новой версии агента. Если вы хотите вручную обновить некоторые агенты, щелкните пул правой кнопкой мыши и выберите "Обновить все агенты".

Есть ли у локальных агентов преимущества в плане производительности по сравнению с агентами, размещенными на серверах Майкрософт?

Во многих случаях да. В частности:

• При использовании локального агента можно выполнять пошаговые сборки. Например, если вы определяете конвейер, который не очищает репозиторий и не выполняет чистую сборку, сборки обычно выполняются быстрее. Вы не получаете эти преимущества с агентом, размещенным корпорацией Майкрософт, если вы не используете такие функции, как кэширование, так как агент уничтожен после завершения конвейера.

• Для запуска вашей сборки агенту, размещенному на сервере Майкрософт, может потребоваться больше времени. Хотя для назначения задания агенту, размещенного корпорацией Майкрософт, иногда может потребоваться несколько минут, чтобы агент был выделен в зависимости от нагрузки на нашу систему.

Можно ли установить несколько локальных агентов на одном компьютере?

Да. Этот подход может работать хорошо для агентов, выполняющих задания, которые не используют много общих ресурсов. Например, можно попробовать использовать его для агентов, запускающих выпуски, которые в основном оркестрируют развертывания и не выполняют большого объема работ непосредственно на агенте.

Вы можете обнаружить, что в других случаях вы не получаете много эффективности, выполняя несколько агентов на одном компьютере. Например, для агентов, выполняющих сборки, которые используют много дисков и ресурсов ввода-вывода, может быть не стоит.

Вы также можете столкнуться с проблемами, если параллельные задания сборки используют одноэлементное развертывание средства, например пакеты npm. Например, одна сборка может обновить зависимость как раз в тот момент, когда она используется другой сборкой, и это может привести к снижению надежности результатов и ошибкам.

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