deployment-environments/Runner-Images

ADE Runner Images

Featured Repos

• Core: Core ADE Image
• ARM-Bicep: ADE Image for ARM/Bicep Deployments/Deletions

About Azure Deployment Environments

Azure Deployment Environments empowers development teams to quickly and easily spin up app infrastructure with project-based templates that establish consistency and best practices while maximizing security. This on-demand access to secure environments accelerates the stages of the software development lifecycle in a compliant and cost-efficient way.

The provided images for ADE allow customers to create custom images for their deployments to be executed with, utilizing additional custom scripts or steps that fit their deployment workflow.

How to Use the Images

In order to use these images as a base for your custom images, add the following line of code to your Dockerfile:

FROM mcr.microsoft.com/deployment-environments/runners/{REPO_NAME}:{IMAGE_VERSION}

In addtion, by using the provided runner images, you can invoke the ADE CLI within your deployment. The ADE CLI, along with custom images, allows a customer to upload and download files connected to the environment to utilize during deployment and deletion scenarios, record addtional logging, utilize outputs from the infrastructure deployment, and access additional information about their environment and the environment definition. More information concerning the ADE CLI can be found here.

You can find more information about Custom Image Support here.

Available Image Repositories and Versions

• Core: 2.9.0-preview(latest), latest
• ARM/Bicep: 2.9.0-preview(latest), latest

Image Building Quickstart Script

If you have a Dockerfile and scripts folder configured for ADE's extensibility model, you can run the script here to build and push to a specified Azure Container Registry (ACR) under the repository 'ade' and the tag 'latest'. This script requires your registry name and directory for your custom image, have the Azure CLI and Docker Desktop installed and in your PATH variables, and requires that you have permissions to push to the specified registry. You can call the script using the following command in Powershell:

.\quickstart-image-build.ps1 -Registry '{YOUR_REGISTRY}' -Directory '{DIRECTORY_TO_YOUR_IMAGE}'

Additionally, if you would like to push to a specific repository and tag name, you can run:

.\quickstart-image.build.ps1 -Registry '{YOUR_REGISTRY}' -Directory '{DIRECTORY_TO_YOUR_IMAGE}' -Repository '{YOUR_REPOSITORY}' -Tag '{YOUR_TAG}'

Terraform + ADE Extensibility Model Repository

If you have set up an Azure Container Registry to contain images for your extensibility model workflow and are looking to use Terraform Infrastructure-as-Code (IaC) templates, we have setup a sample repository here containing an ADE-compatible image and a GitHub Action that builds and pushes the image to your Azure Container Registry. In order to use this method, you will need to do the following:

• Fork the repository into your personal account
• Allow GitHub Actions to connect to Azure via an Microsoft Entra ID application's federated credentials through OIDC. You will need to save the application's client ID as a secret within your forked repository, along with your subscription and Tenant ID. You can find more documentation about the process here.
• Set up variables for your forked repository containing your personal Azure Container Registry name, your preferred repository name, and your preferred tag for the created image. You can modify your variables between workflow runs to push the generated image to different registries, repositories, and tags.

This repository is meant as a sample to give customers a starting point to deploy their environments with Terraform, allow customers to add additional customizations while using ADE's extensibility model, and easily upload their changes to their connected Azure Container Registry.

Support

File an issue

Additional Documentation about ADE

License

• Legal Notice: Container License Information

See license terms here.