Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kwame-mintah/azuredevops-selfhosted-agents-docker-compose

Example for running self-hosted azure devops agents using docker-compose.
https://github.com/kwame-mintah/azuredevops-selfhosted-agents-docker-compose

azure-devops azure-devops-agent docker-compose docker-compose-template example-code example-project

Last synced: 8 days ago
JSON representation

Example for running self-hosted azure devops agents using docker-compose.

Awesome Lists containing this project

README 

        
# Azure Devops Self-Hosted Agents Docker-Compose



Launch self-hosted agents in Azure DevOps using docker-compose. Although a guide has been provided for [self-hosted in Docker](https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/docker?view=azure-devops), there isn't an example available for running using docker-compose. This repository aims to provide an example of how to accomplish this.



## Development



## Prerequisites



1. Have [Docker for desktop](https://www.docker.com/products/docker-desktop) installed on your machine,

2. Have permission to configure agents within your Azure DevOps organisation.



## Usage



1. Clone the repository and navigate to the directory,

2. Copy `.env.example` and create a new `.env` file and assign environment variable values,

3. Build the agent docker image:



   `docker build -t azureagent:latest .`



4. Start the agents / services:



   `docker-compose -f docker-compose.example.yml up -d`,



5. Stop all agents / services:



   `docker-compose -f docker-compose.example.yml down --remove-orphans`.



Starting the services will launch one agent and one deployment agent and should be available for usage, within their respective pools.



## Environment variables



The following environment variables are used for the services.



| Environment variable | Description                                                                                                                              | Default value          | Required? |

| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | --------- |

| AZP_URL              | The URL of the Azure DevOps or Azure DevOps Server instance.                                                                             | N/A                    | Yes       |

| AZP_TOKEN            | Personal Access Token (PAT) with Agent Pools (read, manage) scope, created by a user who has permission to configure agents, at AZP_URL. | N/A                    | Yes       |

| AZP_AGENT_NAME       | Agent name.                                                                                                                              | The container hostname | Optional  |

| AZP_POOL             | Agent pool name.                                                                                                                         | Default                | Optional  |

| AZP_WORK             | Work directory                                                                                                                           | `_work`                | No        |

| DEPLOYMENT_AGENT     | Indicate if the agent should be configured as a deployment agent by setting the value as `"true"`                                        | N/A                    | Optional  |

| DEPLOYMENT_POOLNAME  | The deployment pool that the agent should be added to, if `DEPLOYMENT_AGENT` value is `"true"`                                           | N/A                    | Optional  |



Note: `AZP_POOL` does not need to be specified, if the agent is a deployment agent. But instead a valid deployment pool must already be created within the organisation.



## Installing additionally command line utilities



If you're running into issues installing additional command line tools through your pipeline. It's possible to update the `Dockerfile` to install the tool during the docker build

of the image. For example [ArchiveFiles@2](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/archive-files-v2?view=azure-pipelines) may fail due to `zip` due

to command not found error, in which case you can add it to the list of `apt-get install` so you can use the `zip` command with the Azure Pipeline task.



The proposed option assumes that that all agents need `zip` cli installed. Alternatively, If there is only one job that requires a command, you can install it via bash script in the pipeline e.g. `apt-get install zip -y --allow-change-held-packages`, this should download and install the cli.



## Failed to fetch packages during job run



When attempting to fetch new *or* updated packages during a job run but fails due to:

```console

Err:4 http://ports.ubuntu.com/ubuntu-ports focal-updates/main arm64 binutils-common arm64 2.34-6ubuntu1.5

  404  Not Found [IP: 185.125.190.36 80]

```

This happens because a cached Docker is used. The cached image wouldn't have the latest repository information and requires having to rebuild the image again.