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

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

Для выполнения заданий вам потребуется по крайней мере один агент. Агент Linux может создавать и развертывать различные виды приложений, включая приложения Java и Android. Ознакомьтесь со сведениями о предварительных требованиях для списка поддерживаемых дистрибутивов Linux.

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

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

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

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

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

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

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

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

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

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

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

Имеет смысл предоставить доступ к папке агента только для администраторов DevOps и удостоверения пользователя, выполняющего процесс агента. Администратор istrator может потребоваться исследовать файловую систему, чтобы понять сбои сборки или получить файлы журналов, чтобы сообщить о сбоях 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.

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

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

Тип аутентификации

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

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

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

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

1. Если вы работали с агентом в качестве службы, удалите службу.

2. Запустите агент.

   ./run.sh
   

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

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

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

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

./run.sh --once

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

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

Если агент работает в этих операционных системах, можно запустить агент как systemd службу:

• Ubuntu 16 LTS или более поздней версии
• Red Hat 7.1 или более поздней версии

Мы предоставляем пример ./svc.sh скрипта для запуска агента и управления им в качестве systemd службы. Этот скрипт будет создан после настройки агента. Мы рекомендуем вам просмотреть и при необходимости обновить скрипт перед его запуском.

Некоторые важные предостережения:

• Если вы запускаете агент как службу, вы не можете запустить службу агента как root пользователя.
• Пользователи, работающие под управлением SELinux , сообщили о трудностях с предоставленным svc.sh скриптом. Обратитесь к этой проблеме агента в качестве отправной точки. SELinux не является официально поддерживаемой конфигурацией.

Команды

Изменение каталога агента

Например, если вы установили в подпапке myagent домашнего каталога:

cd ~/myagent$

Установка

Команда:

sudo ./svc.sh install [username]

Эта команда создает файл службы, указывающий на ./runsvc.sh. Этот скрипт настраивает среду (дополнительные сведения ниже) и запускает узел агентов. Если username параметр не указан, имя пользователя берется из переменной среды $SUDO_USER, заданной командой sudo. Эта переменная всегда равна имени пользователя, вызвавшего sudo команду.

Начать

sudo ./svc.sh start

Состояние

sudo ./svc.sh status

Остановить

sudo ./svc.sh stop

Удаление

Перед удалением следует остановиться.

sudo ./svc.sh uninstall

Обновление переменных среды

При настройке службы требуется моментальный снимок некоторых полезных переменных среды для текущего пользователя входа, например PATH, LANG, JAVA_HOME, ANT_HOME и MYSQL_PATH. Если необходимо обновить переменные (например, после установки нового программного обеспечения):

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

Моментальный снимок переменных среды хранится в файле (PATHхранится в .env.pathкорневом каталоге агента), вы также можете изменить эти файлы напрямую, чтобы применить изменения переменной среды.

Выполнение инструкций перед запуском службы

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

1. Измените runsvc.sh.

2. Замените следующую строку инструкциями:

   # insert anything to setup env when running as a service
   

Файлы службы

При установке службы некоторые файлы служб помещаются.

Системный файл службы

systemd Создается файл службы:

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

Например, вы настроили агент (см. выше) с именем our-linux-agent. Файл службы будет следующим:

• Azure Pipelines: имя вашей организации. Например, если вы подключаетесь https://dev.azure.com/fabrikam, то имя службы будет иметь значение /etc/systemd/system/vsts.agent.fabrikam.our-linux-agent.service

• TFS или Azure DevOps Server: имя локального сервера. Например, если вы подключаетесь http://our-server:8080/tfs, то имя службы будет иметь значение /etc/systemd/system/vsts.agent.our-server.our-linux-agent.service

sudo ./svc.sh install создает этот файл из этого шаблона: ./bin/vsts.agent.service.template

Файл .service

sudo ./svc.sh start находит службу, считывая .service файл, содержащий имя системного файла службы, описанного выше.

Альтернативные механизмы обслуживания

Мы предоставляем ./svc.sh скрипт в качестве удобного способа запуска агента и управления им в качестве системной службы. Но вы можете использовать любой тип предпочитаемого механизма обслуживания (например, initd или upstart).

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

Использование группы cgroup для предотвращения сбоя агента

Важно избежать ситуаций, в которых агент завершается сбоем или становится непригодным для использования, так как в противном случае агент не может передавать журналы конвейера или состояние конвейера отчетов обратно на сервер. Вы можете снизить риск возникновения этой проблемы, вызванной высоким давлением памяти, с помощью cgroups и более низкой oom_score_adj. После этого Linux освобождает системную память из процессов задания конвейера перед восстановлением памяти из процесса агента. Узнайте, как настроить cgroups и оценить OOM.

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

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

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

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

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

1. Остановите и удалите службу, как описано в предыдущем разделе.

2. Удалите агент.

   ./config.sh remove
   

3. Введите свои учетные данные.

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

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

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

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

Диагностика

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

./run.sh --diagnostics

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

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

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

./config.sh --help

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

Возможности

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

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

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

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

Где можно узнать больше о новом программном обеспечении агента версии 3?

Сведения и часто задаваемые вопросы о программном обеспечении агента версии 3 см. в разделе "Программное обеспечение агента" версии 3.

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

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

Почему требуется sudo для выполнения команд службы?

./svc.shиспользует , для которого требуется systemctlsudo.

Исходный код: systemd.svc.sh.template на GitHub

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

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

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

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

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

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

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

Если вы будете использовать TFVC, вам также потребуется Oracle Java JDK 1.6 или более поздней версии. (Для этой цели не хватает Oracle JRE и OpenJDK.)

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

Так как подключаемый модуль TEE больше не поддерживается и содержит некоторые устаревшие зависимости Java, начиная с агента 2.198.0, он больше не включен в дистрибутив агента. Однако подключаемый модуль TEE будет скачан во время выполнения задачи проверка out, если вы проверка вы используете репозиторий TFVC. Подключаемый модуль TEE будет удален после выполнения задания.

Если агент работает за прокси-сервером или брандмауэром, необходимо обеспечить доступ к следующему сайту: https://vstsagenttools.blob.core.windows.net/ Подключаемый модуль TEE будет скачан с этого адреса.

Если вы используете локальный агент и сталкиваетесь с проблемами с скачиванием TEE, вы можете установить TEE вручную:

1. Задайте DISABLE_TEE_PLUGIN_REMOVAL для переменной среды или конвейера значение true. Эта переменная запрещает агенту удалять подключаемый модуль TEE после проверка выхода репозитория TFVC.
2. Скачайте TEE-CLC версии 14.135.0 вручную из Team Обозреватель Выпуски GitHub везде.
3. Извлеките содержимое TEE-CLC-14.135.0 папки <agent_directory>/externals/teeв .