إضافة تعريف بيئة وتكوينه

تشرح هذه المقالة كيفية إضافة تعريف بيئة أو تحديثه أو حذفه في كتالوج Azure Deployment Environments. كما يشرح كيفية الرجوع إلى صورة حاوية لنشر بيئتك.

في Azure Deployment Environments، يمكنك استخدام كتالوج لتزويد فرق التطوير بمجموعة منسقة من قوالب البنية الأساسية المعرفة مسبقا كقوالب تعليمات برمجية (IaC) تسمى تعريفات البيئة.

يتكون تعريف البيئة من ملفين على الأقل:

  • قالب من إطار عمل IaC. على سبيل المثال:
    • قد يستخدم قالب Azure Resource Manager (ARM) ملفا يسمى azuredeploy.json.
    • قد يستخدم قالب Bicep ملفا يسمى main.bicep.
    • قد يستخدم قالب Terraform ملفا يسمى azuredeploy.tf.
  • ملف تكوين يوفر بيانات تعريف حول القالب. يجب تسمية هذا الملف environment.yaml.

تستخدم فرق التطوير تعريفات البيئة التي تقدمها في الكتالوج لنشر البيئات في Azure.

تقدم Microsoft نموذج كتالوج يمكنك استخدامه كمستودع. يمكنك أيضا استخدام المستودع الخاص بك، أو يمكنك نسخ تعريفات البيئة وتخصيصها في الكتالوج النموذجي.

بعد إضافة كتالوج إلى مركز التطوير الخاص بك، تقوم الخدمة بمسح مسار المجلد المحدد لتحديد المجلدات التي تحتوي على قالب وملف بيئة مقترن. يجب أن يكون مسار المجلد المحدد مجلدا يحتوي على مجلدات فرعية تحتوي على ملفات تعريف البيئة.

إضافة تعريف بيئة

لإضافة تعريف بيئة إلى كتالوج في بيئات نشر Azure (ADE)، يمكنك أولا إضافة الملفات إلى المستودع. ثم تقوم بمزامنة كتالوج مركز التطوير مع المستودع المحدث.

لإضافة تعريف بيئة:

  1. في مستودع GitHub أو Azure DevOps، أنشئ مجلدا فرعيا في مسار مجلد المستودع.

  2. أضف ملفين إلى المجلد الفرعي للمستودع الجديد:

    • ملف قالب IaC.

    • بيئة كملف YAML.

      يحتوي ملف environment.yaml على بيانات تعريف متعلقة بقالب IaC.

      البرنامج النصي التالي هو مثال على محتويات ملف environment.yaml لقالب 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
      

      استخدم الجدول التالي لفهم الحقول في ملف environment.yaml :

      الحقل ‏‏الوصف
      الاسم اسم تعريف البيئة.
      إصدار إصدار تعريف البيئة. هذا الحقل اختياري.
      الملخص. وصف موجز لتعريف البيئة.
      الوصف وصف مفصل لتعريف البيئة.
      عداء إطار عمل IaC الذي يستخدمه القالب. يمكن أن تكون القيمة ARM أو Bicep. يمكنك أيضا تحديد مسار إلى قالب مخزن في سجل حاوية.
      مسار القالب المسار إلى ملف قالب IaC.

      لمعرفة المزيد حول الخيارات وأنواع البيانات التي يمكنك استخدامها في environment.yaml، راجع المعلمات وأنواع البيانات في environment.yaml.

  3. في مركز التطوير، انتقل إلى الكتالوجات، وحدد المستودع، ثم حدد مزامنة.

    لقطة شاشة توضح كيفية مزامنة الكتالوج.

تقوم الخدمة بفحص المستودع للعثور على تعريفات بيئة جديدة. بعد مزامنة المستودع، تتوفر تعريفات بيئة جديدة لجميع المشاريع في مركز التطوير.

استخدام صور الحاوية لنشر البيئات

يستخدم ADE صور الحاوية لتحديد كيفية نشر قوالب لبيئات النشر. يدعم ADE ARM وBicep في الأصل، بحيث يمكنك تكوين تعريف بيئة ينشر موارد Azure لبيئة نشر عن طريق إضافة ملفات القالب (azuredeploy.json و environment.yaml) إلى الكتالوج الخاص بك. ثم يستخدم ADE صورة حاوية ARM أو Bicep قياسية لإنشاء بيئة التوزيع.

يمكنك إنشاء صور حاوية مخصصة لنشر بيئة أكثر تقدما. على سبيل المثال، يمكنك تشغيل البرامج النصية قبل النشر أو بعده. يدعم ADE صور الحاوية المخصصة لنشر البيئة، والتي يمكن أن تساعد في نشر أطر عمل IaC مثل Pulumi وTerraform.

يوفر فريق ADE نموذج صور حاوية ARM وBicep التي يمكن الوصول إليها من خلال Microsoft Artifact Registry (المعروف أيضا باسم Microsoft Container Registry) لمساعدتك على البدء.

لمزيد من المعلومات حول إنشاء صورة حاوية مخصصة، راجع:

حدد صورة حاوية نموذج ARM أو Bicep

في ملف environment.yaml، تحدد خاصية المشغل موقع الصورة التي تريد استخدامها. لاستخدام نموذج الصورة المنشورة على Microsoft Artifact Registry، استخدم مشغل المعرفات المعنية، كما هو موضح في الجدول التالي.

إطار عمل IaC قيمة المشغل
ARM ARM
Bicep Bicep
Terraform لا توجد صورة عينة. استخدم صورة حاوية مخصصة بدلا من ذلك.

يوضح المثال التالي مشغلا يشير إلى نموذج صورة حاوية 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

تحديد صورة حاوية مخصصة

لاستخدام صورة حاوية مخصصة مخزنة في مستودع، استخدم تنسيق المشغل التالي في ملف environment.yaml:

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

قم بتحرير قيمة المشغل للإشارة إلى المستودع والصورة المخصصة، كما هو موضح في المثال التالي:

    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
الخاصية ‏‏الوصف
YOUR_REGISTRY السجل الذي يخزن الصورة المخصصة.
YOUR_REPOSITORY مستودعك على هذا السجل.
YOUR_TAG علامة مثل رقم الإصدار.

تحديد معلمات لتعريف بيئة

يمكنك تحديد معلمات لتعريفات البيئة الخاصة بك للسماح للمطورين بتخصيص بيئاتهم.

يتم تعريف المعلمات في ملف environment.yaml .

البرنامج النصي التالي هو مثال على ملف environment.yaml لقالب ARM يتضمن معلمتين؛ location و 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

لمعرفة المزيد حول المعلمات وأنواع البيانات الخاصة بها التي يمكنك استخدامها في environment.yaml، راجع المعلمات وأنواع البيانات في environment.yaml.

يمكن للمطورين توفير قيم لمعلمات محددة لبيئاتهم من خلال مدخل المطور.

لقطة شاشة لمدخل المطور لمدخل المطور تعرض جزء المعلمات.

يمكن للمطورين أيضا توفير قيم لمعلمات محددة لبيئاتهم من خلال 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]

لمعرفة المزيد حول az devcenter dev environment create الأمر، راجع ملحق مركز تطوير Azure CLI.

تحديث تعريف بيئة

لتعديل تكوين موارد Azure في تعريف بيئة موجود في Azure Deployment Environments، قم بتحديث ملف القالب المقترن في المستودع. ينعكس التغيير على الفور عند إنشاء بيئة جديدة باستخدام تعريف البيئة المحدد. يتم تطبيق التحديث أيضا عند إعادة نشر بيئة مقترنة بتعريف البيئة هذا.

لتحديث أي بيانات تعريف متعلقة بالقالب، قم بتعديل environment.yaml، ثم قم بتحديث الكتالوج.

حذف تعريف بيئة

لحذف تعريف بيئة موجود، في المستودع، احذف المجلد الفرعي الذي يحتوي على ملف القالب وملف YAML للبيئة المقترنة. ثم قم بتحديث الكتالوج.

بعد حذف تعريف بيئة، لم يعد باستطاعة فرق التطوير استخدام تعريف البيئة المحدد لنشر بيئة جديدة. تحديث مرجع تعريف البيئة لأي بيئات موجودة تستخدم تعريف البيئة المحذوفة. إذا لم يتم تحديث المرجع وإعادة نشر البيئة، يفشل النشر.