Megosztás a következőn keresztül:

Folyamat konfigurálása és frissítések leküldése

  • Cikk

Ebben a cikkben megtudhatja, hogyan küldheti le a sablonmódosításokat az Azure Developer CLI (azd) használatával egy CI/CD-folyamaton keresztül, például a GitHub Actions vagy az Azure DevOps használatával. Ebben a példában a React webalkalmazást fogja használni Node.js API-val és MongoDB-vel az Azure-sablonon , de a cikkben ismertetett alapelveket bármelyik Azure Developer CLI-sablonra alkalmazhatja.

Feljegyzés

A azd pipeline config parancs még bétaverzióban van. További információ az alfa- és bétaverziós funkciók támogatásáról a funkciók verziószámozási és kiadási stratégiájának oldalán.

Előfeltételek

azd A sablonok tartalmazhatnak alapértelmezett GitHub Actions- és/vagy Azure DevOps-folyamatkonfigurációs fájlt azure-dev.yml, amely a CI/CD telepítéséhez szükséges. Ez a konfigurációs fájl kiépíti az Azure-erőforrásokat, és üzembe helyezi a kódot a főágban. A következőt találja azure-dev.yml:

  • GitHub Actions esetén: a .github/workflows könyvtárban.
  • Azure DevOps esetén: a .azdo/pipelines könyvtárban.

A konfigurációs fájlt igény szerint használhatja, vagy módosíthatja.

Feljegyzés

Hívás előtt azd pipeline configgyőződjön meg arról, hogy a sablon rendelkezik folyamatdefinícióval (azure-dev.yaml). azd nem hozza létre automatikusan ezt a fájlt. Lásd alább az azd folyamatdefiníciójának létrehozását.

CI/CD-folyamat konfigurálásához a azd pipeline config következő feladatokat kezelő parancsot kell használnia:

  • Létrehoz és konfigurál egy egyszerű szolgáltatást az alkalmazáshoz az Azure-előfizetésben. A felhasználónak szerepkört vagy Contributor + User Access Administrator szerepkört kell tartalmaznia Owner az Azure-előfizetésben, mert lehetővé kell tennie, hogy az azd szerepköröket hozzon létre és rendeljen hozzá a szolgáltatásnévhez.
  • Végigvezeti a munkafolyamaton egy GitHub- vagy Azure DevOps-adattár létrehozásához és konfigurálásához, valamint a projektkód véglegesítéséhez. Egy meglévő adattárat is használhat.
  • Biztonságos kapcsolatot hoz létre az Azure és az adattár között.
  • A Munkafolyamat-fájl beadásakor futtatja a GitHub-műveletet.

Ha részletesebben szeretné szabályozni ezt a folyamatot, vagy ha a felhasználó nem rendelkezik a szükséges szerepkörökkal, manuálisan konfigurálhat egy folyamatot.

Válassza ki a kívánt folyamatszolgáltatót a folytatáshoz:

A GitHub üzembe helyezésének engedélyezése az Azure-ban

A munkafolyamat konfigurálásához engedélyeznie kell egy egyszerű szolgáltatásnevet az Azure-ban az Ön nevében, egy GitHub-műveletből. azd létrehozza a szolgáltatásnevet és egy összevont hitelesítő adatot .

  1. Futtassa a következő parancsot az Azure-szolgáltatásnév létrehozásához és a folyamat konfigurálásához:

    azd pipeline config

    Ez a parancs opcionálisan létrehoz egy GitHub-adattárat, és leküldi a kódot az új adattárba.

    Feljegyzés

    Alapértelmezés szerint azd pipeline config az OpenID Csatlakozás (OIDC) nevű összevont hitelesítő adatokat használja. Ha inkább nem az OIDC-t használná, futtassa a következőt: azd pipeline config --auth-type client-credentials.

    Az OIDC/összevont hitelesítő adatok nem támogatottak a Terraform esetében.

    További információ az OIDC támogatásáról a következőben azd: .

  2. Adja meg a kért GitHub-információkat.

  3. Amikor a rendszer kéri a helyi módosítások véglegesítését és leküldését egy új GitHub Actions-futtatás indításához, adja meg y.

  4. A terminálablakban tekintse meg a parancs eredményeit azd pipeline config . A azd pipeline config parancs megjeleníti a projekt GitHub-adattárának nevét.

  5. A böngészővel nyissa meg a projekt GitHub-adattárát.

  6. Válassza a Műveletek lehetőséget a munkafolyamat futtatásának megtekintéséhez.

    Képernyőkép a GitHub-munkafolyamat futásáról.

Kódmódosítás létrehozása és leküldése

  1. Nyissa meg header.tsxa projekt könyvtárában/src/web/src/layout.

  2. Keresse meg a sort <Text variant="xLarge">ToDo</Text>.

  3. Módosítsa a literált a következőre ToDomyTodo: .

  4. Mentse a fájlt.

  5. Véglegesítse a módosításokat. A módosítás véglegesítése elindítja a GitHub Action-folyamatot a frissítés üzembe helyezéséhez.

    Képernyőkép a fájl módosításának végrehajtásához és véglegesítéséhez szükséges lépésekről.

  6. A böngésző használatával nyissa meg a projekt GitHub-adattárát, hogy mindkettőt láthassa:

    • A véglegesítés
    • A Konfigurálandó GitHub Actions véglegesítése.

    Képernyőkép a GitHub véglegesített módosításáról.

  7. Válassza a Műveletek lehetőséget a munkafolyamatban tükröződő tesztfrissítés megtekintéséhez.

    Képernyőkép a tesztfrissítés után futó GitHub-munkafolyamatról.

  8. A frissítés vizsgálatához látogasson el a webes előtér URL-címére.

azd GitHub-műveletként

Hozzáadás azd GitHub-műveletként. Ez a művelet telepíti a műveletet azd. A használatához hozzáadhatja a következőket a következőhöz .github\workflows\azure-dev.yml:

on: [push]

jobs:
   build:
      runs-on: ubuntu-latest
      steps:
         - name: Install azd
         uses: Azure/setup-azd@v0.1.0

Az erőforrások eltávolítása

Ha már nincs szüksége a cikkben létrehozott Azure-erőforrásokra, futtassa a következő parancsot:

azd down

Speciális funkciók

A parancsot kiterjesztheti adott azd pipeline config sablonforgatókönyvekre vagy követelményekre a következő szakaszokban leírtak szerint.

További titkos kódok vagy változók

Alapértelmezés szerint beállítja a azd folyamat változóit és titkos kulcsait. A parancs például azd pipeline config a végrehajtáskor létrehozza a subscription id, environment name és a region folyamat változóit. A folyamatdefiníció ezután a következő változókra hivatkozik:

env:
   AZURE_CLIENT_ID: ${{ vars.AZURE_CLIENT_ID }}
   AZURE_TENANT_ID: ${{ vars.AZURE_TENANT_ID }}
   AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
   AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
   AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}

A folyamat futtatásakor azd lekéri a környezet értékeit, amelyek a változókra és titkos kódokra vannak leképezve. A sablontól függően lehetnek olyan beállítások, amelyeket a környezeti változók használatával szabályozhat. Egy elnevezett KEY_VAULT_NAME környezeti változó például megadható egy Key Vault-erőforrás nevének meghatározásához a sabloninfrastruktúrában. Ilyen esetekben a változók és titkos kódok listáját a sablon definiálhatja a azure.yaml. Vegyük például a következő azure.yaml konfigurációt:

pipeline:
  variables:
    - KEY_VAULT_NAME
    - STORAGE_NAME
  secrets:
    - CONNECTION_STRING

Ezzel a konfigurációval ellenőrzi, azd hogy a változók vagy titkos kódok nem üres értékkel rendelkeznek-e a környezetben. azd ezután létrehoz egy változót vagy egy titkos kulcsot a folyamathoz a konfigurációban lévő kulcs nevével a változó vagy titkos kód neveként, valamint a környezetből származó nem sztring értékű értéket az értékhez.

A azure-dev.yaml folyamatdefiníció ezután hivatkozhat a változókra vagy titkos kódokra:

- name: Provision Infrastructure
   run: azd provision --no-prompt
   env:
      KEY_VAULT_NAME: ${{ variables.KEY_VAULT_NAME }}
      STORAGE_NAME: ${{ variables.STORAGE_NAME }}
      CONNECTION_STRING: ${{ secrets.CONNECTION_STRING }}

Feljegyzés

A folyamatértékek alaphelyzetbe állításához a titkos kulcsok vagy változók listájának frissítése után kell futnia azd pipeline config az azd-ben azure.yaml .

Infrastruktúraparaméterek

Tekintse meg a következő bicep-példát:

@secure()
param BlobStorageConnection string

A paraméter BlobStorageConnection nem rendelkezik alapértelmezett értékkészlettel, ezért azd kéri a felhasználót, hogy adjon meg egy értéket. A CI/CD alatt azonban nincs interaktív üzenet. azd a futtatáskor azd pipeline configle kell kérnie a paraméter értékét, mentenie kell az értéket a folyamatban, majd újra le kell kérnie az értéket a folyamat futtatásakor.

azd A folyamat titkos kódjának használatával AZD_INITIAL_ENVIRONMENT_CONFIG automatikusan mentheti és beállíthatja a folyamat összes szükséges paraméterének értékét. Erre a titkos kódra csak a folyamatban kell hivatkoznia:

- name: Provision Infrastructure
   run: azd provision --no-prompt
   env:
      AZD_INITIAL_ENVIRONMENT_CONFIG: ${{ secrets.AZD_INITIAL_ENVIRONMENT_CONFIG }}

Amikor a folyamat fut, azd a titkos kódból veszi a paraméterek értékeit, így nincs szükség interaktív kérdésre.

Feljegyzés

Ha új paramétert ad hozzá, újra kell futtatnia azd pipeline config .

Folyamatdefiníció létrehozása

Ha a azd sablon még nem rendelkezik CI/CD-folyamatdefiníciós fájllal, létrehozhat egyet. A CI/CD-folyamatok definíciója általában 4 fő szakaszból áll:

  • Ravaszt
  • engedélyek
  • operációs rendszer vagy készlet
  • futtatandó lépések

Az alábbi példák bemutatják, hogyan hozhat létre definíciós fájlt és kapcsolódó konfigurációkat a GitHub Actionshez és az Azure Pipelineshoz.

A GitHub Actionsben való futtatáshoz azd a következő konfigurációk szükségesek:

  • Hatókörök megadása id-token: write és contents: read elérése.
  • Telepítse az azd műveletet, kivéve, ha docker-rendszerképet használ, ahol azd már telepítve van.

A következő sablont használhatja kiindulási pontként a saját folyamatdefiníciójához:

on:
  workflow_dispatch:
  push:
    # Run when commits are pushed to mainline branch (main or master)
    # Set this to the mainline branch you are using
    branches:
      - main
      - master

# Set this permission if you are using a Federated Credential.
permissions:
  id-token: write
  contents: read

jobs:
  build:
    runs-on: ubuntu-latest
    # azd build-in variables.
    # This variables are always set by `azd pipeline config`
    # You can set them as global env (apply to all steps) or you can add them to individual steps' environment
    env:
      AZURE_CLIENT_ID: ${{ vars.AZURE_CLIENT_ID }}
      AZURE_TENANT_ID: ${{ vars.AZURE_TENANT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
      AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
      AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
      ## Define the additional variables or secrets that are required globally (provision and deploy)
      # ADDITIONAL_VARIABLE_PLACEHOLDER: ${{ variables.ADDITIONAL_VARIABLE_PLACEHOLDER }}
      # ADDITIONAL_SECRET_PLACEHOLDER: ${{ secrets.ADDITIONAL_SECRET_PLACEHOLDER }}      
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      # using the install-azd action
      - name: Install azd
        uses: Azure/setup-azd@v1.0.0

      # # If you want to use azd-daily build, or install it from a PR, you can remove previous step and
      # # use the next one:
      # - name: Install azd - daily or from PR
      #  # Update this scrip based on the OS - pool of your pipeline. This example is for a linux pipeline installing daily build
      #  run: curl -fsSL https://aka.ms/install-azd.sh | bash -s -- --version daily
      #  shell: pwsh

      # azd set up Federated Credential by default. You can remove this step if you are using Client Credentials
      - name: Log in with Azure (Federated Credentials)
        if: ${{ env.AZURE_CLIENT_ID != '' }}
        run: |
          azd auth login `
            --client-id "$Env:AZURE_CLIENT_ID" `
            --federated-credential-provider "github" `
            --tenant-id "$Env:AZURE_TENANT_ID"
        shell: pwsh

      ## If you set up your pipeline with Client Credentials, remove previous step and uncomment this one
      # - name: Log in with Azure (Client Credentials)
      #   if: ${{ env.AZURE_CREDENTIALS != '' }}
      #   run: |
      #     $info = $Env:AZURE_CREDENTIALS | ConvertFrom-Json -AsHashtable;
      #     Write-Host "::add-mask::$($info.clientSecret)"

      #     azd auth login `
      #       --client-id "$($info.clientId)" `
      #       --client-secret "$($info.clientSecret)" `
      #       --tenant-id "$($info.tenantId)"
      #   shell: pwsh
      #   env:
      #     AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS }}

      - name: Provision Infrastructure
        run: azd provision --no-prompt
        env:
         #  # uncomment this if you are using infrastructure parameters
         #  AZD_INITIAL_ENVIRONMENT_CONFIG: ${{ secrets.AZD_INITIAL_ENVIRONMENT_CONFIG }}
         ## Define the additional variables or secrets that are required only for provision 
         #  ADDITIONAL_VARIABLE_PLACEHOLDER: ${{ variables.ADDITIONAL_VARIABLE_PLACEHOLDER }}
         #  ADDITIONAL_SECRET_PLACEHOLDER: ${{ secrets.ADDITIONAL_SECRET_PLACEHOLDER }}

      - name: Deploy Application
        run: azd deploy --no-prompt
        env:
         ## Define the additional variables or secrets that are required only for deploy
         #  ADDITIONAL_VARIABLE_PLACEHOLDER: ${{ variables.ADDITIONAL_VARIABLE_PLACEHOLDER }}
         #  ADDITIONAL_SECRET_PLACEHOLDER: ${{ secrets.ADDITIONAL_SECRET_PLACEHOLDER }}