mirror of https://github.com/docker/docs.git
[feat] added azure pipelines guide (#22777)
This PR introduces a new CI pipeline using Azure Pipelines to automate the process of building and pushing Docker images to Docker Hub. --------- Co-authored-by: Julien Maitrehenry <julien.maitrehenry@me.com>
This commit is contained in:
Kristiyan Velkov
GitHub
parent
46349c4988
commit
ae2a14a545
|
|
@ -0,0 +1,311 @@
|
|||
---
|
||||
title: Introduction to Azure Pipelines with Docker
|
||||
linkTitle: Azure Pipelines and Docker
|
||||
summary: |
|
||||
Learn how to automate Docker image build and push using Azure Pipelines.
|
||||
params:
|
||||
tags: [devops]
|
||||
time: 10 minutes
|
||||
---
|
||||
|
||||
> This guide is a community contribution. Docker would like to thank [Kristiyan Velkov](https://www.linkedin.com/in/kristiyan-velkov-763130b3/) for his valuable contribution.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, ensure you have the following requirements:
|
||||
|
||||
- A [Docker Hub account](https://hub.docker.com) with a generated access token.
|
||||
- An active [Azure DevOps project](https://dev.azure.com/) with a connected [Git repository](https://learn.microsoft.com/en-us/azure/devops/repos/git/?view=azure-devops).
|
||||
- A project that includes a valid [`Dockerfile`](https://docs.docker.com/engine/reference/builder/) at its root or appropriate build context.
|
||||
|
||||
## Overview
|
||||
|
||||
This guide walks you through building and pushing Docker images using [Azure Pipelines](https://azure.microsoft.com/en-us/products/devops/pipelines), enabling a streamlined and secure CI workflow for containerized applications. You’ll learn how to:
|
||||
|
||||
- Configure Docker authentication securely.
|
||||
- Set up an automated pipeline to build and push images.
|
||||
|
||||
## Set up Azure DevOps to work with Docker Hub
|
||||
|
||||
### Step 1: Configure a Docker Hub service connection
|
||||
|
||||
To securely authenticate with Docker Hub using Azure Pipelines:
|
||||
|
||||
1. Navigate to **Project Settings > Service Connections** in your Azure DevOps project.
|
||||
2. Select **New service connection > Docker Registry**.
|
||||
3. Choose **Docker Hub** and provide your Docker Hub credentials or access token.
|
||||
4. Give the service connection a recognizable name, such as `my-docker-registry`.
|
||||
5. Grant access only to the specific pipeline(s) that require it for improved security and least privilege.
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> Avoid selecting the option to grant access to all pipelines unless absolutely necessary. Always apply the principle of least privilege.
|
||||
|
||||
### Step 2: Create your pipeline
|
||||
|
||||
Add the following `azure-pipelines.yml` file to the root of your repository:
|
||||
|
||||
```yaml
|
||||
# Trigger pipeline on commits to the main branch
|
||||
trigger:
|
||||
- main
|
||||
|
||||
# Trigger pipeline on pull requests targeting the main branch
|
||||
pr:
|
||||
- main
|
||||
|
||||
# Define variables for reuse across the pipeline
|
||||
variables:
|
||||
imageName: 'docker.io/$(dockerUsername)/my-image'
|
||||
buildTag: '$(Build.BuildId)'
|
||||
latestTag: 'latest'
|
||||
|
||||
stages:
|
||||
- stage: BuildAndPush
|
||||
displayName: Build and Push Docker Image
|
||||
jobs:
|
||||
- job: DockerJob
|
||||
displayName: Build and Push
|
||||
pool:
|
||||
vmImage: ubuntu-latest
|
||||
demands:
|
||||
- docker
|
||||
steps:
|
||||
- checkout: self
|
||||
displayName: Checkout Code
|
||||
|
||||
- task: Docker@2
|
||||
displayName: Docker Login
|
||||
inputs:
|
||||
command: login
|
||||
containerRegistry: 'my-docker-registry' # Service connection name
|
||||
|
||||
- task: Docker@2
|
||||
displayName: Build Docker Image
|
||||
inputs:
|
||||
command: build
|
||||
repository: $(imageName)
|
||||
tags: |
|
||||
$(buildTag)
|
||||
$(latestTag)
|
||||
dockerfile: './Dockerfile'
|
||||
arguments: |
|
||||
--sbom=true
|
||||
--attest type=provenance
|
||||
--cache-from $(imageName):latest
|
||||
env:
|
||||
DOCKER_BUILDKIT: 1
|
||||
|
||||
- task: Docker@2
|
||||
displayName: Push Docker Image
|
||||
condition: eq(variables['Build.SourceBranch'], 'refs/heads/main')
|
||||
inputs:
|
||||
command: push
|
||||
repository: $(imageName)
|
||||
tags: |
|
||||
$(buildTag)
|
||||
$(latestTag)
|
||||
|
||||
# Optional: logout for self-hosted agents
|
||||
- script: docker logout
|
||||
displayName: Docker Logout (Self-hosted only)
|
||||
condition: ne(variables['Agent.OS'], 'Windows_NT')
|
||||
```
|
||||
|
||||
## What this pipeline does
|
||||
|
||||
This pipeline automates the Docker image build and deployment process for the main branch. It ensures a secure and efficient workflow with best practices like caching, tagging, and conditional cleanup. Here's what it does:
|
||||
|
||||
- Triggers on commits and pull requests targeting the `main` branch.
|
||||
- Authenticates securely with Docker Hub using an Azure DevOps service connection.
|
||||
- Builds and tags the Docker image using Docker BuildKit for caching.
|
||||
- Pushes both buildId and latest tags to Docker Hub.
|
||||
- Logs out from Docker if running on a self-hosted Linux agent.
|
||||
|
||||
|
||||
## How the pipeline works
|
||||
|
||||
### Step 1: Define pipeline triggers
|
||||
|
||||
```yaml
|
||||
trigger:
|
||||
- main
|
||||
|
||||
pr:
|
||||
- main
|
||||
```
|
||||
|
||||
This pipeline is triggered automatically on:
|
||||
- Commits pushed to the `main` branch
|
||||
- Pull requests targeting `main` main branch
|
||||
|
||||
> [!TIP]
|
||||
> Learn more: [Define pipeline triggers in Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/triggers?view=azure-devops)
|
||||
|
||||
### Step 2: Define common variables
|
||||
|
||||
```yaml
|
||||
variables:
|
||||
imageName: 'docker.io/$(dockerUsername)/my-image'
|
||||
buildTag: '$(Build.BuildId)'
|
||||
latestTag: 'latest'
|
||||
```
|
||||
|
||||
These variables ensure consistent naming, versioning, and reuse throughout the pipeline steps:
|
||||
|
||||
- `imageName`: your image path on Docker Hub
|
||||
- `buildTag`: a unique tag for each pipeline run
|
||||
- `latestTag`: a stable alias for your most recent image
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> The variable `dockerUsername` is not set automatically.
|
||||
> Set it securely in your Azure DevOps pipeline variables:
|
||||
> 1. Go to **Pipelines > Edit > Variables**
|
||||
> 2. Add `dockerUsername` with your Docker Hub username
|
||||
>
|
||||
> Learn more: [Define and use variables in Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch)
|
||||
|
||||
### Step 3: Define pipeline stages and jobs
|
||||
|
||||
```yaml
|
||||
stages:
|
||||
- stage: BuildAndPush
|
||||
displayName: Build and Push Docker Image
|
||||
```
|
||||
|
||||
This stage executes only if the source branch is `main`.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Learn more: [Stage conditions in Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/stages?view=azure-devops&tabs=yaml)
|
||||
|
||||
|
||||
### Step 4: Job configuration
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
- job: DockerJob
|
||||
displayName: Build and Push
|
||||
pool:
|
||||
vmImage: ubuntu-latest
|
||||
demands:
|
||||
- docker
|
||||
```
|
||||
|
||||
This job utilizes the latest Ubuntu VM image with Docker support, provided by Microsoft-hosted agents. It can be replaced with a custom pool for self-hosted agents if necessary.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Learn more: [Specify a pool in your pipeline](https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/pools-queues?view=azure-devops&tabs=yaml%2Cbrowser)
|
||||
|
||||
#### Step 4.1: Checkout code
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- checkout: self
|
||||
displayName: Checkout Code
|
||||
```
|
||||
|
||||
This step pulls your repository code into the build agent, so the pipeline can access the Dockerfile and application files.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Learn more: [checkout step documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/steps-checkout?view=azure-pipelines)
|
||||
|
||||
#### Step 4.2: Authenticate to Docker Hub
|
||||
|
||||
```yaml
|
||||
- task: Docker@2
|
||||
displayName: Docker Login
|
||||
inputs:
|
||||
command: login
|
||||
containerRegistry: 'my-docker-registry' # Replace with your service connection name
|
||||
```
|
||||
|
||||
Uses a pre-configured Azure DevOps Docker registry service connection to authenticate securely without exposing credentials directly.
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Learn more: [Use service connections for Docker Hub](https://learn.microsoft.com/en-us/azure/devops/pipelines/library/service-endpoints?view=azure-devops#docker-hub-or-others)
|
||||
|
||||
#### Step 4.3: Build the Docker image
|
||||
|
||||
```yaml
|
||||
- task: Docker@2
|
||||
displayName: Build Docker Image
|
||||
inputs:
|
||||
command: build
|
||||
repository: $(imageName)
|
||||
tags: |
|
||||
$(buildTag)
|
||||
$(latestTag)
|
||||
dockerfile: './Dockerfile'
|
||||
arguments: |
|
||||
--sbom=true
|
||||
--attest type=provenance
|
||||
--cache-from $(imageName):latest
|
||||
env:
|
||||
DOCKER_BUILDKIT: 1
|
||||
```
|
||||
|
||||
This builds the image with:
|
||||
|
||||
- Two tags: one with the unique Build ID and one as latest
|
||||
- Docker BuildKit enabled for faster builds and efficient layer caching
|
||||
- Cache pull from the most recent pushed latest image
|
||||
- Software Bill of Materials (SBOM) for supply chain transparency
|
||||
- Provenance attestation to verify how and where the image was built
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
> Learn more:
|
||||
> - [Docker task for Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/docker-v2?view=azure-pipelines&tabs=yaml)
|
||||
> - [Docker SBOM Attestations](/manuals/build/metadata/attestations/slsa-provenance.md)
|
||||
|
||||
#### Step 4.4: Push the Docker image
|
||||
|
||||
```yaml
|
||||
- task: Docker@2
|
||||
displayName: Push Docker Image
|
||||
condition: eq(variables['Build.SourceBranch'], 'refs/heads/main')
|
||||
inputs:
|
||||
command: push
|
||||
repository: $(imageName)
|
||||
tags: |
|
||||
$(buildTag)
|
||||
$(latestTag)
|
||||
```
|
||||
|
||||
By applying this condition, the pipeline builds the Docker image on every run to ensure early detection of issues, but only pushes the image to the registry when changes are merged into the main branch—keeping your Docker Hub clean and focused
|
||||
|
||||
This uploads both tags to Docker Hub:
|
||||
- `$(buildTag)` ensures traceability per run.
|
||||
- `latest` is used for most recent image references.
|
||||
|
||||
#### Step 4.5 Logout of Docker (self-hosted agents)
|
||||
|
||||
```yaml
|
||||
- script: docker logout
|
||||
displayName: Docker Logout (Self-hosted only)
|
||||
condition: ne(variables['Agent.OS'], 'Windows_NT')
|
||||
```
|
||||
|
||||
Executes docker logout at the end of the pipeline on Linux-based self-hosted agents to proactively clean up credentials and enhance security posture.
|
||||
|
||||
## Summary
|
||||
|
||||
With this Azure Pipelines CI setup, you get:
|
||||
|
||||
- Secure Docker authentication using a built-in service connection.
|
||||
- Automated image building and tagging triggered by code changes.
|
||||
- Efficient builds leveraging Docker BuildKit cache.
|
||||
- Safe cleanup with logout on persistent agents.
|
||||
- Build images that meet modern software supply chain requirements with SBOM and attestation
|
||||
|
||||
## Learn more
|
||||
|
||||
- [Azure Pipelines Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops): Comprehensive guide to configuring and managing CI/CD pipelines in Azure DevOps.
|
||||
- [Docker Task for Azure Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/build/docker): Detailed reference for using the Docker task in Azure Pipelines to build and push images.
|
||||
- [Docker Buildx Bake](/manuals/build/bake/_index.md): Explore Docker's advanced build tool for complex, multi-stage, and multi-platform build setups. See also the [Mastering Buildx Bake Guide](/guides/bake/index.md) for practical examples and best practices.
|
||||
- [Docker Build Cloud](/guides/docker-build-cloud/_index.md): Learn about Docker's managed build service for faster, scalable, and multi-platform image builds in the cloud.
|
||||
Loading…
Reference in New Issue