Azure Service Fabric CLI

مقالة
06/01/2023

تعتبر واجهة سطر الأوامر Azure Service Fabric (CLI) أداة مساعدة لسطر الأوامر للتفاعل مع كيانات Service Fabric وإدارتها. يُمكن استخدام واجهة سطر الأوامر (CLI) الخاصة بـ Service Fabric مع مجموعات Windows أو Linux. يعمل Service Fabric CLI على أي نظامٌ أساسي يتم فيه دعم Python.

هام

هناك اثنين من مرافق CLI المستخدمة للتفاعل مع نسيج الخدمة. تُستخدم Azure PowerShell لإدارة موارد Azure، مثل كتلة نسيج الخدمة التى استضافتها Azure يتم استخدام خدمة نسيج CLI للاتصال مباشرة بكتلة نسيج الخدمة (بغض النظر عن المكان الذي يستضيفه) وإدارة نظام المجموعة والتطبيقات والخدمات.

المتطلبات الأساسية

قبل التثبيت، تأكد من تثبيت كل من Python و pip على بيئتك. لمزيد من المعلومات، راجعوثائق التشغيل السريع pip ووثائق تثبيت Pythonالرسمية.

يدعم CLI إصدارات Python 2.7 و 3.6 +، ويوصى باستخدام Python 3.x.

وقت تشغيل هدفُ نسيج الخدمة

يهدُف نظام CLI الخاص ب Service Fabric إلى دعم أحدث إصدار من وقت التشغيل من Service Fabric SDK. استخدم الجدول التالي من أجل تحديد إصدار CLI المطلوب تثبيته:

الإصدار CLI	دعم إصدار وقتُ التشغيل
الأحدث (~=10)	الأحْدث (~=7.1)
9.0.0	7.1
8.0.0	6.5
7.1.0	6.4
6.0.0	6.3
5.0.0	6.2
4.0.0	6.1
3.0.0	6.0
1.1.0	5.6, 5.7

يمكنك اختيارياً تحديد إصدار مستهدف من CLI لتثبيته عن طريق لاحقة pip installالأمر==<version>. على سبيل المثال، بالنسبة للإصدار 1.1.0 يكون بناء الجملة:

pip install -I sfctl==1.1.0

استبدل الأمر التاليpip installبالأمر المذكور سابقا عند الضرورة.

لمزيد من المعلومات بشأن إصدارات CLI الخاصة ب Service Fabric، راجعوثائق GitHub.

تثبيت نقطة وبايثون وخدمة النسيج CLI

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

Windows

بالنسبة لـ Windows 10، استخدم Windows Server 2016 و Windows Server 2012 R2، إرشادات التثبيت الرسمية القياسية. يقوم مثبت Python أيضاً بتثبيت النقطة افتراضيا.

انتقل إلىصفحة تنزيلات Python الرسمية، وقم بتنزيل أحدث إصدار من Python 3.x.
ابدأ تشغيل المُثبت.
في أسفل المطالبة، قم بتحديدإضافة Python 3.x إلى PATH.
حدد تثبيت الآن، وأنهي التثبيت.

يمكنك الآن فتح نافذة الأوامر الجديدة والحصول على إصدار كل من Python و pip.

python --version
pip --version

ثم شغّل الأمر التالي لتثبيت Azure Service Fabric CLI (sfctl) وعرض صفحة تعليمات CLI:

pip install sfctl
sfctl -h

Ubuntu والنظام الفرعي Windows لـ Linux

من أجل تثبيت CLI نسيج الخدمة، شغّل الأوامر التالية:

sudo apt-get install python3
sudo apt-get install python3-pip
pip3 install sfctl

ثم يمكن اختبار التثبيت مع:

sfctl -h

في حال تلقيت أمرا لم يتم العثور على خطأ مثل:

sfctl: command not found

تأكد من أنه~/.local/binيمكن الوصول إليها من خلال$PATH:

export PATH=$PATH:~/.local/bin
echo "export PATH=$PATH:~/.local/bin" >> .shellrc

إذا فشل التثبيت على Windows فرعي لنظام التشغيل Linux بأذونات مجلد غير صحيحة، فقد يكون من الضروري المحاولة مرة أُخرى باستخدام أذونات مرتفعة:

sudo pip3 install sfctl

Red Hat Enterprise Linux 7.4 (دعم معاينة نسيجِ الخدمة)

لتثبيت Service Fabric CLI على Red Hat، شغّل الأوامر التالية:

sudo yum install -y python38
sudo yum install python38-setuptools
sudo easy_install-3.4 pip
sudo pip3 install sfctl

لاختبار التثبيت، يمكنك الرجوع إلى الخطوات المذكورة فيUbuntu والنظام الفرعي Windows لقسم Linux

MacOS

بالنسبة لنظام التشغيل MacOS، نوصي باستخداممدير حزم HomeBrew. إذا لم يكن HomeBrew مثبتاً بالفعل، فقم بتثبيته عن طريق تشغيل الأمر التالي:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

ثم من المحطة الطرفية، قُم بتثبيت أحدث إصدار من Python 3.x و pip و Service Fabric CLI من خلال تشغيل الأوامر التالية:

brew install python3
pip3 install sfctl
sfctl -h

بناء جُملة CLI

الأوامر مسبوقة دائما بـsfctl. من أجل الحصول على معلومات عامة حول جميع الأوامر التي يمكنك استخدامها، استخدمsfctl -h. من أجل الحصول على تعليمات بشأن أمر واحد، استخدمsfctl <command> -h.

تتبُع الأوامر بنية قابلة للتكرار، مع هدف الأمر الذي يسبق الفعل أو الإجراء.

sfctl <object> <action>

في هذا المثال،<object>هو الهدف من<action>.

تحدِيد مجموعة

قبل تنفيذ أي عمليات، فيجب تحديد مجموعة للاتصال بها. على سبيل المثال، من أجل تحديد الكتلة والاتصال بها بالاسمtestcluster.com، قم بتشغيل الأمر التالي:

تحذير

لا تستخدم مجموعات نسيج الخدمة الغير آمنة في بيئة إنتاج.

sfctl cluster select --endpoint http://testcluster.com:19080

يجب أن تكون نقطة نهاية الكتلة مسبوقة بـhttp أوhttps. يجب أن يشمل منفذ بوابة HTTP. المنفذ والعنوان هما نفس عنوان URL المتعلق بمستكشف نسيج الخدمة.

بالنسبةِ للمجموعات المؤمنة بشهادة، يمكنك تحديد شهادة مشفرة من قِبل PEM. يُمكن تحديد الشهادة كملف واحد أو كشهادة وزوج مفاتيح. إذا كانت شهادة موقعة ذاتياً وغير موقعة من المرجع المصدق، فيمكنك تمرير--no-verify خيار تجاوز التحقق من المرجع المصدق.

sfctl cluster select --endpoint https://testsecurecluster.com:19080 --pem ./client.pem --no-verify

للمزيد من المعلومات، راجعالاتصال إلى مجموعة Azure Service Fabric آمنة.

العملياتِ الأساسية

تستمر معلومات اتصال نظام المجموعة خلال جلسات عمل CLI متعددة ل Service Fabric. بعد تحديد نظام مجموعة نسيج خدمة، يمكن تشغيل أي أمر نسيج خدمة على نظام المجموعة.

على سبيل المثال، من أجل الحصول على حالة حماية نظام المجموعة Service Fabric، استخدم الأمر التالي:

sfctl cluster health

يؤدي الأمر لإخراج التالي:

{
  "aggregatedHealthState": "Ok",
  "applicationHealthStates": [
    {
      "aggregatedHealthState": "Ok",
      "name": "fabric:/System"
    }
  ],
  "healthEvents": [],
  "nodeHealthStates": [
    {
      "aggregatedHealthState": "Ok",
      "id": {
        "id": "66aa824a642124089ee474b398d06a57"
      },
      "name": "_Test_0"
    }
  ],
  "unhealthyEvaluations": []
}

تلميحات واستكشافُ الأخطاء وإصلاحها

فيما يلي بعضُ الاقتراحات والنصائح لحل المشكلات الشائعة.

تحويل الشهادة من PFX لتنسيق PEM

يدعم CLI Service Fabric الشهادات من جانبِ العميل كملفات PEM (ملحق.pem). إذا كنت تستخدم ملفات PFX من Windows، فيجبُ عليك تحويل هذه الشهادات إلى تنسيق PEM. نم أجل تحويل ملف PFX إلى ملف PEM، استخدم الأمر التالي:

openssl pkcs12 -in certificate.pfx -out mycert.pem -nodes

وبالمثل، للتحويل من ملف PEM إلى ملف PFX، يمكنك استخدام الأمر التالي (لا يتم توفير كلمة مرور هنا):

openssl  pkcs12 -export -out Certificates.pfx -inkey Certificates.pem -in Certificates.pem -passout pass:''

لمزيد من المعلومات، انطروثائق OpenSSL.

مشاكل الاتصال

قد تقوم بعض العمليات بإنشاءِ الرسالة التالية:

Failed to establish a new connection

تحقق من توفر نقطة نهاية الكتلة المُحددة ومن الاستماع. تحقق أيضاً من توفر واجهة مستخدم Service Fabric Explorer في هذا المضيفِ والمنفذ. من أجل تحديث نقطة النهاية، استخدمsfctl cluster select.

سجّلات تفصيلية

غالباً ما تكون السجلات التفصيلية مفيدة عند تصحيح الأخطاء أو الإبلاغ عن مشكلة. --debugتزيد العلامة من إسهاب الإخراج.

تعليماتِ الأوامر وبناء الجملة

من أجل الحصول على تعليمات حول أمر معين أو مجموعة من الأوامر، استخدم العلامة-h.

sfctl application -h

وإليك مثال آخر:

sfctl application create -h

تحديث واجهة سطر الأوامر المتعلقة بنسيج الخدمة

من أجل تحديث CLI ل Service Fabric، قم بتشغيل الأوامر التالية (استبدل pip بحسب pip3 ما اخترته أثناء التثبيت الأصلي):

pip uninstall sfctl
pip install sfctl

Share via