Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.
Introdução
Este guia explica como usar o GitHub Actions para criar e implantar um contêiner do Docker no Serviço de Aplicativo do Azure.
Observação: Se os seus fluxos de trabalho de GitHub Actions tiverem de acessar recursos de um provedor de nuvem compatível com o OpenID Connect (OIDC), você poderá configurar seus fluxos de trabalho para efetuar a autenticção diretamente no provedor de nuvem. Isso permitirá que você pare de armazenar essas credenciais como segredos de longa duração e proporcione outros benefícios de segurança. Para obter mais informações, confira "Sobre o enrijecimento de segurança com o OpenID Connect". e "Configurando o OpenID Connect no Azure".
Pré-requisitos
Antes de criar seu fluxo de trabalho de GitHub Actions, primeiro você precisa concluir as etapas de configuração a seguir:
-
Criar um Plano do Serviço de Aplicativo do Azure.
Por exemplo, você pode usar o CLI do Azure para criar um novo plano de App Service:
Shell az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux
No comando acima, substitua
MY_RESOURCE_GROUP
pelo grupo de recursos preexistente do Azure eMY_APP_SERVICE_PLAN
por um novo nome para o Plano do Serviço de Aplicativo.Confira a documentação do Azure para obter mais informações sobre como usar a CLI do Azure:
- Para autenticação, confira "Conectar-se com a CLI do Azure".
- Caso precise criar um grupo de recursos, confira "az group".
-
Crie um aplicativo Web.
Por exemplo, você pode usar a CLI do Azure para criar um aplicativo no Azure App Service Web:
Shell az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --deployment-container-image-name nginx:latest
No comando acima, substitua os parâmetros por valores próprios, em que
MY_WEBAPP_NAME
é um novo nome para o aplicativo Web. -
Configure um perfil de publicação do Azure e crie um segredo
AZURE_WEBAPP_PUBLISH_PROFILE
.Gere suas credenciais de implantação do Azure usando um perfil de publicação. Para obter mais informações, confira "Gerar credenciais de implantação" na documentação do Azure.
No repositório do GitHub, crie um segredo chamado
AZURE_WEBAPP_PUBLISH_PROFILE
que inclua o conteúdo do perfil de publicação. Para obter mais informações sobre como criar segredos, veja "Segredos criptografados". -
Defina as credenciais de registro para o seu aplicativo web.
Crie um personal access token com os escopos
repo
eread:packages
. Para obter mais informações, confira "Managing your personal access tokens".Defina
DOCKER_REGISTRY_SERVER_URL
comohttps://ghcr.io
,DOCKER_REGISTRY_SERVER_USERNAME
como o nome de usuário ou da organização do GitHub que é o proprietário do repositório eDOCKER_REGISTRY_SERVER_PASSWORD
como o personal access token acima. Isso fornecerá credenciais do seu aplicativo web para que ele possa puxar a imagem do contêiner depois que seu fluxo de trabalho fizer push de uma imagem recém-criada para o registro. Você pode fazer isso com o seguinte comando da CLI do 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
-
Opcionalmente, configure um ambiente de implantação. Os ambientes são usados para descrever um destino de implantação geral, como
production
,staging
oudevelopment
. Quando um fluxo de trabalho de GitHub Actions é implantado em um ambiente, o ambiente é exibido na página principal do repositório. Você pode usar ambientes para exigir aprovação para um trabalho para prosseguir, restringir quais branches podem acionar um fluxo de trabalho ou limitar o acesso a segredos. Para obter mais informações sobre como criar ambientes, confira "Como usar ambientes para implantação".
Criar o fluxo de trabalho
Depois de preencher os pré-requisitos, você pode prosseguir com a criação do fluxo de trabalho.
O fluxo de trabalho a seguir demonstra como criar e implantar um contêiner Docker no Azure App Service quando há push para o branch main
.
Defina AZURE_WEBAPP_NAME
na chave env
de fluxo de trabalho como o nome do aplicativo Web que você criou.
Se você configurou um ambiente de implantação, altere o valor de environment
para que ele seja o nome do seu ambiente. Se você não tiver configurado um ambiente, exclua a chave environment
.
# Esse fluxo de trabalho usa ações que não são certificadas pelo GitHub.
# São fornecidas por terceiros e regidas por
# termos de serviço, política de privacidade e suporte separados
# online.
# O GitHub recomenda fixar ações em um SHA de commit.
# Para obter uma versão mais recente, você precisará atualizar o SHA.
# Você também pode fazer referência a uma marca ou branch, mas a ação pode ser alterada sem aviso.
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@v3
- 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@05ac4e98bfa0f856e6669624239291c73ca27698
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
images: 'ghcr.io/${{ env.REPO }}:${{ github.sha }}'
Recursos adicionais
Os seguintes recursos também podem ser úteis:
- Para o fluxo de trabalho inicial original, confira
azure-container-webapp.yml
no repositóriostarter-workflows
do GitHub Actions. - A ação usada para implantar o aplicativo Web é a ação
Azure/webapps-deploy
oficial do Azure. - Para ver mais exemplos de fluxos de trabalho do GitHub Action que são implantados no Azure, confira o repositório actions-workflow-samples.