Sdílet prostřednictvím

Přidání a konfigurace definice prostředí

  • Článek

Tento článek vysvětluje, jak přidat, aktualizovat nebo odstranit definici prostředí v katalogu prostředí nasazení Azure. Vysvětluje také, jak odkazovat na image kontejneru pro nasazení vašeho prostředí.

V prostředích nasazení Azure pomocí katalogu poskytnete vývojovým týmům kurátorovanou sadu předdefinovaných šablon infrastruktury jako kódu (IaC), které se nazývají definice prostředí.

Definice prostředí se skládá z alespoň dvou souborů:

  • Šablona z architektury IaC. Příklad:
    • Šablona Azure Resource Manageru (ARM) může použít soubor s názvem azuredeploy.json.
    • Šablona Bicep může používat soubor s názvem main.bicep.
    • Šablona Terraformu může používat soubor s názvem azuredeploy.tf.
  • Konfigurační soubor, který poskytuje metadata o šabloně. Tento soubor by měl mít název environment.yaml.

Vývojové týmy používají definice prostředí, které poskytujete v katalogu k nasazení prostředí v Azure.

Microsoft nabízí ukázkový katalog , který můžete použít jako úložiště. Můžete také použít vlastní privátní úložiště nebo můžete vytvořit fork a přizpůsobit definice prostředí v ukázkovém katalogu.

Po přidání katalogu do vývojového centra služba zkontroluje zadanou cestu ke složce a identifikuje složky, které obsahují šablonu a přidružený soubor prostředí. Zadaná cesta ke složce by měla být složka obsahující podsložky, které obsahují definiční soubory prostředí.

Přidání definice prostředí

Pokud chcete přidat definici prostředí do katalogu v prostředích nasazení Azure (ADE), nejprve přidáte soubory do úložiště. Pak synchronizujete katalog dev center s aktualizovaným úložištěm.

Přidání definice prostředí:

  1. V úložišti GitHub nebo Azure DevOps vytvořte podsložku v cestě ke složce úložiště.

  2. Přidejte do nové podsložky úložiště dva soubory:

    • Soubor šablony IaC.

    • Prostředí jako soubor YAML.

      Soubor environment.yaml obsahuje metadata související se šablonou IaC.

      Následující skript je příkladem obsahu souboru environment.yaml pro šablonu 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

      Následující tabulka vám umožní porozumět polím v souboru environment.yaml :

      Pole Popis
      name Název definice prostředí.
      version Verze definice prostředí. Toto pole je nepovinné.
      Souhrn Stručný popis definice prostředí.
      description Podrobný popis definice prostředí.
      Běžec Architektura IaC, kterou šablona používá. Hodnota může být ARM nebo Bicep. Můžete také zadat cestu k šabloně uložené v registru kontejneru.
      templatePath Cesta k souboru šablony IaC.

      Další informace o možnostech a datových typech, které můžete použít v souboru environment.yaml, najdete v tématu Parametry a datové typy v souboru environment.yaml.

  3. Ve vývojovém centru přejděte do katalogu, vyberte úložiště a pak vyberte Synchronizovat.

    Snímek obrazovky, který ukazuje, jak synchronizovat katalog

Služba prohledá úložiště a vyhledá nové definice prostředí. Po synchronizaci úložiště jsou nové definice prostředí dostupné pro všechny projekty v centru pro vývojáře.

Nasazení prostředí pomocí imagí kontejnerů

ADE používá image kontejnerů k definování způsobu nasazení šablon pro prostředí nasazení. ADE nativně podporuje ARM a Bicep, takže můžete nakonfigurovat definici prostředí, která nasadí prostředky Azure pro prostředí nasazení přidáním souborů šablon (azuredeploy.json a environment.yaml) do katalogu. ADE pak k vytvoření prostředí nasazení použije standardní image kontejneru ARM nebo Bicep.

Pro pokročilejší nasazení prostředí můžete vytvořit vlastní image kontejneru. Můžete například spouštět skripty před nebo po nasazení. ADE podporuje vlastní image kontejnerů pro nasazení prostředí, což může pomoct s nasazením architektur IaC, jako jsou Pulumi a Terraform.

Tým ADE poskytuje ukázkové image kontejnerů ARM a Bicep přístupné prostřednictvím Registr artefaktů Microsoft (označované také jako Microsoft Container Registry), které vám pomůžou začít.

Další informace o vytvoření vlastní image kontejneru najdete tady:

Zadání ukázkové image kontejneru ARM nebo Bicep

V souboru environment.yaml vlastnost runner určuje umístění image, kterou chcete použít. Pokud chcete použít ukázkový obrázek publikovaný na Registr artefaktů Microsoft, použijte příslušný spouštěč identifikátorů, jak je uvedeno v následující tabulce.

Architektura IaC Hodnota Runneru
ARM ARM
Bicep Bicep
Terraform Žádný ukázkový obrázek. Místo toho použijte vlastní image kontejneru.

Následující příklad ukazuje spouštěč, který odkazuje na ukázkovou image kontejneru 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

Zadání vlastní image kontejneru

Pokud chcete použít vlastní image kontejneru uloženou v úložišti, použijte v souboru environment.yaml následující formát spouštěče:

runner: "{YOUR_REGISTRY}.azurecr.io/{YOUR_REPOSITORY}:{YOUR_TAG}”`

Upravte hodnotu spouštěče tak, aby odkazovat na úložiště a vlastní image, jak je znázorněno v následujícím příkladu:

    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
Vlastnost Popis
YOUR_REGISTRY Registr, který ukládá vlastní image.
YOUR_REPOSITORY Vaše úložiště v daném registru.
YOUR_TAG Značka, například číslo verze.

Zadání parametrů pro definici prostředí

Můžete zadat parametry pro definice prostředí, aby vývojáři mohli přizpůsobit svá prostředí.

Parametry jsou definovány v souboru environment.yaml .

Následující skript je příkladem souboru environment.yaml pro šablonu ARM, která obsahuje dva parametry; location a 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

Další informace o parametrech a jejich datových typech, které můžete použít v souboru environment.yaml, najdete v tématu Parametry a datové typy v souboru environment.yaml.

Vývojáři můžou prostřednictvím portálu pro vývojáře zadat hodnoty pro konkrétní parametry pro svá prostředí.

Snímek obrazovky portálu pro vývojáře portálu pro vývojáře zobrazující podokno parametrů

Vývojáři také můžou prostřednictvím rozhraní příkazového řádku zadat hodnoty pro konkrétní parametry pro svá prostředí.

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]

Další informace o az devcenter dev environment create příkazu najdete v rozšíření Azure CLI devcenter.

Aktualizace definice prostředí

Pokud chcete upravit konfiguraci prostředků Azure v existující definici prostředí v prostředích nasazení Azure, aktualizujte přidružený soubor šablony v úložišti. Změna se okamžitě projeví při vytváření nového prostředí pomocí konkrétní definice prostředí. Aktualizace se také použije při opětovném nasazení prostředí přidruženého k této definici prostředí.

Chcete-li aktualizovat všechna metadata související se šablonou, upravte soubor environment.yaml a pak aktualizujte katalog.

Odstranění definice prostředí

Pokud chcete odstranit existující definici prostředí, odstraňte v úložišti podsložku, která obsahuje soubor šablony a přidružený soubor YAML prostředí. Pak katalog aktualizujte.

Po odstranění definice prostředí už vývojové týmy nemůžou k nasazení nového prostředí použít konkrétní definici prostředí. Aktualizujte odkaz na definici prostředí pro všechna existující prostředí, která používají definici odstraněného prostředí. Pokud se odkaz neaktualizuje a prostředí se znovu nasadí, nasazení se nezdaří.

Související obsah