إضافة كتالوج وتكوينه من GitHub أو Azure Repos

تشرح هذه المقالة كيفية إضافة وتكوين كتالوج لمركز تطوير بيئات نشر Azure أو مشروعك.

تساعدك الكتالوجات على توفير مجموعة من قوالب البنية الأساسية كتعليمية (IaC) المنسقة، والمعروفة باسم تعريفات البيئة لفرق التطوير الخاصة بك لإنشاء بيئات. يمكنك إرفاق مستودع التحكم بالمصادر الخاص بك من GitHub أو Azure DevOps ككتالوج وتحديد المجلد مع تعريفات البيئة الخاصة بك. تقوم بيئات النشر بفحص المجلد بحثا عن تعريفات البيئة وتجعلها متاحة لفرق التطوير لإنشاء بيئات.

لمزيد من تأمين القوالب الخاصة بك، يتم تشفير الكتالوج؛ تدعم Azure Deployment Environments التشفير الثابت باستخدام مفاتيح التشفير المدارة بواسطة النظام الأساسي، والتي تديرها Microsoft for Azure Services.

  • لمعرفة كيفية استضافة مستودع في GitHub، راجع بدء استخدام GitHub.
  • لمعرفة كيفية استضافة مستودع Git في مشروع Azure Repos، راجع Azure Repos.

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

في هذه المقالة، ستتعرف على كيفية:

  1. تكوين كتالوجات على مستوى المشروع
  2. تكوين هوية مدارة
  3. إضافة كتالوج من Azure Repos أو GitHub
  4. تحديث كتالوج
  5. حذف كتالوج
  6. استكشاف أخطاء مزامنة الكتالوج وإصلاحها

تكوين كتالوجات على مستوى المشروع

يمكن إرفاق الكتالوجات على مستوى المشروع مهندسي النظام الأساسي من توفير تعريفات البيئة المنسقة الخاصة بفرق التطوير. بالإضافة إلى ذلك، فإنه يمكن عملاء فريق التطوير المعينين ك Project مسؤول لإدارة تعريفات البيئة المتوفرة لفرقهم.

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

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

إضافة كتالوج إلى مشروع

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

لتمكين استخدام الكتالوجات على مستوى المشروع على مستوى مركز التطوير:

  1. في مدخل Microsoft Azure، انتقل إلى مركز التطوير الخاص بك.

  2. في القائمة على اليسار، ضمن Settings، اختر Configuration.

    لقطة شاشة تعرض صفحة نظرة عامة لمركز التطوير مع تمييز التكوين.

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

    لقطة شاشة تعرض جزء كتالوجات مستوى المشروع، مع تمييز تمكين الكتالوجات لكل مشروع.

لتمكين استخدام تعريفات البيئة في المشروع:

  1. في مدخل Microsoft Azure، انتقل إلى مشروعك.

  2. في القائمة اليسرى، ضمن الإعدادات، حدد Catalogs.

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

  3. في صفحة Catalogs ، حدد Catalog item permissions.

    لقطة شاشة تعرض جزء الكتالوجات مع تمييز أذونات عنصر الكتالوج.

  4. في جزء إعدادات عنصر الكتالوج، حدد تعريفات بيئة توزيع Azure لتمكين استخدام تعريفات البيئة على مستوى المشروع.

    لقطة شاشة تعرض جزء إعدادات عنصر الكتالوج مع تحديد تعريفات بيئة توزيع Azure.

الآن، يمكنك إضافة كتالوج إلى المشروع.

بالنسبة للكتالوجات التي تستخدم هوية مدارة أو رمز الوصول الشخصي (PAT) للمصادقة، يجب تعيين هوية مدارة للمشروع. بالنسبة للكتالوجات التي تستخدم PAT، يجب تخزين PAT في مخزن مفاتيح ومنح الهوية المدارة حق الوصول إلى سر key vault.

تكوين هوية مُدارة

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

إذا لم يكن لدى مركز التطوير أو المشروع MSI مرفق، فاتبع الخطوات الواردة في تكوين هوية مدارة لإنشاء واحدة وتعيين أدوار للهوية المدارة.

لمعرفة المزيد حول الهويات المدارة، راجع ما هي الهويات المدارة لموارد Azure؟

إضافة كتالوج

يمكنك إضافة كتالوج من مستودع Azure Repos أو مستودع GitHub. يمكنك اختيار المصادقة عن طريق تعيين أذونات إلى MSI أو باستخدام PAT، الذي تقوم بتخزينه في مخزن مفاتيح.

حدد علامة التبويب لنوع المستودع والمصادقة التي تريد استخدامها.

لإضافة كتالوج، أكمل المهام التالية:

  • تعيين أذونات في Azure Repos للهوية المدارة.
  • أضف مستودعك ككتالوج.

تعيين أذونات في Azure Repos للهوية المدارة

يجب منح أذونات الهوية المدارة إلى المستودع في Azure Repos.

  1. سجّل الدخول إلى مؤسسة Azure DevOps .

    إشعار

    يجب أن تكون مؤسسة Azure DevOps في نفس الدليل مثل اشتراك Azure الذي يحتوي على مركز التطوير أو المشروع.

  2. حدد إعدادات المؤسسة.

    لقطة شاشة تعرض صفحة مؤسسة Azure DevOps، مع تمييز الإعدادات المؤسسة.

  3. في صفحة Overview ، حدد Users.

    لقطة شاشة تعرض صفحة نظرة عامة على المؤسسة، مع تمييز المستخدمين.

  4. في صفحة المستخدمين ، حدد إضافة مستخدمين.

    لقطة شاشة تعرض صفحة المستخدمين، مع تمييز إضافة مستخدم.

  5. أكمل إضافة مستخدمين جدد عن طريق إدخال المعلومات التالية أو تحديدها، ثم حدد إضافة:

    الاسم القيمة‬
    المستخدمون أو كيانات الخدمة أدخل اسم مركز التطوير أو المشروع.
    عند استخدام MSI المعين من قبل النظام، حدد اسم مركز التطوير أو المشروع، وليس معرف الكائن للحساب المدار. عند استخدام MSI المعين من قبل المستخدم، استخدم اسم الحساب المدار.
    مستوى الوصول حدد أساسي.
    إضافة إلى المشاريع حدد المشروع الذي يحتوي على المستودع الخاص بك.
    مجموعات Azure DevOps حدد Project Readers.
    إرسال دعوات بالبريد الإلكتروني (إلى المستخدمين فقط) قم بإلغاء تحديد خانة الاختيار.

    لقطة شاشة تعرض إضافة مستخدمين، مع تمييز إدخالات المثال وإضافة.

إضافة مستودعك ككتالوج

تدعم Azure Deployment Environments إرفاق مستودعات Azure Repos ومستودعات GitHub. يمكنك تخزين مجموعة من قوالب IaC المنسقة في مستودع. يؤدي إرفاق المستودع بمركز التطوير أو المشروع ككتالوج إلى منح فرق التطوير إمكانية الوصول إلى القوالب وتمكينهم من إنشاء بيئات متسقة بسرعة.

تتيح لك الخطوات التالية إرفاق مستودع Azure Repos.

  1. في مدخل Microsoft Azure، انتقل إلى مركز التطوير أو المشروع.

  2. في القائمة اليمنى ضمن Environment configuration، حدد Catalogs، ثم حدد Add.

    لقطة شاشة تعرض جزء الكتالوجات.

  3. في إضافة كتالوج، أدخل المعلومات التالية، ثم حدد إضافة:

    الحقل القيمة
    الاسم أدخل اسما للكتالوج.
    موقع الكتالوج حدد Azure DevOps.
    نوع المصادقة حدد الهوية المدارة.
    المنظمة حدد مؤسسة Azure DevOps.
    المشروع من قائمة المشاريع، حدد المشروع الذي يخزن المستودع.
    الريبو من قائمة المستودعات، حدد المستودع الذي تريد إضافته.
    الفرع حدد الفرع.
    مسار المجلد يسترد Dev Box قائمة بالمجلدات في الفرع الخاص بك. حدد المجلد الذي يخزن قوالب IaC.

    لقطة شاشة تعرض جزء إضافة كتالوج مع إدخالات أمثلة وإضافة مميزة.

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

عرض عناصر الكتالوج المتزامنة

بغض النظر عن نوع المستودع الذي تستخدمه، يمكنك عرض عناصر الكتالوج التي تتم مزامنتها من الكتالوج.

  1. في القائمة اليسرى لمركز التطوير أو المشروع، ضمن Environment configuration، حدد Catalogs.

  2. في جزء Catalogs ، حدد اسم الكتالوج.

    لقطة شاشة تعرض جزء الكتالوج، مع تمييز اسم الكتالوج المرفق.

  3. ترى قائمة بعناصر الكتالوج التي تمت مزامنتها بنجاح.

    لقطة شاشة تعرض عناصر الكتالوج التي تمت مزامنتها بنجاح من الكتالوج المرفق.

تحديث كتالوج

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

مزامنة كتالوج يدويا

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

  1. في القائمة اليسرى لمركز التطوير الخاص بك، ضمن Environment configuration، حدد Catalogs.

  2. حدد الكتالوج المحدد، ثم من شريط الأوامر، حدد مزامنة.

    لقطة شاشة تعرض زر المزامنة في شريط الأوامر.

مزامنة كتالوج تلقائيا

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

  1. في القائمة اليسرى لمركز التطوير أو المشروع، ضمن Environment configuration، حدد Catalogs.

  2. حدد الكتالوج المحدد، ثم حدد تحرير.

    لقطة شاشة تعرض زر التحرير للكتالوج.

  3. في جزء تحرير الكتالوج ، حدد مزامنة هذا الكتالوج تلقائيا، ثم حدد حفظ.

    لقطة شاشة تعرض جزء تفاصيل التحرير للكتالوج، مع تمييز مزامنة هذا الكتالوج تلقائيا.

حذف كتالوج

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

لحذف كتالوج:

  1. في القائمة اليسرى لمركز التطوير أو المشروع، ضمن Environment configuration، حدد Catalogs.

  2. حدد الكتالوج المحدد، ثم حدد حذف.

  3. في مربع الحوار حذف الكتالوج ، حدد متابعة لحذف الكتالوج.

استكشاف أخطاء مزامنة الكتالوج وإصلاحها

عند إضافة كتالوج أو مزامنته، قد تواجه خطأ مزامنة أو تحذيرا. يشير خطأ المزامنة إلى فشل مزامنة الكتالوج بنجاح، ويشير تحذير المزامنة إلى وجود أخطاء في بعض عناصر الكتالوج أو كلها. يمكنك عرض حالة المزامنة والأخطاء في مدخل Microsoft Azure، أو استخدام واجهة برمجة تطبيقات Azure CLI وREST لاستكشاف الأخطاء وحلها.

عرض حالة مزامنة الكتالوج

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

عرض حالات فشل مزامنة الكتالوج

  1. في القائمة اليسرى لمركز التطوير أو المشروع، ضمن Environment configuration، حدد Catalogs.

  2. في عمود الحالة ، حدد ارتباط الحالة للكتالوج الذي فشل في المزامنة.

    لقطة شاشة تعرض جزء Catalogs، مع تمييز المزامنة الفاشلة.

  3. ترى جزء التفاصيل الذي يعرض التغييرات في المزامنة الأخيرة وعدد أخطاء المزامنة ونوع الأخطاء.

    لقطة شاشة تعرض جزء فشل مزامنة الكتالوج.

عرض تحذيرات مزامنة الكتالوج

  1. في القائمة اليسرى لمركز التطوير أو المشروع، ضمن Environment configuration، حدد Catalogs.

  2. في عمود الحالة ، حدد ارتباط الحالة للكتالوج الذي تمت مزامنته ولكنه يبلغ عن تحذير.

    لقطة شاشة تعرض جزء الكتالوجات، مع تمييز الأخطاء في 3 عناصر.

  3. ترى جزء التفاصيل الذي يعرض التغييرات في المزامنة الأخيرة، وعدد أخطاء العنصر، ونوع كل خطأ ومصدره.

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

  4. يمكنك عرض العناصر التي تمت مزامنتها بنجاح من كتالوج يبلغ أيضا عن أخطاء المزامنة. من جزء Catalogs ، حدد اسم الكتالوج.

    لقطة شاشة تعرض جزء الكتالوج، مع تمييز اسم الكتالوج.

  5. ترى قائمة بعناصر الكتالوج التي تمت مزامنتها بنجاح.

    لقطة شاشة تعرض عناصر الكتالوج التي تمت مزامنتها بنجاح.

استكشاف أخطاء مزامنة الكتالوج وإصلاحها باستخدام Azure CLI

استخدم Azure CLI أو واجهة برمجة تطبيقات REST للحصول على الكتالوج. تظهر لك استجابة GET نوع الخطأ:

  • تعريفات البيئة التي تم تجاهلها والتي تم اكتشاف أنها مكررة.
  • تعريفات البيئة غير صحيحة التي فشلت بسبب أخطاء المخطط أو المرجع أو التحقق من الصحة.

حل أخطاء تعريف البيئة التي تم تجاهلها

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

حل أخطاء تعريف البيئة غير الصالحة

قد يحدث خطأ غير صالح في تعريف البيئة لأسباب مختلفة:

  • أخطاء مخطط البيان. تأكد من أن ملف بيئة تعريف البيئة الخاص بك يطابق المخطط المطلوب.

  • أخطاء التحقق من الصحة. تحقق من العناصر التالية لحل أخطاء التحقق من الصحة:

    • تأكد من تكوين نوع محرك ملف البيئة بشكل صحيح.
    • تأكد من أن اسم تعريف البيئة بين 3 و63 حرفا.
    • تأكد من أن اسم تعريف البيئة يتضمن فقط الأحرف الصالحة لعنون URL، وهي أحرف أبجدية رقمية وهذه الرموز: ~!,.';:=-_+()*&$@
  • أخطاء مرجعية. تأكد من أن مسار القالب الذي يشير إليه ملف البيئة هو مسار نسبي صالح لملف في المستودع.