DevOps Build Agents

This project generates self-hosted build agents based on the official Microsoft-hosted build agents images, in an Azure DevOps Pipeline. The resulting Azure Managed Image will be associated to the existing Virtual Machine Scale Set so that new VM's will be using the newly generated image. This Virtual Machine Scale Set is managed by Azure DevOps as a Azure Virtual Machine Scale Set Agent.

Currently supports Windows Server 2019, Windows Server 2022, Ubuntu 2004 and Ubuntu 2204 images.

Available pipelines

buildagent-generation.yml
- Checkout the latest main branch from actions/runner-images
- Build the VM with Packer
- Clean up remaining temporary Azure resources
- Add Azure Managed Image to Azure Compute Gallery or Update Virtual Machine Scale Set with the new image
- Remove Azure Managed Image when using Azure Compute Gallery
managedimage-cleanup.yml
- Remove unused Azure Managed Images or old Gallery image versions, depending on selection

Preparation

The pipeline requires Azure resources for the temporary building of the VM image, Azure resources for running the resulting Agent Pool, and some configuration in Azure DevOps.

Azure Compute Gallery

Create (if you don´t have one) an Azure Compute Gallery in your Azure subscription, and create the following VM Image Definitions:

ubuntu2004-agentpool-full (OS: Linux)
ubuntu2204-agentpool-full (OS: Linux)
windows2019-agentpool-full (OS: Windows)
windows2022-agentpool-full (OS: Windows)

This step will be automated in a later stage.

Azure Resources for Packer execution

The Azure resources are created with the Azure PowerShell Module

Connect to Azure

Connect-AzAccount -UseDeviceAuthentication

Create resource group that will store the Packer temporary resources

New-AzResourceGroup -Name "DevOps-PackerResources" -Location "West Europe"

Create Azure AD Service Principal, output client secret and client id

$sp = New-AzADServicePrincipal -DisplayName "DevOps-Packer"
$BSTR = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($sp.Secret)
$plainPassword = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($BSTR)
$plainPassword
$sp.ApplicationId

Make the Service Principal a Contributor on the subscription

New-AzRoleAssignment -RoleDefinitionName Contributor -ServicePrincipalName $sp.ApplicationId

Azure Virtual Machine Scale Set

To use an Azure Virtual Machine Scale Set as an Azure DevOps Scale Set Agent it has to adhere to a certain set of requirements. The documentation contains all the required information, but at the time of writing the following things were important:

VM size: at least Standard_D4s_v4
Overprovisioning: no, Azure DevOps will decide whether or not new VM's (and thus Agents) need to be provisioned
Upgrade policy: manual

Azure DevOps Scale Set Agent

The Virtual Machine Scale Set from the previous step needs to be registered as an Agent Pool in Azure DevOps. The instructions are very clear:

Add an Agent Pool of type "Azure virtual machine scale set"
Use a service connection to select the scale set from the previous step (only supported via Secret authentication, not Certificate or Managed Identity authentication)
Give the agent pool a name
Enter the required configuration values

Azure DevOps Variable Group

Create a Variable Group in the Azure DevOps project running the pipeline, and give it a name. It needs to contain the following variables with their appropriate value:	Variable	Description
AZURE_AGENTS_RESOURCE_GROUP	Resource Group that contains the Virtual Machine Scale Sets to be used as Scale Set Agents in Azure DevOps
AZURE_LOCATION	Azure location where Packer will create the temporary resources
AZURE_RESOURCE_GROUP	Resource group that will be used by Packer to put the resulting Azure Managed Image.
AZURE_SUBSCRIPTION	Subscription ID of the Azure Subscription that is used to host the temporary resources.
BUILD_AGENT_VNET_NAME	Name of the existing VNet to use for the VM created by Packer, put $null if you want packer to create a new one
BUILD_AGENT_VNET_RESOURCE_GROUP	Name of the resource group containing the existing VNet to use for the VM created by Packer, put $null if you don't have this
BUILD_AGENT_SUBNET_NAME	Name of the existing subnet to use for the VM created by Packer, put $null if you don't have this
AZURE_TENANT	Tenant ID of the Azure tenant that has the Azure Resource Groups and Subscription.
CLIENT_ID	Id of the Azure AD application that has appropriate permissions on the Subscription to create temporary resources and finalizing the Scale Set configuration. See output from scripts above.
CLIENT_SECRET	Application secret to be used fot the connection in combination with the Client Id. See output from scripts above.
RUN_VALIDATION_FLAG	Wether or not to run a validation on diskspace. Set the value to `false` unless you know what you are doing ;)
GALLERY_NAME	(required for option galleryvm) Name of the Azure Compute Gallery to store images for Agent Pool VM Scale Sets.
GALLERY_RESOURCE_GROUP	(required for option galleryvm) Name of the resource group containing the Azure Compute Gallery.
VMSS_Windows2019	(required for option vmss) Name of the Azure Virtual Machine Scale Set that will run Build Agents on Windows Server 2019. Support comma seperated list of names.
VMSS_Windows2022	(required for option vmss) Name of the Azure Virtual Machine Scale Set that will run Build Agents on Windows Server 2022. Support comma seperated list of names.
VMSS_Ubuntu2004	(required for option vmss) Name of the Azure Virtual Machine Scale Set that will run Build Agents on Ubuntu 20.04. Support comma seperated list of names.
VMSS_Ubuntu2204	(required for option vmss) Name of the Azure Virtual Machine Scale Set that will run Build Agents on Ubuntu 22.04. Support comma seperated list of names.

Pipeline runtime parameters

Build Agent Generation

Runtime parameters for Build Agent Generation

Build Agent Image: which image to build, choice between Windows Server 2019, Windows Server 2022, Ubuntu 20.04 and Ubuntu 22.04
runner-images Version: which source code of the runner-images to build, choice between alpha (latest main branch), prerelease (latest prerelease version), and release (latest stable release)
Variable Group: name of the Variable Group containing the variables necessary for execution
Agent Pool: the Agent Pool to use for running the pipeline
Update Method: select type of deployment. vmss (VM Scale Set) or galleryvm (Gallery VM Image). The build VM can be connected straight to a VM Scale Set (classic method) or via a Gallery VM Image (modern method).

Managed Image Cleanup

Runtime parameters for Managed Images Cleanup

Variable Group: name of the Variable Group containing the variables necessary for execution
Delete vmss (VM Scale Set) or galleryvm (Gallery VM) image?: should it delete orphaned Managed Images or old versions of the image in an Azure Compute Gallery

How to use

Templated version

Both YML file are designed in a way that allows anyone to simply include them using the "template" instruction. You will need to create a service connection under your Azure DevOps instance before moving with the configuration.

Assuming the service connection has been setup, under your own repository, within an Azure Pipeline YML file, include the following resource:

resources:
  repositories:
    - repository: azuredevops-buildagents
      type: github
      name: YannickRe/azuredevops-buildagents
      endpoint: <your-service-connection-name>
      ref: refs/heads/main

This will tell your pipeline that you're dependent upon this repository. Then, the following instructions can be freely customized to your needs. If you need some stages to be ran before the steps within this repository, then include them inside your pipeline, then call the desired template from the repository.

Calling a template is easy as doing the following:

stages:
  - stage: InsertAnyCustomStageHere
    displayName: 'My Stage'
    [...]
  - stage: BuildImage
    displayName: Build Image
    pool:
      name: <agent-pool>
    jobs:
    - template: buildagent-generation-template.yml@azuredevops-buildagents
      parameters: 
        image_type: <image-type>
        runner_images_version: <runner_images_version>
        variable_group: <variable-group>
        agent_pool: <agent-pool>
        repository_base_path: <repository_base_path>

Template parameters

When calling a template, you must provide certain parameters. For reference, please open the file which interests you:

buildagent-generation.yml
managedimage-cleanup.yml

There is one important element you must be aware of:

repository_base_path
- This variable dictates how the agent should resolve the assets within this repository. When used, two things will happen:
- First, it will clone the repository resource specified within your YML file, which represents this repository
- It will also use it to properly resolve the path where this repository resides on your pipeline agent
- When a remote template is referenced within an Azure Pipeline YML file, it doesn't clone the repository. Providing this parameter will make sure these templates understands they need to clone it before being able to run any of the scripts.

Optional parameter:

depends_on
- You can force the jobs within this repository to depend upon your own set of tasks. To use it, simply provide the name of the job which the next job within the template should depend on.

The rest is quite self explanatory. Use the other parameters to provide the remaining required details for building / cleaning the images.

Good to know

Packer

Packer is an open source tool for creating identical machine images for multiple platforms from a single source configuration. Important to know: while building the image, Packer will spin up a VM in Azure to run the installation instructions, sys-prep that image after completion and cleanup all the temporary resources.

Scale Set Agents

Azure virtual machine scale set agents are a form of self-hosted agents that can be autoscaled to meet demands. This elasticity reduces the need to run dedicated agents all the time.

Pipeline runtime

Generating the images takes a long time, so don't be surprised. A Windows Server 2019 image takes about 6 to 7h's to generate, a Ubuntu 20.04 image takes about 4h's.

Chicken or the egg

Generating the image through Packer takes longer than 1h (see previous bullet point), and thus can't be run on the free tier of the Microsoft Hosted Agents (limited to 1h runs). It can only be run on the paid tier of the Microsoft Hosted Agent, or it needs an existing self-hosted agent to run.
In this project, the initial run of the project is done on a paid Microsoft Hosted Agent and then switched over to the newly generated self-hosted agent scale set. At some point this worked, but currently Microsoft is more strictly enforcing the 6 hour runtime limit on Microsoft Hosted Agents. This can be worked around by first creating a self hosted Linux build agent using this process and then using the freshly generated agent to create a Windows image, or be setting up a basic self hosted agent first and use that to generate the full blown build agent.
This might be resolved in the near future when changes are made to the images regarding .NET runtime installation, which should significantly reduce the build time.

Agent Pool Usage

See documentation for YAML-based pipelines and Classic pipelines

Azure CLI access denied error on Windows Host Pool

Please make sure to disable the "Configure VMs to run interactive tests" in your Windows Agent pool setting, otherwise the Azure CLI will generate access denied errors when running a pipeline.

YannickRe / azuredevops-buildagents

readme