Nota: Actualmente los ejecutores hospedados en GitHub no se admiten en GitHub Enterprise Server. Puede ver más información sobre la compatibilidad futura planeada en GitHub public roadmap.
Introducción
En esta guía se explica cómo usar GitHub Actions para compilar e implementar un contenedor de Docker en Azure App Service.
Nota: Si tus flujos de trabajo de GitHub Actions necesitan acceder a los recursos de un proveedor de servicios en la red que sea compatible con OpenID Connect (OIDC), puedes configurarlos para que se autentiquen directamente con dicho proveedor. Esto te permitirá dejar de almacenar estas credenciales como secretos de duración larga y te proporcionará otros beneficios de seguridad. Para más información, consulta "Acerca del fortalecimiento de seguridad con OpenID Connect". y "Configura OpenID Connect en Azure".
Requisitos previos
Antes de crear tu flujo de trabajo de GitHub Actions, primero necesitarás completar los siguientes pasos de configuración:
-
Crear un plan de Azure App Service.
Por ejemplo, puedes utilizar el CLI de Azure para crear un plan de App Service nuevo:
Bash az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux
az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux
En el comando anterior, reemplace
MY_RESOURCE_GROUP
por el grupo de recursos de Azure existente yMY_APP_SERVICE_PLAN
por un nuevo nombre para el plan de App Service.Para más información sobre cómo usar la CLI de Azure, vea la documentación de Azure.
- Para la autenticación, vea "Inicio de sesión con la CLI de Azure".
- Si tiene que crear un grupo de recursos, vea "az group".
-
Crear una aplicación web.
Por ejemplo, puedes utilizar el CLI de Azure para crear una app web de Azure App Service:
Shell az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --deployment-container-image-name nginx:latest
az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --deployment-container-image-name nginx:latest
En el comando anterior, reemplace los parámetros con valores propios, donde
MY_WEBAPP_NAME
es un nombre nuevo para la aplicación web. -
Configure un perfil de publicación de Azure y cree un secreto
AZURE_WEBAPP_PUBLISH_PROFILE
.Genera tus credenciales de despliegue de Azure utilizando un perfil de publicación. Para más información, vea "Generación de credenciales de implementación" en la documentación de Azure.
En el repositorio de GitHub, cree un secreto denominado
AZURE_WEBAPP_PUBLISH_PROFILE
que incluya el contenido del perfil de publicación. Para más información sobre la creación de secretos, consulta "Uso de secretos en Acciones de GitHub". -
Configura las credenciales de registro para tu app web.
Crea una personal access token con los ámbitos
repo
yread:packages
. Para obtener más información, vea «Administración de tokens de acceso personal».Establece
DOCKER_REGISTRY_SERVER_URL
enhttps://ghcr.io
,DOCKER_REGISTRY_SERVER_USERNAME
en el nombre de usuario de GitHub o la organización propietaria del repositorio, yDOCKER_REGISTRY_SERVER_PASSWORD
en tu personal access token anterior. Esto le dará credenciales a tu app web para que pueda extraer la imagen del contenedor después de que tu flujo de trabajo suba una imagen recién compilada al registro. Puedes hacerlo con el siguiente comando del CLI de Azure:az webapp config appsettings set \ --name MY_WEBAPP_NAME \ --resource-group MY_RESOURCE_GROUP \ --settings DOCKER_REGISTRY_SERVER_URL=https://ghcr.io DOCKER_REGISTRY_SERVER_USERNAME=MY_REPOSITORY_OWNER DOCKER_REGISTRY_SERVER_PASSWORD=MY_PERSONAL_ACCESS_TOKEN
-
Optionally, configure a deployment environment. Los entornos se usan para describir un destino de implementación general como
production
,staging
odevelopment
. Cuando se despliega un flujo de trabajo de GitHub Actions en un ambiente, dicho ambiente se desplegará en la página principal del repositorio. Puede usar entornos para requerir aprobación para que un trabajo continúe, restringir qué ramas pueden desencadenar un flujo de trabajo o limitar el acceso a los secretos. Para más información sobre la creación de entornos, consulta "Utilizar ambientes para el despliegue".
Crear un flujo de trabajo
Una vez que hayas completado los prerequisitos, puedes proceder con la creación del flujo de trabajo.
En el siguiente flujo de trabajo de ejemplo se muestra cómo compilar e implementar un contenedor de Docker en Azure App Service cuando se produce una inserción en la rama main
.
Asegúrese de establecer AZURE_WEBAPP_NAME
en la clave env
del flujo de trabajo en el nombre de la aplicación web que ha creado.
Si ha configurado un entorno de implementación, cambie el valor de environment
por el nombre del entorno. Si no ha configurado un entorno, borre la clave environment
.
# Este flujo de trabajo usa acciones que no GitHub no certifica. # Estas las proporcionan entidades terceras y las gobiernan # condiciones de servicio, políticas de privacidad y documentación de soporte # en línea. # GitHub recomienda anclar acciones a un SHA de confirmación. # Para obtener una versión más reciente, debes actualizar el SHA. # También puedes hacer referencia a una etiqueta o rama, pero la acción puede cambiar sin ninguna advertencia. name: Build and deploy a container to an Azure Web App env: AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name on: push: branches: - main permissions: contents: 'read' packages: 'write' jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v2 - name: Log in to GitHub container registry uses: docker/login-action@v2 with: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - name: Lowercase the repo name run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV} - name: Build and push container image to registry uses: docker/build-push-action@v4 with: push: true tags: ghcr.io/${{ env.REPO }}:${{ github.sha }} file: ./Dockerfile deploy: runs-on: ubuntu-latest needs: build environment: name: 'production' url: ${{ steps.deploy-to-webapp.outputs.webapp-url }} steps: - name: Lowercase the repo name run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV} - name: Deploy to Azure Web App id: deploy-to-webapp uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c with: app-name: ${{ env.AZURE_WEBAPP_NAME }} publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }} images: 'ghcr.io/${{ env.REPO }}:${{ github.sha }}'
# Este flujo de trabajo usa acciones que no GitHub no certifica.
# Estas las proporcionan entidades terceras y las gobiernan
# condiciones de servicio, políticas de privacidad y documentación de soporte
# en línea.
# GitHub recomienda anclar acciones a un SHA de confirmación.
# Para obtener una versión más reciente, debes actualizar el SHA.
# También puedes hacer referencia a una etiqueta o rama, pero la acción puede cambiar sin ninguna advertencia.
name: Build and deploy a container to an Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
on:
push:
branches:
- main
permissions:
contents: 'read'
packages: 'write'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
- name: Log in to GitHub container registry
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Build and push container image to registry
uses: docker/build-push-action@v4
with:
push: true
tags: ghcr.io/${{ env.REPO }}:${{ github.sha }}
file: ./Dockerfile
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
steps:
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@85270a1854658d167ab239bce43949edb336fa7c
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
images: 'ghcr.io/${{ env.REPO }}:${{ github.sha }}'
Recursos adicionales
Los siguientes recursos también pueden ser útiles:
- Para obtener el flujo de trabajo de inicio original, vea
azure-container-webapp.yml
en el repositoriostarter-workflows
de GitHub Actions. - La acción que se usa para implementar la aplicación web es la acción
Azure/webapps-deploy
oficial de Azure. - Para obtener más ejemplos de flujos de trabajo de acción de GitHub que se implementan en Azure, vea el repositorio actions-workflow-samples.