Dodawanie i konfigurowanie definicji środowiska

W tym artykule wyjaśniono, jak dodawać, aktualizować lub usuwać definicję środowiska w katalogu środowisk wdrażania platformy Azure. Wyjaśniono również, jak odwoływać się do obrazu kontenera w celu wdrożenia środowiska.

W środowiskach wdrażania używasz wykazu , aby udostępnić zespołom deweloperów wyselekcjonowany zestaw wstępnie zdefiniowanych szablonów infrastruktury jako kodu (IaC)nazywanych definicjami środowiska.

Definicja środowiska składa się z co najmniej dwóch plików:

  • Szablon ze struktury IaC. Przykład:
    • Szablon usługi Azure Resource Manager (ARM) może używać pliku o nazwie azuredeploy.json.
    • Plik Bicep może używać pliku o nazwie main.bicep.
    • Szablon narzędzia Terraform może używać pliku o nazwie azuredeploy.tf.
  • Plik konfiguracji zawierający metadane dotyczące szablonu. Ten plik powinien mieć nazwę environment.yaml.

Zespoły programistyczne używają definicji środowiska, które podajesz w wykazie, aby wdrażać środowiska na platformie Azure.

Microsoft udostępnia szablony sample których można użyć do rozpoczęcia pracy ze środowiskami wdrażania. Możesz również użyć własnego repozytorium prywatnego lub sklonować i dostosować definicje środowiska w przykładowym katalogu.

Po dodaniu wykazu do centrum deweloperów usługa skanuje określoną ścieżkę folderu, aby zidentyfikować foldery zawierające szablon i skojarzony plik środowiska. Określona ścieżka folderu powinna być folderem zawierającym podfoldery zawierające pliki definicji środowiska.

Dodawanie definicji środowiska

Aby dodać definicję środowiska do katalogu w środowiskach wdrażania, należy najpierw dodać pliki do repozytorium. Następnie zsynchronizuj katalog centrum deweloperów ze zaktualizowanym repozytorium.

Aby dodać definicję środowiska:

  1. W repozytorium GitHub lub Azure DevOps utwórz podfolder w ścieżce folderu repozytorium.

  2. Dodaj dwa pliki do nowego podfolderu repozytorium:

    • Plik szablonu IaC.

    • Środowisko jako plik YAML.

      Plik environment.yaml zawiera metadane związane z szablonem IaC.

      Poniższy fragment przedstawia przykład zawartości pliku environment.yaml dla szablonu ARM:

          name: WebApp
    version: 1.0.0
    summary: Azure Web App Environment
    description: Deploys a web app in Azure without a datastore
    runner: ARM
    templatePath: azuredeploy.json

      W tej tabeli opisano pola w pliku environment.yaml :

      (No changes needed) Opis
      name Nazwa definicji środowiska.
      version Wersja definicji środowiska. Przechowywanie wersji nie jest obsługiwane w przypadku definicji środowiska, więc ta wartość musi zawsze mieć wartość 1.0.0. To pole jest opcjonalne.
      summary Krótki opis definicji środowiska.
      description Szczegółowy opis definicji środowiska.
      runner Struktura IaC używana przez szablon. Wartość może mieć wartość ARM lub Bicep. Można również określić ścieżkę do obrazu kontenera przechowywanego w rejestrze kontenerów.
      templatePath Ścieżka do pliku szablonu IaC.

      Aby dowiedzieć się więcej o opcjach i typach danych, których można użyć, zobacz What is environment.yaml? (Co to jest plik environment.yaml?

  3. Zaloguj się do portalu Azure i wybierz centrum deweloperskie. W menu bocznym, w sekcji Konfiguracja środowiska, wybierz opcję Katalogi. Wybierz repozytorium, a następnie wybierz pozycję Synchronizuj.

    Zrzut ekranu przedstawiający sposób synchronizowania wykazu.

Usługa skanuje repozytorium, aby znaleźć nowe definicje środowiska. Po zsynchronizowaniu repozytorium nowe definicje środowiska są dostępne dla wszystkich projektów w centrum deweloperów.

Wdrażanie środowisk przy użyciu obrazów kontenerów

Środowiska wdrażania używają obrazów kontenerów do definiowania sposobu wdrażania szablonów dla środowisk wdrażania. Środowiska wdrożeniowe natywnie obsługują szablony ARM i Bicep, dzięki czemu można skonfigurować definicję środowiska, która wdraża zasoby platformy Azure w środowisku wdrożeniowym przez dodanie plików szablonów (azuredeploy.json i environment.yaml) do katalogu. Środowiska wdrażania używają następnie standardowego obrazu kontenera ARM lub Bicep do utworzenia środowiska wdrażania.

Można tworzyć niestandardowe obrazy kontenerów na potrzeby bardziej zaawansowanych wdrożeń środowiska. Można na przykład uruchamiać skrypty przed wdrożeniem lub po nim. Środowiska wdrożeniowe obsługują niestandardowe obrazy kontenerów dla wdrożeń, które mogą pomóc we wdrażaniu struktur IaC, takich jak Pulumi i Terraform.

Aby rozpocząć pracę, możesz uzyskać przykładowe obrazy kontenerów arm i Bicep za pośrednictwem rejestru Artefaktów Microsoft (nazywanego również rejestrem kontenerów firmy Microsoft).

Aby uzyskać więcej informacji na temat tworzenia niestandardowego obrazu kontenera, zobacz Konfigurowanie obrazu kontenera do wykonywania wdrożeń.

Określ obraz kontenera ARM lub Bicep jako przykład

W pliku environment.yaml właściwość określa lokalizację obrazu, runner którego chcesz użyć. Aby użyć przykładowego obrazu opublikowanego w usłudze Microsoft Artifact Registry, użyj runner wartości wymienionych w poniższej tabeli.

Struktura IaC runner wartość
ARM ARM
Biceps Bicep
Terraformowanie Brak przykładowego obrazu. Zamiast tego użyj niestandardowego obrazu kontenera.

W poniższym przykładzie przedstawiono właściwość runner, która odwołuje się do przykładowego obrazu kontenera Bicep.

    name: WebApp
    version: 1.0.0
    summary: Azure Web App Environment
    description: Deploys a web app in Azure without a datastore
    runner: Bicep
    templatePath: azuredeploy.json

Określanie niestandardowego obrazu kontenera

Aby użyć niestandardowego obrazu kontenera przechowywanego w repozytorium, użyj następującego formatu runner w pliku environment.yaml:

runner: "<your-registry>.azurecr.io/<your-repository>:<your-tag>"

runner Edytuj wartość, aby odwoływać się do repozytorium i obrazu niestandardowego, jak pokazano w tym przykładzie:

    name: WebApp
    version: 1.0.0
    summary: Azure Web App Environment
    description: Deploys a web app in Azure without a datastore
    runner: "<your-registry>.azurecr.io/<your-repository>:<your-tag>"
    templatePath: azuredeploy.json
Majątek Opis
twój rejestr Rejestr, który przechowuje obraz niestandardowy.
twoje repozytorium Twoje repozytorium w tym rejestrze.
twój tag Tag, taki jak numer wersji.

Określanie parametrów definicji środowiska

Możesz określić parametry definicji środowiska, aby umożliwić deweloperom dostosowywanie ich środowisk.

Parametry są definiowane w pliku environment.yaml .

Poniższy skrypt to przykład pliku environment.yaml dla szablonu usługi ARM zawierającego dwa parametry: location i name.

name: WebApp
summary: Azure Web App Environment
description: Deploys a web app in Azure without a datastore
runner: ARM
templatePath: azuredeploy.json
parameters:
- id: "location"
  name: "location"
  description: "Location to deploy the environment resources"
  default: "[resourceGroup().location]"
  type: "string"
  required: false
- id: "name"
  name: "name"
  description: "Name of the web app "
  default: ""
  type: "string"
  required: false

Aby uzyskać więcej informacji, zobacz Parametry w pliku environment.yaml.

Deweloperzy mogą podać wartości dla określonych parametrów dla swoich środowisk za pośrednictwem portalu dla deweloperów.

Zrzut ekranu przedstawiający okienko parametrów w portalu deweloperów.

Deweloperzy mogą również podać wartości dla określonych parametrów dla swoich środowisk za pośrednictwem Azure CLI:

az devcenter dev environment create --environment-definition-name
                                    --catalog-name
                                    --dev-center
                                    --environment-name
                                    --environment-type
                                    --project
                                    [--description]
                                    [--no-wait]
                                    [--parameters]
                                    [--tags]
                                    [--user]
                                    [--user-id]

Aby dowiedzieć się więcej o poleceniu az devcenter dev environment create, zobacz rozszerzenie devcenter platformy Azure CLI.

Aktualizowanie definicji środowiska

Aby zmodyfikować konfigurację zasobów platformy Azure w istniejącej definicji środowiska w środowiskach wdrażania, zaktualizuj skojarzony plik szablonu w repozytorium. Zmiana zostanie natychmiast odzwierciedlona podczas tworzenia nowego środowiska przy użyciu określonej definicji środowiska. Aktualizacja jest również stosowana podczas ponownego wdrażania środowiska skojarzonego z tą definicją środowiska.

Aby zaktualizować wszystkie metadane powiązane z szablonem, zmodyfikuj plik environment.yaml, a następnie zaktualizuj katalog.

Usuwanie definicji środowiska

Aby usunąć definicję środowiska, usuń podfolder w repozytorium zawierającym plik szablonu i skojarzony plik environment.yaml . Następnie zaktualizuj katalog.

Po usunięciu definicji środowiska zespoły programistyczne nie mogą już używać go do wdrażania nowego środowiska. Zaktualizuj odwołanie do definicji środowiska dla wszystkich istniejących środowisk, które używają usuniętej definicji środowiska. Jeśli odniesienie nie jest zaktualizowane przed ponownym wdrożeniem środowiska, proces wdrażania zakończy się niepowodzeniem.

Treści powiązane

  • Last updated on