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.

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.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.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

2.0.1

• :white_check_mark: duplicate apt install command
• :white_check_mark: yq download the latest version
• :white_check_mark: Upgrade VSTS agent to 3.248.0
• :white_check_mark: Optimize the Dockerfile steps and add comment lines.

2.0.0

• :white_check_mark: ubuntu 20.04 based image
• :white_check_mark: yq upgrade to 4.40.7
• :white_check_mark: docker command could be executed without sudo
• :white_check_mark: Support for VSTS agent 3.232.3

1.0.9

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

:white_check_mark: Thanks for contribitions to Alexandre Saison

: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

:white_check_mark: Issue : docker could be called without sudo

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
• Authenticate with a personal access token (PAT)

Installing the Chart

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

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

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

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}

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

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:

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.

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.

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.

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	3.248.0-stable-v2.1.0
image.pullPolicy	Azure DevOps agent image pull policy	IfNotPresent
image.pullSecrets	Azure DevOps agent image pull secrets	[]
replicaCount	Replica count for deployment	1
resources.requests.cpu	CPU request value for scheduling	"100m"
resources.requests.memory	Memory request value for scheduling	"128Mi"
resources.limits.cpu	CPU limit value for scheduling	"500m"
resources.limits.memory	Memory limit value for scheduling	"512Mi"
volumes	Volumes for the container	[]
volumeMounts	Volume mountings	[]

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
• helm
• kubectl
• Powershell Core
• Docker CLI
• Azure CLI
  • with Azure DevOps extension