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

Azure DevOps Services

Чтобы создать и развернуть Windows, Azure и другие решения Visual Studio, вам потребуется по крайней мере один агент Windows. Агенты Windows также могут создавать приложения Java и Android.

Сведения об агентах

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

Проверка предварительных требований

Убедитесь, что компьютер имеет следующие предварительные требования:

• Версия операционной системы
  • Клиентская ОС
    • Windows 7 с пакетом обновления 1 (SP1), ESU
    • Windows 8.1
    • Windows 10
    • Windows 11
  • ОС сервера
    • на нем установлена Windows Server 2012 или более поздней версии;
• Программное обеспечение агента устанавливает собственную версию .NET, поэтому не существует необходимых компонентов .NET.
• PowerShell 3.0 или более поздней версии
• Subversion — если вы создаете из репозитория Subversion , необходимо установить клиент Subversion на компьютере.
• Рекомендуемые средства сборки Visual Studio (2015 или более поздней версии)

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

Спецификации оборудования

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

Подготовка разрешений

Информационная безопасность для локальных агентов

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

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

Агент Azure Pipelines — это программный продукт, предназначенный для выполнения кода, скачиваемого из внешних источников. По сути это может быть мишенью для атак удаленного выполнения кода (RCE).

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

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

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

Определите, какой пользователь вы будете использовать

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

Убедитесь, что у пользователя есть разрешение

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

Является ли пользователь администратором Azure DevOps владелец организации или TFS или Azure DevOps Server? Остановитесь здесь, у вас есть разрешение.

В противном случае:

1. Откройте браузер и перейдите на вкладку пулов агентов для организации Azure Pipelines или сервера Azure DevOps Server или TFS:

   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. Если учетная запись пользователя, которую вы собираетесь использовать, не отображается, получите администратора, чтобы добавить его. Администратор может быть администратором пула агентов, владелец организации Azure DevOps или администратором TFS или Azure DevOps Server.

   Если это агент группы развертывания, администратор может быть администратором группы развертывания, владелец организации Azure DevOps или администратором TFS или Azure DevOps Server.

   Вы можете добавить пользователя в роль администратора группы развертывания на вкладке "Безопасность " на странице "Группы развертывания" в Azure Pipelines.

Скачивание и настройка агента

Azure Pipelines

1. Войдите на компьютер с помощью учетной записи, для которой вы подготовили разрешения, как описано выше.

2. В веб-браузере войдите в Azure Pipelines и перейдите на вкладку пулов агентов :

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

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

      

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

      

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

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

      

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

      

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

      

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

      

3. Выберите пул по умолчанию, перейдите на вкладку "Агенты" и выберите "Создать агент".

4. В диалоговом окне "Получение агента" выберите Windows.

5. На левой панели выберите архитектуру процессора установленной версии ОС Windows на компьютере. Версия агента x64 предназначена для 64-разрядной версии Windows, а версия x86 предназначена для 32-разрядных Windows. Если вы не уверены, какая версия Windows установлена, следуйте приведенным ниже инструкциям.

6. На правой панели нажмите кнопку "Скачать ".

7. Следуйте инструкциям на странице, чтобы скачать агент.

8. Распакуйте агент в выбранный каталог. Убедитесь, что путь к каталогу не содержит пробелов, так как средства и скрипты не всегда правильно экранные пространства. Рекомендуется C:\agentsиспользовать папку. Извлечение из папки загрузки или других пользовательских папок может привести к проблемам с разрешениями.

Установка агента

1. Запустите окно с повышенными привилегиями (PowerShell) и задайте расположение для распаковки агента.

   cd C:\agents 
   
   

2. Запустите config.cmd. В результате вы получите ряд вопросов для настройки агента.

   .\config.cmd
   
   

URL-адрес сервера

Тип проверки подлинности установки агента

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

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

Выбор интерактивного или служебного режима

Рекомендации по запуску агента в интерактивном режиме или в качестве службы см. в разделе "Агенты: интерактивная служба и служба".

Если вы решили запустить службу как службу (которую мы рекомендуем), имя пользователя, которое вы выполняете, должно быть 20 символов или меньше.

Запуск агента

Интерактивное выполнение

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

.\run.cmd

Чтобы перезапустить агент, нажмите клавиши CTRL+C, чтобы остановить агент, а затем запустите run.cmd его, чтобы перезапустить его.

variables:
 AZP_AGENT_CLEANUP_PSMODULES_IN_POWERSHELL: "true"

Запуск один раз

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

.\run.cmd --once

Агенты в этом режиме принимают только одно задание, а затем отключаются корректно (полезно для работы в Docker в службе, например Экземпляры контейнеров Azure).

Запуск от имени службы

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

• "Агент Azure Pipelines (имя агента)"
• "Агент VSTS (имя агента)"
• "vstsagent. (имя организации). (имя агента)"

Чтобы перезапустить агент, щелкните правой кнопкой мыши запись и выберите "Перезапустить".

Чтобы использовать агент, запустите задание с помощью пула агента. Если вы не выбрали другой пул, агент будет находиться в пуле по умолчанию .

Замена агента

Чтобы заменить агент, следуйте инструкциям по загрузке и настройке действий агента еще раз.

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

Удаление и перенастройка агента

Вот как удалить агент:

.\config remove

После удаления агента его можно настроить еще раз.

Автоматическая настройка

Агент можно настроить из скрипта без вмешательства человека. Необходимо передать --unattended и ответы на все вопросы.

Чтобы настроить агент, он должен знать URL-адрес вашей организации или коллекции и учетные данные пользователя, авторизованного для настройки агентов. Все остальные ответы являются необязательными. Любой параметр командной строки можно указать с помощью переменной среды: присвойте ей имя в верхнем регистре и предустановке VSTS_AGENT_INPUT_. Например, VSTS_AGENT_INPUT_PASSWORD вместо указания --password.

Обязательные параметры

• --unattended — настройка агента не будет запрашивать сведения, и все параметры должны быть предоставлены в командной строке.
• --url <url> — URL-адрес сервера. Например: https://dev.azure.com/myorganization или http://my-azure-devops-server:8080/tfs.
• --auth <type> — тип проверки подлинности. Допустимые значения:
  • pat (Личный маркер доступа)
  • SP (субъект-служба) (Требуется агент версии 3.227.1 или более поздней версии)
  • negotiate (Kerberos или NTLM)
  • alt (Обычная проверка подлинности)
  • integrated (Учетные данные Windows по умолчанию)

Варианты проверки подлинности

• Если вы выбрали --auth pat:
  • --token <token> — указывает личный маркер доступа
  • Вы также можете передать маркер OAuth 2.0 в качестве --token параметра.
• Если вы выбрали или--auth alt:--auth negotiate
  • --userName <userName> — указывает имя пользователя Windows в формате domain\userName или userName@domain.com
  • --password <password> — указывает пароль
• Если вы выбрали --auth SP:
  • --clientID <clientID> — указывает идентификатор клиента субъекта-службы с доступом к агентам регистрации
  • --tenantId <tenantID> — указывает идентификатор клиента, в котором зарегистрирован субъект-служба.
  • --clientSecret <clientSecret> — указывает секрет клиента субъекта-службы
  • Дополнительные сведения см. в разделе "Регистрация агента с помощью субъекта-службы "

Имена пулов и агентов

• --pool <pool> — имя пула для соединения агента
• --agent <agent> — имя агента
• --replace — замените агент в пуле. Если другой агент прослушивает то же имя, он начнет сбой с конфликтом

Настройка агента

• --work <workDirectory> — рабочий каталог, в котором хранятся данные задания. По умолчанию используется _work корневой каталог агента. Рабочий каталог принадлежит заданному агенту и не должен быть предоставлен общий доступ между несколькими агентами.
• --acceptTeeEula — примите лицензионное соглашение Team Explorer по всему миру (только macOS и Linux)
• --disableloguploads — не перенаправляйте или не отправляете выходные данные журнала консоли на сервер. Вместо этого вы можете получить их из файловой системы узла агента после завершения задания.

Запуск только для Windows

• --runAsService — настройка агента для запуска в качестве службы Windows (требуется разрешение администратора)
• --runAsAutoLogon — настройте автоматический вход и запустите агент при запуске (требуется разрешение администратора)
• --windowsLogonAccount <account> — используется или используется для --runAsService --runAsAutoLogon указания имени пользователя Windows в формате domain\userName или userName@domain.com
• --windowsLogonPassword <password> — используется с --runAsService паролем входа в Систему Windows ( --runAsAutoLogon не требуется для групповых управляемых учетных записей служб и Windows, встроенных учетных записей, таких как NT AUTHORITY\NETWORK SERVICE)
• --enableservicesidtypeunrestricted — используется для --runAsService настройки агента с типом SERVICE_SID_TYPE_UNRESTRICTED безопасности службы как (требуется разрешение администратора)
• --overwriteAutoLogon — используется для --runAsAutoLogon перезаписи существующего автоматического входа на компьютере
• --noRestart — используется для --runAsAutoLogon остановки перезапуска узла после завершения настройки агента

Устранение неполадок при настройке runAsAutoLogon агента с помощью параметра

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

Если агент уже настроен на компьютере

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

.\config.cmd remove --auth 'PAT' --token '<token>'

Проверьте, был ли агент удален из пула агентов после выполнения команды:

<Azure DevOps organization> / <Project> / Settings / Agent pools / <Agent Pool> / Agents

Удалите агент из пула агентов вручную, если он не был удален, выполнив команду.

Затем попробуйте перенастроить агент, выполнив следующую команду из папки агента:

.\config.cmd --unattended --agent '<agent-name>' --pool '<agent-pool-name>' --url '<azure-dev-ops-organization-url>' --auth 'PAT' --token '<token>' --runAsAutoLogon --windowsLogonAccount '<domain\user-name>' --windowsLogonPassword '<windows-password>'

Укажите имя агента (любое уникальное имя) и проверьте, появился ли этот агент в пуле агентов после перенастройки.

Гораздо лучше распаковывать архив агента (который можно скачать здесь) и выполнить эту команду из новой распаковки папки агента.

Проверка правильности записи и сохранения раздела реестра Windows

whoami /user Выполните команду, чтобы получить <sid>. Откройте Registry Editor и выполните следующий путь:

Computer\HKEY_USERS\<sid>\SOFTWARE\Microsoft\Windows\CurrentVersion\Run

Проверьте, есть VSTSAgent ли ключ. Удалите этот ключ, если он существует, а затем закройте Registry Editor и настройте агент, выполнив .\config.cmd команду (без args) из папки агента. Прежде чем ответить на вопрос Enter Restart the machine at a later time?, снова откройте Registry Editor и проверьте, появился ли VSTSAgent ключ. Нажмите, Enter чтобы ответить на вопрос, и проверьте, остается ли VSTSAgent ключ на месте после перезапуска компьютера.

Проверка правильности работы разделов реестра Windows на компьютере

autorun.cmd Создайте файл, содержащий следующую строку: echo "Hello from AutoRun!" Откройте Registry Editor и создайте путь над новой парой "ключ-значение" с ключом AutoRun и значением

C:\windows\system32\cmd.exe /D /S /C start "AutoRun" "D:\path\to\autorun.cmd"

Перезагрузите свой компьютер. У вас возникли проблемы с разделами реестра Windows, если окно консоли не отображается с сообщением Hello from AutoRun! .

Только группа развертывания

• --deploymentGroup — настройка агента в качестве агента группы развертывания
• --deploymentGroupName <name> — используется для --deploymentGroup указания группы развертывания для соединения агента
• --projectName <name> — используется для --deploymentGroup задания имени проекта
• --addDeploymentGroupTags — используется для --deploymentGroup указания того, что теги группы развертывания должны быть добавлены
• --deploymentGroupTags <tags> — используется для --addDeploymentGroupTags указания разделенного запятыми списка тегов для агента группы развертывания, например web, db.

Только среды

• --addvirtualmachineresourcetags — используется для указания, что теги ресурсов среды должны быть добавлены
• --virtualmachineresourcetags <tags> — используется для --addvirtualmachineresourcetags указания разделенного запятыми списка тегов агента ресурсов среды, например web, db.

.\config --help всегда перечисляет последние необходимые и необязательные ответы.

Диагностика

Если у вас возникли проблемы с локальным агентом, попробуйте запустить диагностика. После настройки агента:

.\run --diagnostics

Это приведет к выполнению набора диагностики, который может помочь устранить проблему. Функция диагностика доступна, начиная с версии агента 2.165.0.

Справка по другим параметрам

Чтобы узнать о других вариантах, выполните следующие действия.

.\config --help

Эта справка содержит сведения о альтернативных вариантах проверки подлинности и автоматической настройке.

Возможности

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

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

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

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

Какая версия Git выполняется агентом?

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

• Задайте переменную конвейера с именем System.PreferGitFromPath true в конвейерах.
• В локальных агентах можно создать файл с именем ENV в корневом каталоге агента и добавить System.PreferGitFromPath=true строку в файл. Дополнительные сведения см. в разделе Разделы справки задания различных переменных среды для каждого отдельного агента?

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

Syncing repository: PathFilter (Git)
Prepending Path environment variable with directory containing 'git.exe'.
git version
git version 2.26.2.windows.1

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

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. Каждый агент автоматически обновляется при выполнении задачи, требующей более новой версии агента. Если вы хотите вручную обновить некоторые агенты, щелкните пул правой кнопкой мыши и выберите "Обновить все агенты".

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

Запуск агента с самозаверяющий сертификат

Разделы справки запустить агент за веб-прокси?

Запуск агента за веб-прокси

Разделы справки перезапуск агента

Если агент запущен в интерактивном режиме, ознакомьтесь с инструкциями по перезапуску в интерактивном режиме. Если вы запускаете агент в качестве службы, перезапустите агент, выполнив действия, описанные в разделе "Запуск от имени службы".

MyEnv0=MyEnvValue0
MyEnv1=MyEnvValue1
MyEnv2=MyEnvValue2
MyEnv3=MyEnvValue3
MyEnv4=MyEnvValue4

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

Что такое включение SERVICE_SID_TYPE_UNRESTRICTED для службы агента?

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

Enter enable SERVICE_SID_TYPE_UNRESTRICTED for agent service (Y/N) (press enter for N)

Предыдущие версии программного обеспечения агента задают тип SERVICE_SID_TYPE_NONEидентификатора безопасности службы, который является значением по умолчанию для текущих версий агента. Чтобы настроить тип SERVICE_SID_TYPE_UNRESTRICTEDидентификатора службы безопасности, нажмите клавишу Y.

Дополнительные сведения см. в разделе SERVICE_SID_INFO структуры и идентификаторов безопасности.