Bagikan melalui

Menambahkan dan mengonfigurasi definisi lingkungan

  • Artikel

Artikel ini menjelaskan cara menambahkan, memperbarui, atau menghapus definisi lingkungan dalam katalog Lingkungan Penyebaran Azure. Ini juga menjelaskan cara mereferensikan gambar kontainer untuk menyebarkan lingkungan Anda.

Di Lingkungan Penyebaran Azure, Anda menggunakan katalog untuk memberi tim pengembangan Anda serangkaian templat infrastruktur sebagai kode (IaC) yang telah ditentukan sebelumnya yang disebut definisi lingkungan.

Definisi lingkungan terdiri dari setidaknya dua file:

  • Templat dari kerangka kerja IaC. Misalnya:
    • Templat Azure Resource Manager (ARM) mungkin menggunakan file yang disebut azuredeploy.json.
    • Templat Bicep mungkin menggunakan file yang disebut main.bicep.
    • Templat Terraform mungkin menggunakan file yang disebut azuredeploy.tf.
  • File konfigurasi yang menyediakan metadata tentang templat. File ini harus diberi nama environment.yaml.

Tim pengembangan Anda menggunakan definisi lingkungan yang Anda berikan di katalog untuk menyebarkan lingkungan di Azure.

Microsoft menawarkan katalog sampel yang dapat Anda gunakan sebagai repositori Anda. Anda juga dapat menggunakan repositori privat Anda sendiri, atau Anda dapat membuat fork dan menyesuaikan definisi lingkungan dalam katalog sampel.

Setelah Anda menambahkan katalog ke pusat dev Anda, layanan memindai jalur folder yang ditentukan untuk mengidentifikasi folder yang berisi templat dan file lingkungan terkait. Jalur folder yang ditentukan harus berupa folder yang berisi subfolder yang menyimpan file definisi lingkungan.

Menambahkan definisi lingkungan

Untuk menambahkan definisi lingkungan ke katalog di Azure Deployment Environments (ADE), Anda terlebih dahulu menambahkan file ke repositori. Anda kemudian menyinkronkan katalog pusat pengembangan dengan repositori yang diperbarui.

Untuk menambahkan definisi lingkungan:

  1. Di repositori GitHub atau Azure DevOps Anda, buat subfolder di jalur folder repositori.

  2. Tambahkan dua file ke subfolder repositori baru:

    • File templat IaC.

    • Lingkungan sebagai file YAML.

      File environment.yaml berisi metadata yang terkait dengan templat IaC.

      Skrip berikut adalah contoh konten file environment.yaml untuk templat 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

      Gunakan tabel berikut untuk memahami bidang dalam file environment.yaml :

      Bidang KETERANGAN
      nama Nama definisi lingkungan.
      versi Versi definisi lingkungan. Bidang ini bersifat opsional.
      ringkasan Deskripsi singkat tentang definisi lingkungan.
      description Deskripsi terperinci tentang definisi lingkungan.
      Pelari Kerangka kerja IaC yang digunakan templat. Nilai dapat berupa ARM atau Bicep. Anda juga dapat menentukan jalur ke templat yang disimpan dalam registri kontainer.
      templatePath Jalur ke file templat IaC.

      Untuk mempelajari selengkapnya tentang opsi dan jenis data yang dapat Anda gunakan di environment.yaml, lihat Parameter dan jenis data di environment.yaml.

  3. Di pusat pengembangan Anda, buka Katalog, pilih repositori, lalu pilih Sinkronkan.

    Cuplikan layar yang memperlihatkan cara menyinkronkan katalog.

Layanan memindai repositori untuk menemukan definisi lingkungan baru. Setelah Anda menyinkronkan repositori, definisi lingkungan baru tersedia untuk semua proyek di pusat pengembangan.

Menggunakan gambar kontainer untuk menyebarkan lingkungan

ADE menggunakan gambar kontainer untuk menentukan bagaimana templat untuk lingkungan penyebaran disebarkan. ADE mendukung ARM dan Bicep secara asli, sehingga Anda dapat mengonfigurasi definisi lingkungan yang menyebarkan sumber daya Azure untuk lingkungan penyebaran dengan menambahkan file templat (azuredeploy.json dan environment.yaml) ke katalog Anda. ADE kemudian menggunakan gambar kontainer ARM atau Bicep standar untuk membuat lingkungan penyebaran.

Anda dapat membuat gambar kontainer kustom untuk penyebaran lingkungan yang lebih canggih. Misalnya, Anda dapat menjalankan skrip sebelum atau sesudah penyebaran. ADE mendukung gambar kontainer kustom untuk penyebaran lingkungan, yang dapat membantu menyebarkan kerangka kerja IaC seperti Pulumi dan Terraform.

Tim ADE menyediakan sampel gambar kontainer ARM dan Bicep yang dapat diakses melalui Registri Artefak Microsoft (juga dikenal sebagai Microsoft Container Registry) untuk membantu Anda memulai.

Untuk informasi selengkapnya tentang membangun gambar kontainer kustom, lihat:

Tentukan gambar kontainer sampel ARM atau Bicep

Dalam file environment.yaml, properti runner menentukan lokasi gambar yang ingin Anda gunakan. Untuk menggunakan gambar sampel yang diterbitkan di Registri Artefak Microsoft, gunakan masing-masing pengidentifikasi runner, seperti yang tercantum dalam tabel berikut.

Kerangka kerja IaC Nilai runner
ARM ARM
Bicep Bicep
Terraform Tidak ada gambar sampel. Gunakan gambar kontainer kustom sebagai gantinya.

Contoh berikut menunjukkan runner yang mereferensikan sampel gambar kontainer 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

Tentukan gambar kontainer kustom

Untuk menggunakan gambar kontainer kustom yang disimpan dalam repositori, gunakan format runner berikut dalam file environment.yaml:

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

Edit nilai runner untuk mereferensikan repositori dan gambar kustom Anda, seperti yang ditunjukkan dalam contoh berikut:

    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
Properti Deskripsi
YOUR_REGISTRY Registri yang menyimpan gambar kustom.
YOUR_REPOSITORY Repositori Anda pada registri tersebut.
YOUR_TAG Tag seperti nomor versi.

Menentukan parameter untuk definisi lingkungan

Anda dapat menentukan parameter untuk definisi lingkungan Anda untuk memungkinkan pengembang menyesuaikan lingkungan mereka.

Parameter didefinisikan dalam file environment.yaml .

Skrip berikut adalah contoh file environment.yaml untuk templat ARM yang mencakup dua parameter; location dan 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

Untuk mempelajari selengkapnya tentang parameter dan jenis datanya yang dapat Anda gunakan di environment.yaml, lihat Parameter dan jenis data di environment.yaml.

Pengembang dapat menyediakan nilai untuk parameter tertentu untuk lingkungan mereka melalui portal pengembang.

Cuplikan layar portal pengembang portal pengembang memperlihatkan panel parameter.

Pengembang juga dapat menyediakan nilai untuk parameter tertentu untuk lingkungan mereka melalui 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]

Untuk mempelajari selengkapnya tentang perintah, az devcenter dev environment create lihat ekstensi devcenter Azure CLI.

Memperbarui definisi lingkungan

Untuk mengubah konfigurasi sumber daya Azure dalam definisi lingkungan yang ada di Lingkungan Penyebaran Azure, perbarui file templat terkait di repositori. Perubahan segera tercermin saat Anda membuat lingkungan baru dengan menggunakan definisi lingkungan tertentu. Pembaruan juga diterapkan saat Anda menyebarkan ulang lingkungan yang terkait dengan definisi lingkungan tersebut.

Untuk memperbarui metadata apa pun yang terkait dengan templat, ubah environment.yaml, lalu perbarui katalog.

Menghapus definisi lingkungan

Untuk menghapus definisi lingkungan yang ada, di repositori, hapus subfolder yang berisi file templat dan file YAML lingkungan terkait. Kemudian, perbarui katalog.

Setelah Anda menghapus definisi lingkungan, tim pengembangan tidak dapat lagi menggunakan definisi lingkungan tertentu untuk menyebarkan lingkungan baru. Perbarui referensi definisi lingkungan untuk lingkungan yang ada yang menggunakan definisi lingkungan yang dihapus. Jika referensi tidak diperbarui dan lingkungan disebarkan ulang, penyebaran gagal.

Konten terkait