azure-devops-agent-on-kubernetes

KO | EN

gitlite — search

#hacktoberfest #react #llm #golang #android #rust #macos #java #nodejs #cli #vue #ios #mcp #open-source

azure-devops-agent-on-kubernetes

(★ 56)

The easiest and most effective method for creating and managing Azure DevOps agents on Kubernetes

azure-devops-agent-on-kubernetes Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/btungut)](https://artifacthub.io/packages/helm/btungut/azure-devops-agent)
[![Release](https://img.shields.io/github/v/release/btungut/azure-devops-agent-on-kubernetes?include_prereleases&style=plastic)](https://github.com/btungut/azure-devops-agent-on-kubernetes/releases)
[![LICENSE](https://img.shields.io/github/license/btungut/azure-devops-agent-on-kubernetes?style=plastic)](https://github.com/btungut/azure-devops-agent-on-kubernetes/blob/master/LICENSE)

# Azure DevOps Agent on Kubernetes

The easiest and most effective method for creating and managing Azure DevOps agents on Kubernetes, without the need to spend time and effort wrestling with settings! Scale-out as much as is necessary and demolish them gracefully.

## YouTube Tutorial Video

You can watch the tutorial video below to learn how to deploy Azure DevOps agents on Kubernetes.

> LET'S CLICK ON THE IMAGE BELOW TO WATCH THE TUTORIAL VIDEO!

[![Azure DevOps Agent on Kubernetes - How to deploy build agents on Kubernetes - Tutorial](https://img.youtube.com/vi/qep2l1oxknk/0.jpg)](https://www.youtube.com/watch?v=qep2l1oxknk)

## Compatibility Matrix

The table presented below outlines the correspondence between Helm chart versions, Docker tags, and the Azure DevOps agent versions included within those Docker images.

| Helm Version | Docker Tag            | Agent Version |
| ------------ | --------------------- | ------------- |
| 2.5.0        | v2.5.0-vsts-v2.268.0  | 4.268.0       |
| 2.4.0        | v2.4.0-vsts-v2.258.1  | 4.258.1       |
| 2.3.0        | v2.3.0-vsts-v2.255.0  | 4.255.0       |
| 2.2.0        | 4.251.0-stable-v2.2.0 | 4.251.0       |
| 2.1.1        | 3.248.0-stable-v2.1.0 | 3.248.0       |
| 2.1.0        | 3.248.0-stable-v2.1.0 | 3.248.0       |
| 2.0.1        | 3.248.0               | 3.248.0       |
| 2.0.0        | 3.232.3               | 3.232.3       |
| 1.0.7        | 2.214.1               | 2.214.1       |

## Important Release Notes

### 2.5.0

With the **2.5.0 release**, the helm chart has been updated to use the latest Azure DevOps agent version **4.268.0** and includes new configuration options.

- :white_check_mark: Upgrade VSTS agent to **4.268.0**
- :white_check_mark: [feat: Allow to define terminationGracePeriodSeconds](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/45)
  - Added support for configuring pod termination grace period (default: 30 seconds)

### 2.4.0

With the **2.4.0 release**, the helm chart has been updated to use the latest Azure DevOps agent version **4.258.1**.

- :white_check_mark: [fix: Update download URL of the Azure DevOps agent](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/41)
- :white_check_mark: Upgrade VSTS agent to **4.258.1**

### 2.3.0

With the **2.3.0 release**, the helm chart has been updated to use the latest Azure DevOps agent version **4.255.0** and `git-lfs` support has been added.

- :white_check_mark: [Upgrade VSTS agent to 4.255.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/38)
- :white_check_mark: [Add git-lfs support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/37)
- :white_check_mark: [BREAKING CHANGE: Change container resources requests and limits to NULL / empty / `{}`](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/39)

#### IMPORTANT & BREAKING CHANGE

- The values of **requests and limits for the container resources** have been changed from specific values to NULL / empty / `{}`.

> This means that the container will use the default values of the Kubernetes cluster for CPU and memory resources. Please make sure to adjust the values according to your needs if you want to set specific values for CPU and memory resources.

**To see the changes**, please visit the [values.yaml changes for PR 39](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/39/files)

### 2.2.0

This helm release uses the latest stable Azure Devops Agent version which is **4.251.0**.

- :white_check_mark: [Upgrade VSTS agent to 4.251.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/35)
  - :white_check_mark: [Issue: Upgrade VSTS agent to 4.251.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/34)

### 2.1.1

This helm release deploys the same agent version but contains `sideContainers` support for helm chart.

- :white_check_mark: [Feature add sideContainers support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/33)
- :white_check_mark: [Add sidecar containers](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/31)

### 2.1.0

This release includes the same agent version but different Docker image tag and **different bash invocations**!

- :white_check_mark: [Add sudo and docker support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/27)

### 2.0.1

- :white_check_mark: [duplicate apt install command](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/16)
- :white_check_mark: [yq download the latest version](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/22)
- :white_check_mark: [Upgrade VSTS agent to 3.248.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/23)
- :white_check_mark: Optimize the Dockerfile steps and add comment lines.

### 2.0.0

- :white_check_mark: [ubuntu 20.04 based image](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/13)
- :white_check_mark: [yq upgrade to 4.40.7](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/12)
- :white_check_mark: [docker command could be executed without sudo](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/11)
- :white_check_mark: [Support for VSTS agent 3.232.3](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/10)

### 1.0.9

- Pod Annotations have been implemented
- Service Account support has been implemented

:white_check_mark: Thanks for contribitions to [Alexandre Saison](https://github.com/saisona)

:white_check_mark: PR: https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/8

### 1.0.8

Since the **1.0.8 release** , the Dockerfile and Helm chart have been configured to utilize a non-root user.

:white_check_mark: [Issue : Non-root user should be implemented](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/3)

:white_check_mark: [Issue : docker could be called without sudo](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/5)

## Prerequisites

- Helm
- Personal Access Token (**PAT**) with `Agent Pool manage` scope

You don't need to follow any more instructions beyond the **standard self-hosted agent installation** in order to utilize this helm chart.

## Generate PAT on Azure DevOps

It is pretty straight-forward process with sufficient scope. Please choose **one of** the links below to generate a PAT.

> :warning: Only the PAT creation procedures are required

- [Create a PAT](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows#create-a-pat)
- [Authenticate with a personal access token (PAT)](https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/v2-linux?view=azure-devops#authenticate-with-a-personal-access-token-pat)

## Installing the Chart

1. First you need to add repository _(if you haven't done yet before)_

```bash
helm repo add btungut https://btungut.github.io
```

1. Install the helm chart with specified PAT and other required parameters

```bash
helm install {RELEASE-NAME} btungut/azure-devops-agent \
  --set agent.pat={PAT} \
  --set agent.organizationUrl=https://dev.azure.com/{YOUR-ORG} \
  --set agent.pool="YOUR-AGENT-POOL-NAME" \
  --namespace {YOUR-NS}
```

1. Install the helm chart with existing secret that stores PAT

```bash
helm install {RELEASE-NAME} btungut/azure-devops-agent \
  --set agent.patSecret={SECRET-NAME} \
  --set agent.patSecretKey="pat" \
  --set agent.organizationUrl=https://dev.azure.com/{YOUR-ORG} \
  --set agent.pool="YOUR-AGENT-POOL-NAME" \
  --namespace {YOUR-NS}
```

## Uninstalling the Chart

Run the following snippet to uninstall the release:

```bash
helm delete {RELEASE-NAME}
```

## docker CLI support

If you want to use Docker CLI in the agent, you need to override `volumes` and `volumeMounts` parameters as shown below.

```yaml
volumes:
  - name: dockersock
    hostPath:
      path: /var/run/docker.sock
volumeMounts: []
  - name: dockersock
    mountPath: "/var/run/docker.sock"
```

## Example overriden values.yaml for running instance

This the example values.yaml that you can use to run an instance with provided PAT secret and Docker CLI support.

```yaml
fullnameOverride: azdo-agent
replicaCount: 1

agent:
  organizationUrl: "https://dev.azure.com/phonestore-ws"
  pool: "self-hosted-azure"

patSecret: "azdo-phonestore-ws"
  patSecretKey: "pat"

# If you want to use docker CLI in the agent, you need to override volumes and volumeMounts parameters as shown below.
volumes:
  - name: dockersock
    hostPath:
      path: /var/run/docker.sock
volumeMounts:
  - name: dockersock
    mountPath: "/var/run/docker.sock"
```

- This example includes and support **Docker CLI support**, if you do not need it, you can remove `volumes` and `volumeMounts` sections.
- This example includes **Azure DevOps PAT** that is stored in a secret named `azdo-phonestore-ws` with the key `pat`. If you do not need it, you can remove `patSecret` and `patSecretKey` sections and use `pat` parameter instead.

## Example overriden values.yaml for running instance with provided PAT directly without secret

This the example values.yaml that you can use to run an instance with provided PAT directly and Docker CLI support.

```yaml
fullnameOverride: azdo-agent
replicaCount: 1

agent:
  organizationUrl: "https://dev.azure.com/phonestore-ws"
  pool: "self-hosted-azure"

pat: "YOUR-PAT-HERE"

# If you want to use docker CLI in the agent, you need to override volumes and volumeMounts parameters as shown below.
volumes:
  - name: dockersock
    hostPath:
      path: /var/run/docker.sock
volumeMounts:
  - name: dockersock
    mountPath: "/var/run/docker.sock"
```

## Parameters

### Agent authentication parameters

> :warning: Helm chart provides two option for authentication. Please use only one of them.

| Name                 | Description                                                       | Value   |
| -------------------- | ----------------------------------------------------------------- | ------- |
| `agent.pat`          | (1st Option) Personal access token for authentication             | `""`    |
| `agent.patSecret`    | (2nd Option) Already existing secret name that stores PAT         | `""`    |
| `agent.patSecretKey` | (2nd Option) Key (field) name of the PAT that is stored in secret | `"pat"` |

### Agent configuration parameters

| Name                     | Description                                                                     | Value       |
| ------------------------ | ------------------------------------------------------------------------------- | ----------- |
| `agent.organizationUrl`  | Server / organization url, e.g.: `https://dev.azure.com/your-organization-name` | `""`        |
| `agent.pool`             | Agent pool name which the build agent is placed into                            | `"Default"` |
| `agent.workingDirectory` | Working directory of the agent                                                  | `"_work"`   |
| `agent.extraEnv`         | Additional environment variables as dictionary                                  | `{}`        |

### Other parameters

| Name                              | Description                                           | Value                        |
| --------------------------------- | ----------------------------------------------------- | ---------------------------- |
| `image.registry`                  | Azure DevOps agent image registry                     | `docker.io`                  |
| `image.repository`                | Azure DevOps agent image repository                   | `btungut/azure-devops-agent` |
| `image.tag`                       | Azure DevOps agent image tag                          | refer to values.yaml         |
| `image.pullPolicy`                | Azure DevOps agent image pull policy                  | `IfNotPresent`               |
| `image.pullSecrets`               | Azure DevOps agent image pull secrets                 | `[]`                         |
| `replicaCount`                    | Replica count for deployment                          | `1`                          |
| `resources`                       | Resource requests and limits for the container        | `{}`                         |
| `volumes`                         | Volumes for the container                             | `[]`                         |
| `volumeMounts`                    | Volume mountings                                      | `[]`                         |
| `terminationGracePeriodSeconds`   | Time to wait before forcefully terminating the pod    | `30`                         |

Please refer the values.yaml for other parameters.

## Built-in binaries & packages

The binaries and packages listed below are included in the docker image used by the helm chart:

- Ubuntu 20.04
- unzip
- jq
- yq
- git
- git-lfs
- helm
- kubectl
- Powershell Core
- Docker CLI
- Azure CLI
  - with Azure DevOps extension

azure-devops-agent-on-kubernetes

azure-devops-agent-on-kubernetes Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

azure-devops-agent-on-kubernetes

azure-devops-agent-on-kubernetes Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README