Tornar seu projeto compatível com a CLI do Azure Developer

A CLI do Desenvolvedor do Azure (azd) permite que os desenvolvedores façam scaffold de seus aplicativos para a nuvem usando modelos hospedados no GitHub. A Microsoft fornece vários modelos para você começar. Neste artigo, você aprenderá como tornar seu próprio aplicativo azd compatível.

Compreender a arquitetura do modelo

O diagrama a seguir fornece uma visão geral rápida do processo para criar um azd modelo:

Todos os azd modelos têm a mesma estrutura de arquivos, com base em azd convenções. A hierarquia a seguir mostra a estrutura de diretórios que você criará neste tutorial.

├── .azdo                                        [ Configures an Azure Pipeline ]
├── .devcontainer                                [ For DevContainer ]
├── .github                                      [ Configures a GitHub workflow ]
├── .vscode                                      [ VS Code workspace configurations ]
├── .azure                                       [ Stores Azure configurations and environment variables ]
├── infra                                        [ Contains infrastructure as code files ]
│   ├── main.bicep/main.tf                       [ Main infrastructure file ]
│   ├── main.parameters.json/main.tfvars.json    [ Parameters file ]
│   └── core/modules                             [ Contains reusable Bicep/Terraform modules ]
└── azure.yaml                                   [ Describes the app and type of Azure resources]

Inicializar o modelo

O azd init comando é usado para inicializar seu aplicativo para provisionamento e implantação dos recursos do aplicativo no Azure. Este comando solicita que você escolha entre dois fluxos de trabalho diferentes para inicializar um modelo descrito nas seções a seguir.

• Usar código no diretório atual: Selecione esta opção para instruir azd a analisar o código em seu diretório para identificar quais tecnologias ele usa, como a linguagem de programação, a estrutura e o sistema de banco de dados. azd Em seguida, gerará automaticamente ativos de modelo para você, como o azure.yaml arquivo de definição de serviço e a infra pasta com arquivos de infraestrutura como código.

• Selecione um modelo: selecione esta opção para usar um modelo existente como ponto de partida. Por padrão, permite que você navegue por modelos da galeria Awesome AZD, azd mas você também pode configurar suas próprias galerias de modelos. Quando você seleciona um modelo, os ativos desse modelo serão adicionados ao diretório de projeto existente.

Os detalhes de cada um desses fluxos de trabalho são descritos nas seções abaixo.

Usar código no diretório

1. Você pode seguir as etapas à frente usando seu próprio projeto. No entanto, se você preferir acompanhar usando um aplicativo de exemplo, clone o repositório inicial a seguir para um diretório vazio no seu computador:

   git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
   

2. Abra sua ferramenta de linha de comando de escolha para o diretório raiz do projeto.

3. Execute o comando para inicializar o azd init modelo.

   azd init
   

4. Quando solicitado, selecione a opção Usar código no diretório atual. azd analisa o projeto e fornece um resumo dos serviços detetados e dos recursos de hospedagem recomendados do Azure.

5. Selecione Confirmar e continuar inicializando meu aplicativo. azd gera os seguintes ativos no diretório raiz do projeto:

   • Um azure.yaml arquivo com definições de serviço apropriadas.
   • Uma infra pasta com arquivos de infraestrutura como código para provisionar e implantar o projeto no Azure.
   • Uma .azure pasta com variáveis de ambiente definidas em um .env arquivo.

   Mais detalhes sobre esse processo de deteção e geração são fornecidos mais adiante no artigo.

6. Os arquivos gerados funcionam como estão para o aplicativo de exemplo fornecido e podem para seus próprios aplicativos também. Se necessário, os arquivos gerados podem ser modificados para atender às suas necessidades. Por exemplo, talvez seja necessário modificar ainda mais os arquivos de infraestrutura como código na infra pasta se seu aplicativo depender de recursos do Azure além daqueles que foram identificados pelo azd.

7. Execute o azd up comando para provisionar e implantar seu aplicativo no Azure.

   azd up
   

8. Quando solicitado, selecione a assinatura e o local desejados para iniciar o processo de provisionamento e implantação.

9. Quando o processo for concluído, clique no link na saída para abrir o aplicativo no azd navegador.

Explore as etapas de inicialização

Quando você seleciona o código Usar no fluxo de trabalho de diretório atual, o comando analisa seu projeto e gera automaticamente o azd init código com base no que ele descobre. As seções abaixo explicam os detalhes de como esse processo funciona e quais tecnologias são suportadas atualmente.

Detection

O azd init comando deteta arquivos de projeto para idiomas suportados localizados no diretório e subdiretórios do projeto. azd também verificará as dependências do pacote para coletar informações sobre as estruturas da Web ou bancos de dados que seu aplicativo usa. Se necessário, você pode adicionar ou editar manualmente os componentes detetados conforme apresentado no prompt de resumo de confirmação.

A lógica de deteção atual é a seguinte:

• Idiomas suportados:
  • Python
  • JavaScript/TypeScript
  • .NET
  • Java
• Bases de dados suportadas:
  • MongoDB
  • PostgreSQL
• Para Python e JavaScript/TypeScript, frameworks da web e bancos de dados são detetados automaticamente.
• Quando um projeto JavaScript/TypeScript usa uma estrutura da Web front-end (ou do lado do cliente), ele é classificado como um serviço front-end. Se o seu serviço usa uma estrutura da Web front-end que não é detetada no momento, você pode selecionar JQuery para fornecer classificação e comportamento de serviço front-end equivalente.

Geração

Depois de confirmar os componentes detetados, azd init gera os arquivos de infraestrutura como código necessários para implantar seu aplicativo no Azure.

A lógica de geração é a seguinte:

• Anfitriões suportados:
  • Aplicativos de contêiner do Azure.
• Para bancos de dados, o mapeamento suportado entre a tecnologia de banco de dados e o serviço usado:
  • MongoDB: API do Azure CosmosDB para MongoDB
  • PostgreSQL: Banco de Dados do Azure para servidor flexível PostgreSQL
  • Redis: Complemento Redis do Azure Container Apps
• Os serviços que usam bancos de dados terão variáveis de ambiente que fornecem conexão com o banco de dados pré-configurado por padrão.
• Quando os serviços front-end e back-end forem detetados, a configuração CORS no host do Azure para serviços back-end será atualizada para permitir o domínio de hospedagem padrão dos serviços front-end. Isso pode ser modificado ou removido conforme necessário nos arquivos de configuração Infraestrutura como código.

Adicionar suporte para contêineres de desenvolvimento

Você também pode tornar seu modelo compatível com contêineres de desenvolvimento e Codespaces. Um contêiner de desenvolvimento permite que você use um contêiner como um ambiente de desenvolvimento completo. Ele pode ser usado para executar um aplicativo, para separar ferramentas, bibliotecas ou tempos de execução necessários para trabalhar com uma base de código e para ajudar na integração e teste contínuos. Os contêineres de desenvolvimento podem ser executados local ou remotamente, em uma nuvem privada ou pública. (Fonte: https://containers.dev/)

Para adicionar suporte para contêineres de desenvolvimento:

1. Crie uma pasta .devcontainer na raiz do seu projeto.

2. Crie um devcontainer.json arquivo dentro da .devcontainer pasta com as configurações desejadas. O azd modelo inicial fornece um arquivo de exemplo devcontainer.json que você pode copiar para seu projeto e modificar conforme necessário.

Leia mais sobre como trabalhar com contêineres de desenvolvimento na documentação do Visual Studio Code.

Adicionar suporte para um pipeline de CI/CD

Você também pode adicionar suporte para CI/CD em seu modelo usando ações do GitHub ou Azure DevOps usando as seguintes etapas:

1. Adicione uma pasta para ações do GitHub ou uma .github.ado pasta para o Azure DevOps à raiz do seu projeto.

2. Adicione um arquivo de fluxo de trabalho à nova pasta. O azd modelo inicial fornece um arquivo de fluxo de trabalho de Ações de Exemplo do GitHub e arquivos de Pipelines de DevOps do Azure de Exemplo para cada plataforma que você pode copiar para seu projeto e modificar conforme necessário.

3. Também pode ser necessário atualizar o main.parameters.json arquivo em sua infra pasta com as variáveis de ambiente necessárias para que seu fluxo de trabalho seja executado.

Utilizar um modelo

O fluxo de trabalho Selecionar um modelo permite que você escolha um modelo existente azd para usar como ponto de partida. O conteúdo do modelo selecionado é adicionado ao diretório raiz do seu projeto. A maioria dos modelos fornece o conjunto necessário de arquivos e pastas, e alguns modelos incluem arquivos completos de infraestrutura como código para provisionar recursos do Azure para uma pilha de azd aplicativos escolhida.

Neste exemplo, você usará o modelo Starter - Bicep , que inclui a estrutura essencial de um azd modelo e algum código clichê útil para começar.

1. Para acompanhar as etapas à frente usando um aplicativo de exemplo existente, clone o seguinte projeto inicial para um diretório vazio no seu computador:

   git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
   

2. Na ferramenta de linha de comando de sua escolha, navegue até o diretório raiz do projeto clonado.

3. Execute o azd init comando para inicializar um azd modelo.

   azd init
   

4. Quando solicitado, escolha a opção Selecionar um modelo.

5. Na lista de modelos, selecione Starter - Bicep. Talvez seja necessário percorrer a lista usando as teclas de seta do teclado para encontrar o modelo.

6. Quando solicitado, insira um nome de ambiente curto, como testenv.

7. Depois de executar azd inito , os seguintes ativos são adicionados ao seu projeto:

   ├── .azdo                                        [ Configures an Azure Pipeline ]
   ├── .devcontainer                                [ For DevContainer ]
   ├── .github                                      [ Configures a GitHub workflow ]
   ├── .vscode                                      [ VS Code workspace configurations ]
   ├── .azure                                       [ Stores Azure configurations and environment variables ]
   ├── infra                                        [ Contains infrastructure as code files ]
   │   ├── main.bicep/main.tf                       [ Main infrastructure file ]
   │   ├── main.parameters.json/main.tfvars.json    [ Parameters file ]
   │   └── core/modules                             [ Contains reusable Bicep/Terraform modules ]
   └── azure.yaml                                   [ Describes the app and type of Azure resources]
   

Atualizar os arquivos do Bicep

Seu projeto agora contém a estrutura principal e os ativos de um azd modelo. No entanto, para provisionar os recursos do Azure para seu projeto específico, os arquivos Bicep na infra pasta precisam ser atualizados. Para hospedar o aplicativo de exemplo, você precisará dos seguintes recursos:

• Um plano do Serviço de Aplicativo do Azure
• Um Serviço de Aplicativo do Azure em execução no Linux

1. Abra o diretório de projeto de nível superior em seu editor de escolha, como o Visual Studio Code.

2. Abra o main.bicep arquivo no editor. Este arquivo contém código clichê útil para configurar variáveis essenciais, parâmetros e convenções de nomenclatura. Abaixo do bloco de comentários em torno da linha 50 que lê , adicione o seguinte Bíceps Add resources to be provisioned below:

   // Creates an app service instance to host the app
   module web './core/host/appservice.bicep' = {
     name: 'web'
     scope: rg
     params: {
       name: '${abbrs.webSitesAppService}web-${resourceToken}'
       location: location
       tags: union(tags, { 'azd-service-name': 'web' })
       appServicePlanId: appServicePlan.outputs.id
       runtimeName: 'python'
       runtimeVersion: '3.8'
       scmDoBuildDuringDeployment: true
     }
   }
   
   // Create an App Service Plan to group applications under the same payment plan and SKU
   module appServicePlan './core/host/appserviceplan.bicep' = {
     name: 'appserviceplan'
     scope: rg
     params: {
       name: '${abbrs.webServerFarms}${resourceToken}'
       location: location
       tags: tags
       sku: {
         name: 'B1'
       }
     }
   }
   

   Nota

   • Uma cadeia de caracteres exclusiva é gerada com base na ID da assinatura e usada como uma ${resourceToken} variável. Esse token é anexado ao nome de todos os recursos do Azure criados pelo azd. azd usa tags para identificar recursos para que você possa modificar os nomes com base na convenção de nomenclatura da sua organização.
   • A 'azd-service-name': 'web' tag no serviço de aplicativo é o valor azd usado para identificar o host de implantação. O valor deve ser o mesmo que o definido para o serviço no arquivo azure.yaml .

Atualizar o arquivo azure.yaml

Para implantar o aplicativo, azd precisa saber mais sobre seu aplicativo. O azure.yaml arquivo é usado para definir o local do código-fonte, o idioma e o serviço de hospedagem do Azure para cada serviço em seu aplicativo. Para obter detalhes completos, consulte o esquema azure.yaml.

1. Abra o azure.yaml na raiz do projeto.

2. Adicione as seguintes linhas à parte inferior do ficheiro:

   name: msdocs-python-flask-webapp-quickstart
   services:
     web:
       project: .
       language: py
       host: appservice
   

Provisionar e implantar o modelo

1. Salve todas as suas alterações e execute o seguinte comando para provisionar e implantar os recursos do aplicativo no Azure:

   azd up
   

2. Quando o comando terminar, clique no link na saída do comando para navegar até o site implantado.

Seu projeto agora é compatível com a CLI do Azure Developer e pode ser usado como um modelo!

Nota

azd também suporta o uso do Buildpack para containerizar seus aplicativos por padrão. Se o seu modelo tiver como alvo os Aplicativos de Contêiner do Azure ou o Serviço Kubernetes do Azure, mas não incluir um arquivo do Docker, azd gerará automaticamente uma imagem usando o azd Buildpack.

Configurar o pipeline de CI/CD

Se seu modelo incluir suporte para Ações do GitHub ou Pipelines do Azure, você poderá configurar um pipeline de CI/CD usando as seguintes etapas:

1. Execute o seguinte comando para enviar atualizações por push para o repositório. O fluxo de trabalho de Ações do GitHub é acionado devido à atualização.

   azd pipeline config    
   

2. Usando seu navegador, vá para o repositório GitHub do seu projeto.

3. Selecione Ações para ver o fluxo de trabalho em execução.

Clean up resources (Limpar recursos)

Quando não precisar mais dos recursos criados neste artigo, execute o seguinte comando:

azd down

Consulte também

• Crie arquivos Bicep com o Visual Studio Code para uma introdução ao trabalho com arquivos Bicep.
• Amostras de bíceps
• Como descompilar modelos do Azure Resource Manager (modelos ARM) para o Bicep
• Esquema azure.yaml da CLI do Azure Developer

Pedir ajuda

Para obter informações sobre como arquivar um bug, solicitar ajuda ou propor um novo recurso para a CLI do Desenvolvedor do Azure, visite a página de solução de problemas e suporte .

Próximos passos

FAQ sobre o Azure Developer CLI