Build and deploy to Azure Kubernetes Service
Azure Kubernetes Service manages your hosted Kubernetes environment, making it quicker and easier for you to deploy and manage containerized applications. This service also eliminates the burden of ongoing operations and maintenance by provisioning, upgrading, and scaling resources on demand, without taking your applications offline.
In this step-by-step guide, you'll learn how to create a pipeline that continuously builds and deploys your app. Every time you change your code in a repository that contains a Dockerfile, the images are pushed to your Azure Container Registry, and the manifests are then deployed to your Azure Kubernetes Service cluster.
To ensure that your Azure DevOps project has the authorization required to access your Azure subscription, create an Azure Resource Manager service connection. The service connection is required when you create a pipeline in the project to deploy to Azure Kubernetes Service. Otherwise, the drop-down lists for Cluster and Container Registry are empty.
A GitHub account, where you can create a repository. If you don't have one, you can create one for free.
An Azure DevOps organization. If you don't have one, you can create one for free. (An Azure DevOps organization is different from your GitHub organization. Give them the same name if you want alignment between them.)
If your team already has one, then make sure you're an administrator of the Azure DevOps project that you want to use.
An Azure account. If you don't have one, you can create one for free.
If you're new at this, the easiest way to get started is to use the same email address as the owner of both the Azure Pipelines organization and the Azure subscription.
Get the code
Fork the following repository containing a sample application and a Dockerfile:
Create the Azure resources
Create a container registry
# Create a resource group az group create --name myapp-rg --location eastus # Create a container registry az acr create --resource-group myapp-rg --name myContainerRegistry --sku Basic # Create a Kubernetes cluster az aks create \ --resource-group myapp-rg \ --name myapp \ --node-count 1 \ --enable-addons monitoring \ --generate-ssh-keys \ --kubernetes-version 1.16.10
Sign in to Azure Pipelines
Sign in to Azure Pipelines. After you sign in, your browser goes to
https://dev.azure.com/my-organization-name and displays your Azure DevOps dashboard.
Within your selected organization, create a project. If you don't have any projects in your organization, you see a Create a project to get started screen. Otherwise, select the Create Project button in the upper-right corner of the dashboard.
Create the pipeline
Connect and select repository
Sign in to your Azure DevOps organization and navigate to your project.
Go to Pipelines, and then select New Pipeline.
Walk through the steps of the wizard by first selecting GitHub as the location of your source code.
You might be redirected to GitHub to sign in. If so, enter your GitHub credentials.
When the list of repositories appears, select your repository.
You might be redirected to GitHub to install the Azure Pipelines app. If so, select Approve & install.
When the Configure tab appears, select Deploy to Azure Kubernetes Service.
If you are prompted, select the subscription in which you created your registry and cluster.
For Namespace, select Existing, and then select default.
Select the name of your container registry.
You can leave the image name and the service port set to the defaults.
Set the Enable Review App for Pull Requests checkbox for review app related configuration to be included in the pipeline YAML auto-generated in subsequent steps.
Select Validate and configure.
As Azure Pipelines creates your pipeline, it:
Creates a Docker registry service connection to enable your pipeline to push images into your container registry.
Creates an environment and a Kubernetes resource within the environment. For an RBAC enabled cluster, the created Kubernetes resource implicitly creates ServiceAccount and RoleBinding objects in the cluster so that the created ServiceAccount can't perform operations outside the chosen namespace.
Generates an azure-pipelines.yml file, which defines your pipeline.
When your new pipeline appears, review the YAML to see what it does. For more information, see how we build your pipeline below. When you're ready, select Save and run.
The commit that will create your new pipeline appears. You can see the generated files mentioned above. Select Save and run.
If you want, change the Commit message to something like Add pipeline to our repository. When you're ready, select Save and run to commit the new pipeline into your repo, and then begin the first run of your new pipeline!
See the pipeline run, and your app deployed
As your pipeline runs, watch as your build stage, and then your deployment stage, go from blue (running) to green (completed). You can select the stages and jobs to watch your pipeline in action.
If you're using a Microsoft-hosted agent, you must add the IP range of the Microsoft-hosted agent to your firewall. Get the weekly list of IP ranges from the weekly JSON file, which is published every Wednesday. The new IP ranges become effective the following Monday. For more information, see Microsoft-hosted agents. To find the IP ranges that are required for your Azure DevOps organization, learn how to identify the possible IP ranges for Microsoft-hosted agents.
After the pipeline run is finished, explore what happened and then go see your app deployed. From the pipeline summary:
Select the Environments tab.
Select View environment.
Select the instance if your app for the namespace you deployed to. If you stuck to the defaults we mentioned above, then it will be the myapp app in the default namespace.
Select the Services tab.
Select and copy the external IP address to your clipboard.
Open a new browser tab or window and enter <IP address>:8080.
If you're building our sample app, then Hello world appears in your browser.
How we build your pipeline
When you finished selecting options and then proceeded to validate and configure the pipeline (see above) Azure Pipelines created a pipeline for you, using the Deploy to Azure Kubernetes Service template.
The build stage uses the Docker task to build and push the image to the Azure Container Registry.
- stage: Build displayName: Build stage jobs: - job: Build displayName: Build job pool: vmImage: $(vmImageName) steps: - task: Docker@2 displayName: Build and push an image to container registry inputs: command: buildAndPush repository: $(imageRepository) dockerfile: $(dockerfilePath) containerRegistry: $(dockerRegistryServiceConnection) tags: | $(tag) - task: PublishPipelineArtifact@1 inputs: artifactName: 'manifests' path: 'manifests'
The deployment job uses the Kubernetes manifest task to create the
imagePullSecret required by Kubernetes cluster nodes to pull from the Azure Container Registry resource. Manifest files are then used by the Kubernetes manifest task to deploy to the Kubernetes cluster.
Clean up resources
Whenever you're done with the resources you created above, you can use the following command to delete them:
az group delete --name myapp-rg
y when prompted.
az group delete --name MC_myapp-rg_myapp_eastus
y when prompted.
We invite you to learn more about:
- The services:
- The template used to create your pipeline: Deploy to existing Kubernetes cluster template
- Some of the tasks used in your pipeline, and how you can customize them: