title | description | ms.topic | ms.custom | ms.assetid | ms.date | monikerRange |
---|---|---|---|---|---|---|
Deploy an Azure Pipelines agent on Linux |
Learn how you can easily deploy a self-hosted agent on Linux for Azure Pipelines. |
conceptual |
linux-related-content |
834FFB19-DCC5-40EB-A3AD-18B7EDCA976E |
05/06/2024 |
<= azure-devops |
[!INCLUDE version-lt-eq-azure-devops]
:::moniker range="<=azure-devops"
This article provides guidance for using the 3.x agent software with Azure DevOps Services and current versions of Azure DevOps Server. For a list of Azure DevOps Server versions that support the 3.x agent, see Does Azure DevOps Server support the 3.x agent.
:::moniker-end
To run your jobs, you need at least one agent. A Linux agent can build and deploy different kinds of apps, including Java and Android apps. See Check prerequisites for a list of supported Linux distributions.
Note
This article describes how to configure a self-hosted agent. If you're using Azure DevOps Services and a Microsoft-hosted agent meets your needs, you can skip setting up a self-hosted Linux agent.
[!INCLUDE include]
::: moniker range="<=azure-devops"
The agent is based on .NET 6. You can run this agent on several Linux distributions. We support the following subset of .NET 6 supported distributions:
- Supported distributions
- x64
- Debian 10+
- Fedora 36+
- openSUSE 15+
- Red Hat Enterprise Linux 7+
- No longer requires separate package
- SUSE Enterprise Linux 12 SP2 or later
- Ubuntu 22.04, 20.04, 18.04, 16.04
- Azure Linux 2.0
- Oracle Linux 7 and higher
- ARM64
- Debian 10+
- Ubuntu 22.04, 20.04, 18.04
- Alpine x64
- Alpine Linux 3.13 and higher (requires agent 3.227 or higher)
- x64
- Git - Regardless of your platform, you need to install Git 2.9.0 or higher. We strongly recommend installing the latest version of Git.
- .NET - The agent software runs on .NET 6, but installs its own version of .NET so there is no .NET prerequisite.
- Subversion - If you're building from a Subversion repo, you must install the Subversion client on the machine.
- TFVC - If you're building from a TFVC repo, see TFVC prerequisites.
Note
The agent installer knows how to check for other dependencies.
You can install those dependencies on supported Linux platforms by running ./bin/installdependencies.sh
in the agent directory.
Be aware that some of these dependencies required by .NET are fetched from third party sites, like packages.efficios.com
. Review the installdependencies.sh
script and ensure any referenced third party sites are accessible from your Linux machine before running the script.
Please also make sure that all required repositories are connected to the relevant package manager used in installdependencies.sh
(like apt
or zypper
).
For issues with dependencies installation (like 'dependency was not found in repository' or 'problem retrieving the repository index file') - you can reach out to distribution owner for further support.
::: moniker-end
You should run agent setup manually the first time. After you get a feel for how agents work, or if you want to automate setting up many agents, consider using unattended config.
[!INCLUDE include]
::: moniker range="azure-devops"
-
Log on to the machine using the account for which you've prepared permissions as explained in the previous section.
-
In your web browser, sign in to Azure Pipelines, and navigate to the Agent pools tab:
[!INCLUDE include]
-
Select the Default pool, select the Agents tab, and choose New agent.
-
On the Get the agent dialog box, click Linux.
-
On the left pane, select the specific flavor. We offer x64 or ARM for many Linux distributions.
-
On the right pane, click the Download button.
-
Follow the instructions on the page.
-
Unpack the agent into the directory of your choice.
cd
to that directory and run./config.sh
.
::: moniker-end
::: moniker range="azure-devops"
Azure Pipelines: https://dev.azure.com/{your-organization}
::: moniker-end
When you register an agent, choose from the following authentication types, and agent setup prompts you for the specific additional information required for each authentication type. For more information, see Self-hosted agent authentication options.
[!INCLUDE agent-setup-authentication-type]
For guidance on whether to run the agent in interactive mode or as a service, see Agents: Interactive vs. service.
To run the agent interactively:
-
If you have been running the agent as a service, uninstall the service.
-
Run the agent.
./run.sh
To restart the agent, press Ctrl+C and then run run.sh
to restart it.
To use your agent, run a job using the agent's pool. If you didn't choose a different pool, your agent is placed in the Default pool.
For agents configured to run interactively, you can choose to have the agent accept only one job. To run in this configuration:
./run.sh --once
Agents in this mode accept only one job and then spin down gracefully (useful for running in Docker on a service like Azure Container Instances).
If your agent is running on these operating systems you can run the agent as a systemd
service:
- Ubuntu 16 LTS or newer
- Red Hat 7.1 or newer
We provide an example ./svc.sh
script for you to run and manage your agent as a systemd
service.
This script will be generated after you configure the agent.
We encourage you to review, and if needed, update the script before running it.
Some important caveats:
- If you run your agent as a service, you cannot run the agent service as
root
user. - Users running SELinux have reported difficulties with the provided
svc.sh
script. Refer to this agent issue as a starting point. SELinux is not an officially supported configuration.
Note
If you have a different distribution, or if you prefer other approaches, you can use whatever kind of service mechanism you prefer. See Service files.
For example, if you installed in the myagent
subfolder of your home directory:
cd ~/myagent$
Command:
sudo ./svc.sh install [username]
This command creates a service file that points to ./runsvc.sh
. This script sets up the environment (more details below) and starts the agents host. If username
parameter is not specified, the username is taken from the $SUDO_USER environment variable set by sudo command. This variable is always equal to the name of the user who invoked the sudo
command.
sudo ./svc.sh start
sudo ./svc.sh status
sudo ./svc.sh stop
You should stop before you uninstall.
sudo ./svc.sh uninstall
When you configure the service, it takes a snapshot of some useful environment variables for your current logon user such as PATH, LANG, JAVA_HOME, ANT_HOME, and MYSQL_PATH. If you need to update the variables (for example, after installing some new software):
./env.sh
sudo ./svc.sh stop
sudo ./svc.sh start
The snapshot of the environment variables is stored in .env
file (PATH
is stored in .path
) under agent root directory, you can also change these files directly to apply environment variable changes.
You can also run your own instructions and commands to run when the service starts. For example, you could set up the environment or call scripts.
-
Edit
runsvc.sh
. -
Replace the following line with your instructions:
# insert anything to setup env when running as a service
When you install the service, some service files are put in place.
A systemd
service file is created:
/etc/systemd/system/vsts.agent.{tfs-name}.{agent-name}.service
For example, you have configured an agent (see above) with the name our-linux-agent
. The service file will be either:
-
Azure Pipelines: the name of your organization. For example if you connect to
https://dev.azure.com/fabrikam
, then the service name would be/etc/systemd/system/vsts.agent.fabrikam.our-linux-agent.service
-
TFS or Azure DevOps Server: the name of your on-premises server. For example if you connect to
http://our-server:8080/tfs
, then the service name would be/etc/systemd/system/vsts.agent.our-server.our-linux-agent.service
sudo ./svc.sh install
generates this file from this template: ./bin/vsts.agent.service.template
sudo ./svc.sh start
finds the service by reading the .service
file, which contains the name of systemd service file described above.
We provide the ./svc.sh
script as a convenient way for you to run and manage your agent as a systemd service. But you can use whatever kind of service mechanism you prefer (for example: initd or upstart).
You can use the template described above as to facilitate generating other kinds of service files.
It's important to avoid situations in which the agent fails or become unusable because otherwise the agent can't stream pipeline logs or report pipeline status back to the server. You can mitigate the risk of this kind of problem being caused by high memory pressure by using cgroups
and a lower oom_score_adj
. After you've done this, Linux reclaims system memory from pipeline job processes before reclaiming memory from the agent process. Learn how to configure cgroups
and OOM score.
[!INCLUDE include]
[!INCLUDE include]
[!INCLUDE include]
[!INCLUDE include]
[!INCLUDE v3 Agent overview]
[!INCLUDE include]
./svc.sh
uses systemctl
, which requires sudo
.
Source code: systemd.svc.sh.template on GitHub
::: moniker range="azure-devops"
[!INCLUDE include]
::: moniker-end
Run the agent with self-signed certificate
Run the agent behind a web proxy
If you are running the agent interactively, see the restart instructions in Run interactively. If you are running the agent as a systemd service, follow the steps to Stop and then Start the agent.
::: moniker range="azure-devops"
[!INCLUDE include]
::: moniker-end
::: moniker range="<azure-devops"
[!INCLUDE include]
::: moniker-end
::: moniker range="< azure-devops"
[!INCLUDE include]
::: moniker-end
If you'll be using TFVC, you'll also need the Oracle Java JDK 1.6 or higher. (The Oracle JRE and OpenJDK aren't sufficient for this purpose.)
TEE plugin is used for TFVC functionality. It has an EULA, which you need to accept during configuration if you plan to work with TFVC.
Since the TEE plugin is no longer maintained and contains some out-of-date Java dependencies, starting from Agent 2.198.0 it's no longer included in the agent distribution. However, the TEE plugin will be downloaded during checkout task execution if you're checking out a TFVC repo. The TEE plugin will be removed after the job execution.
Note
Note: You may notice your checkout task taking a long time to start working because of this download mechanism.
If the agent is running behind a proxy or a firewall, you need to ensure access to the following site: https://vstsagenttools.blob.core.windows.net/
. The TEE plugin will be downloaded from this address.
If you're using a self-hosted agent and facing issues with TEE downloading, you may install TEE manually:
- Set
DISABLE_TEE_PLUGIN_REMOVAL
environment or pipeline variable totrue
. This variable prevents the agent from removing the TEE plugin after TFVC repository checkout. - Download TEE-CLC version 14.135.0 manually from Team Explorer Everywhere GitHub releases.
- Extract the contents of
TEE-CLC-14.135.0
folder to<agent_directory>/externals/tee
.