إعداد وإعداد Edge Microgateway

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

Edge Microgateway، الإصدار 3.3.x

نظرة عامة

بعد إكمال الخطوات الواردة في دليل الإعداد، ستكون لديك عملية تثبيت Edge Microgateway تم ضبطها بالكامل وتعمل على معالجة طلبات البيانات من واجهة برمجة التطبيقات. ويمكنك اختبار عملية الإعداد من خلال إجراء طلبات آمنة من واجهة برمجة التطبيقات عبر Edge Microgateway للوصول إلى هدف في الخلفية. وستتعلّم أيضًا طريقة إضافة مكوِّن إضافي لإيقاف البث المباشر في Microgateway.

ينقسم هذا الدليل إلى الأجزاء التالية:

المتطلبات الأساسية: تثبيت Edge Microgateway

اتّبِع التعليمات الواردة في تثبيت Edge Microgateway. عند إكمال عملية التثبيت، ستكون جاهزًا لاتّباع الخطوات الواردة في هذا البرنامج التعليمي.

الجزء 1: تهيئة Edge Microgateway

ستستخدم في هذا الجزء أمر واجهة سطر أوامر (CLI) لضبط إعدادات Edge Microgateway للتواصل مع Apigee Edge.

خطوات إعداد Apigee Edge Cloud

اتبع هذه الخطوات لاستخدام Edge Microgateway مع Apigee Edge Cloud:

  1. اضبط إعدادات Edge Microgateway (ما عليك سوى تنفيذ هذه الخطوة مرة واحدة فقط):
    edgemicro init
  2. تم وضع ملف إعداد باسم default.yaml في الدليل الرئيسي في دليل فرعي باسم .edgemicro. تحقَّق الآن للتأكد من توفّر هذا الملف: 
    ls ~/.edgemicro
default.yaml

    ملاحظة: في مستندات Edge Microgateway، نشير إلى الدليل الرئيسي بعلامة التلدة (~)، وهو اختصار UNIX. إذا كنت تستخدم نظام التشغيل Windows، وإذا كنت تشغّل واجهة أوامر لا تتيح رمز التلدة، ستحتاج إلى استبدال متغيّر البيئة المناسب بعلامة التلدة في الأوامر التي تشير إلى الدليل الرئيسي. على سبيل المثال: %USERPROFILE%/.edgemicro.

  3. تتضمن جميع أوامر CLI وظيفة مساعدة. مساعدة الطباعة للأمر edgemicro Configure "ضبط":
    edgemicro configure -h
  4. نفِّذ الأمر التالي لإعداد Edge Microgateway:
    edgemicro configure -o [org] -e [env] -u [username]

    المكان:

    • org: اسم مؤسسة Edge (يجب أن تكون مشرف مؤسسة).
    • env: بيئة في مؤسستك (مثل اختبار أو prod).
    • username: عنوان البريد الإلكتروني المرتبط بحسابك على Apigee.

      ملاحظة: يسمح الأمر "Configure" (ضبط) بمَعلمات إضافية. للحصول على قائمة كاملة، يُرجى الاطّلاع على إعداد Edge Microgateway لخدمة Apigee Edge Cloud.

مثال

edgemicro configure -o docs -e test -u jdoe@example.com

الناتج

./edgemicro configure -o docs -e test -u jdoe@apigee.com
password:
current nodejs version is v12.5.0
current edgemicro version is 3.1.0
password:
file doesn't exist, setting up
Give me a minute or two... this can take a while...
App edgemicro-auth deployed.
checking org for existing KVM
error checking for cert. Installing new cert.
creating KVM
adding private_key
adding public_key
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1

saving configuration information to: $HOME/.edgemicro/docs-test-config.yaml

vault info:
 -----BEGIN CERTIFICATE-----
MIICpDCCAYwCCQCQ2mJZJGbPPTANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3QwHhcNMTcwOTA3MjA0ODA4WhcNMTcwOTA4MjA0ODA4WjAUMRIwEAYD
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDw
yzmqi5CelqqtTr6IaFe1ssrMXEDnNtkBh95U6F5zHLsNQhJcyNUAO9um6FLMSqSd
fTztXfWUZzDgmbb6sfbx/9cqpvQ8TIjxyIz8xGM9H4legRQmsCQoYGkLjpPE5ZOa
wZrI5IaVm8LY6vbopPFwxgKOQ9bphx6k9Na055DmNyZAOTMD+4I0m/RdsrnZnYih
3DaFj1tXHKZI1jfAt/QOif5Nmk4+JckYwF+9HBysWUbbvj/gnBjVYF2Isb7q7oFD
lPGhwFoIebMqHMWD8lG7+9RJDO9dDV6f1g1/9waIrq1D+MoVXos9VMstNrPp0cKF
Ue+lAkct8tylH+2MosF7AgMBAAEwDQYJKoZIhvcNAQELBQADggEBAJMRdcQh3ayy
csVVT4TYwxV7MKWRfhDRz6X+MM9frB+Z7sI4+ZoZbXKOoZI2hSjmbdLpkNR/m9eJ
+1Uk0JKmpSY7Q+1rRrvcHsWNysGf4z+zDJXYECTrtSnXKBXtb9SJ8JAfoZOQD0lA
zmKuJjQMLTdiYMHOBR6ZWnaKaRvrQwGHcQrheJm4a90XgZF6jcRR8CPrBzkmsbCp
IU/Ux3E17wDGYPxjJs5otyQG8rN/88RGyaSeXK8rjKr9D4KFGJeasXBKmTG2afAr
yfBvS4h6s42FCOR/eLpmMllVoO9up71Fa3EtV+aK+FNNY9uMbgUHeLQE7z9nn06q
PTmvExZLkLQ=
-----END CERTIFICATE-----

The following credentials are required to start edge micro
  key: 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb
  secret: 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

خطوات إعداد Apigee Private Cloud

اتّبِع هذه الخطوات لاستخدام Edge Microgateway مع Apigee Private Cloud:

  1. اضبط إعدادات Edge Microgateway (ما عليك سوى تنفيذ هذه الخطوة مرة واحدة فقط):
    edgemicro init
  2. اطبع معلومات المساعدة الخاصة بأمر edgemicro Private Configuration. ويمكنك الطباعة بهذه الطريقة لأي خيار أو أمر أو أمر من واجهة سطر الأوامر في Edge Microgateway. 
    edgemicro private configure -h
  3. نفِّذ الأمر التالي. تتطلّب هذه الطريقة معلومات عادية حول حسابك على Apigee Edge Private Cloud، وهي اسم المؤسسة واسم البيئة واسم المستخدم (عنوان البريد الإلكتروني) وكلمة المرور وعنوان IP لخادم الإدارة وعنوان IP لجهاز التوجيه. يجب أن تكون مشرف مؤسسة Edge لتتمكن من استخدام هذا الأمر: 
    edgemicro private configure -o [org] -e [env] -u [username] -r [runtime_url] -m [mgmt_url] -v [virtual_host]

    المكان:

    • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
    • env هي بيئة في مؤسستك (مثل test أو prod).
    • runtime_url هو عنوان URL لوقت التشغيل لمثيل السحابة الإلكترونية الخاص.
    • mgmt_url هو عنوان URL لخادم الإدارة لمثيل السحابة الإلكترونية الخاص.
    • username هو عنوان البريد الإلكتروني المرتبط بحسابك على Apigee.
    • virtual_host هي قائمة مفصولة بفواصل تتضمّن أسماء المضيفين الافتراضيين. القيم التلقائية هي default,secure

مثال

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.52.106:9001 -m http://192.162.52.106:8080 -v default

أو إذا كان لديك اسم مستعار لمضيف افتراضي خاص بـ myorg-test.mycompany.com، يمكنك استخدام أمر على النحو التالي:

edgemicro private configure -o docs -e test -u jdoe@example.com -r myorg-test.mycompany.com -m http://192.162.52.106:8080 -v default

الناتج

delete cache config
checking for previously deployed proxies
configuring edgemicro internal proxy
deploying edgemicro internal proxy
deploying  edgemicro-auth  app
copy auth app into tmp dir
copy config into tmp deer
Give me a minute or two... this can take a while...
App edgemicro-auth added to your org. Now adding resources.

checking org for existing KVM
error checking for cert. Installing new cert.
creating KVM
adding private_key
adding public_key
configuring host http://192.168.52.106:9001 for region dc-1

saving configuration information to: $HOME/.edgemicro/jdoe-test-config.yaml
vault info: 
-----BEGIN CERTIFICATE----- 
MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFswhB0Yvg6JKWsKWBDP9o
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik245yfBku7olooXKRKTRKOUoXa 
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0= 
-----END CERTIFICATE----- 

The following credentials are required to start edge micro 
   key: a3f8f3dfe39158fc3c50b274f0af2234246e0d5f6ea4ad09389b645147151ba3
   secret: 3e9904802fb3c0e8ca408128a11119cf13546d54dac10ace944c097a726a1263

edgemicro configuration complete!

التحقّق من عملية التثبيت

نفِّذ الأمر التالي للتحقّق من عملية التثبيت. إذا لم يتم الإبلاغ عن أي أخطاء، سيتم إعداد كل الخطوات بشكل صحيح وستتمكن من بدء تشغيل Edge Microgateway بنجاح. 

edgemicro verify -o [org] -e [env] -k [key] -s [secret]

المكان:

  • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
  • env هي بيئة في مؤسستك (مثل test أو prod).
  • key هو المفتاح الذي يعرضه الأمر Configuration سابقًا.
  • secret هو المفتاح الذي يعرضه الأمر Configuration سابقًا.

مثال

edgemicro verify -o docs -e test -k 93b01fd21d86331459ae52f624ae9aeb13eb94767ce40a4f621d172cdfb7e8e6 -s c8c755be97cf56c21f8b0156d7132afbd03625bbd85dc34ebfefae4f23fbcb3c

لمحة عن الإعدادات

إنّ جميع الإعدادات التي تم إجراؤها حتى الآن تسمح لأداة Edge Microgateway ببدء تشغيل نفسها على Apigee Edge. بعد نجاح عملية بدء التشغيل، يسترد Edge Microgateway حمولةً من معلومات الإعدادات الإضافية من Apigee Edge.

ما الغرض من استخدام معلومات الإعداد هذه؟ سنكتشف في الجزء التالي من هذا البرنامج التعليمي، أنّه عند بدء تشغيل Edge Microgateway، يجب أن يتلقّى قائمة بالخوادم الوكيلة الخاصة لواجهة برمجة التطبيقات الخاصة بـ Edge Microgateway-aware من Apigee Edge. في الجزء التالي من هذا البرنامج التعليمي، سيتم إنشاء خادم وكيل مع Microgateway. تحظر Edge Microgateway العملاء على استدعاء واجهات برمجة التطبيقات التي تقدّمها الخوادم الوكيلة لواجهة برمجة التطبيقات Microgateway-aware، وسيُطلب من البرامج (تلقائيًا) تقديم رمز أمان مميّز صالح لكل طلب. لمزيد من المعلومات عن هذه الخوادم الوكيلة، يُرجى الاطّلاع على مقالة "المعلومات التي يجب معرفتها عن الخوادم الوكيلة لـ Edge Microgateway" في القسم نظرة عامة على Edge Microgateway.

بصفتك مشرفًا في مؤسسة Edge، سيكون لديك اهتمام بمعرفة أنّه يمكن إضافة الخوادم الوكيلة المستندة إلى تقنية Edge Microgateway إلى منتجات Edge، تمامًا مثل أي خوادم وكيلة أخرى. من خلال استخدام المنتجات وتطبيقات المطوّرين، يمكنك إنشاء رموز مميّزة للأمان خاصة بكل عميل للتحكّم في الوصول إلى واجهات برمجة التطبيقات التي يتم استدعائها من خلال Edge Microgateway. ونذكر مرة أخرى أن الأنماط المعنية مماثلة للعمل مع أي خوادم وكيلة لواجهة برمجة التطبيقات ومنتجات وتطبيقات المطوّرين على Apigee Edge. إذا كنت تريد الاطّلاع على معلومات حول المنتجات، ابدأ بقراءة القسم ما المقصود بمنتج واجهة برمجة التطبيقات؟ في مستندات Edge.

سنتحدّث بعد ذلك عن طريقة إنشاء الخوادم الوكيلة لـ Edge Microgateway، وبعد ذلك، سنبدأ تشغيل Edge Microgateway واختبار عملية الإعداد.

الجزء الثاني: إنشاء كيانات على Apigee Edge

في هذا الجزء، ستقوم بإنشاء هذه الكيانات على Edge:

  • خادم وكيل مع دراية ببوابة فرعية: هو خادم وكيل خاص يمكن لبرنامج Edge Microgateway اكتشافه عند بدء التشغيل. لدى الخوادم الوكيلة المستندة إلى Microgateway اصطلاح تسمية يجب اتباعه: يجب أن يبدأ الاسم بـ edgemicro_. على سبيل المثال، edgemicro_hello أو edgemicro_userinfo. عند بدء تشغيل Edge Microgateway، يسترد من Edge قائمة من الخوادم الوكيلة الواعية للبوابة الصغيرة من نفس مؤسسة وبيئة Edge التي حددتها عند بدء تشغيل Edge Microgateway.

    بالنسبة إلى كل خادم وكيل مدرك لبوابة صغيرة، يسترد Edge Microgatway عنوان URL المستهدف للخادم الوكيل ومساره الأساسي. توفّر الخوادم الوكيلة المستندة إلى Microgateway أيضًا طريقة سهلة لربط بيانات الإحصاءات التي ينشئها Edge Microgateway بخادم وكيل على منصة Edge. وبما أنّ Microgateway يعالج طلبات البيانات من واجهة برمجة التطبيقات، يرسل بيانات الإحصاءات إلى Edge بشكل غير متزامن. ستظهر بيانات الإحصاءات في واجهة مستخدم Edge Analytics ضمن أسماء الخادم الوكيل الواعي للبوابة الصغيرة، كما تظهر مع أي خادم وكيل آخر.
  • تطبيق لمنتج ومطوّر ومطوِّر: يستخدم Edge Microgateway المنتجات والمطوّرين وتطبيقات المطوّرين لتفعيل أمان رمز الدخول OAuth2 أو مفتاح واجهة برمجة التطبيقات. عند بدء تشغيل Edge Microgateway، ينزِّل البرنامج جميع إعدادات المنتجات من مؤسسة Apigee Edge الخاصة بك. يستخدم النظام هذه المعلومات للتحقّق من طلبات البيانات من واجهة برمجة التطبيقات التي يتم إجراؤها من خلال Edge Microgateway باستخدام مفاتيح واجهة برمجة التطبيقات أو رموز الدخول إلى OAuth2.

1- إنشاء خادم وكيل لـ Edge Microgateway-aware API على Edge

  1. سجِّل الدخول إلى مؤسستك على Apigee Edge.
  2. حدّد التطوير > الخوادم الوكيلة لواجهة برمجة التطبيقات في قائمة التنقل الجانبية.
  3. انقر على + خادم وكيل. يتم استدعاء معالج إنشاء خادم وكيل.
  4. في صفحة المعالج الأولى، اختَر الخادم الوكيل العكسي (الأكثر شيوعًا).
  5. انقر على التالي.
  6. في صفحة التفاصيل بالمعالج، يمكنك الضبط على النحو التالي. تأكّد من ملء المعالج تمامًا كما هو موضّح:
    • اسم الخادم الوكيل: edgemicro_hello
    • مسار القاعدة الأساسية للخادم الوكيل: /hello
    • واجهة برمجة التطبيقات الحالية: http://mocktarget.apigee.net/
  7. انقر على التالي.
  8. في صفحة الأمان بالمعالج، اختَر اجتياز (بدون).
  9. انقر على التالي.
  10. في صفحة المضيفين الظاهرية الخاصة بالمعالج، اقبل الإعدادات الافتراضية.
  11. انقر على التالي.
  12. في صفحة الإصدار بالمعالج، راجع إعدادات الخادم الوكيل. تأكَّد من اختيار بيئة الاختبار.
  13. انقر على إنشاء ونشر.

2. إنشاء منتج واجهة برمجة التطبيقات

  1. اختر النشر > منتجات واجهة برمجة التطبيقات في قائمة التنقّل الجانبية.
  2. انقر على + منتج واجهة برمجة التطبيقات.
  3. أدخِل تفاصيل المنتجات المعروضة في الجدول التالي:
    الحقل الوصف
    الاسم EdgeMicroTestProduct
    الاسم المعروض منتج اختبار Edge Microgatway
    البيئة اختبار
    إذن الوصول عامة
    نوع الموافقة على المفتاح تلقائي
  4. في قسم موارد واجهة برمجة التطبيقات، أضِف الخادم الوكيل لواجهة برمجة التطبيقات الذي أنشأته للتو والخادم الوكيل edgemicro-auth:
    • edgemicro_hello
    • edgemicro-auth
  5. انقر على حفظ.

3. إنشاء مطوّر

يمكنك الاستعانة بأي مطوّر حالي لتنفيذ الخطوة التالية، وهو إنشاء تطبيق مطوّر، وذلك من خلال هذا الدليل التعليمي. وإذا أردت، يمكنك إنشاء مطوّر تجريبي الآن:

  1. اختَر نشر > المطوّرون في قائمة التنقّل الجانبية.
  2. انقر على + مطوّر برامج.
  3. املأ مربّع الحوار لإنشاء مطوِّر تجريبي.

4. إنشاء تطبيق مطور

ستستخدم بيانات اعتماد العميل من هذا التطبيق لإجراء طلبات بيانات آمنة من واجهة برمجة التطبيقات من خلال Edge Microgateway:

  1. اختَر نشر > التطبيقات في قائمة التنقّل الجانبية.
  2. انقر على + تطبيق. ستظهر صفحة "تفاصيل تطبيق المطوِّر".
  3. املأ صفحة "تطبيق المطوِّر" على النحو التالي:
    1. الاسم: EdgeMicroTestApp
    2. الاسم المعروض: EdgeMicroTestApp
    3. مطوّر البرامج: إذا أنشأت مطوِّرًا تجريبيًا، اختَره. ويمكنك بدلاً من ذلك استخدام أي مطوّر حالي لغرض هذا البرنامج التعليمي.
    4. بيانات الاعتماد:
      1. اختَر تاريخ انتهاء الصلاحية: مطلقًا.
      2. انقر على + منتج واختَر EdgeMicroTestProduct (المنتج الذي أنشأته للتو).
  4. انقر على حفظ.
  5. لقد عدت إلى صفحة قائمة التطبيقات.
  6. اختر التطبيق الذي أنشأته للتو، EdgeMicroTestApp.
  7. انقر على عرض بجانب مفتاح المستهلك وسر العميل.

الجزء 3: تشغيل Edge Microgateway

بعد أن تم ضبط إعدادات Edge Microgateway وخادم وكيل Edge Microgateway المستخدَم على الأقل على Edge، يحين وقت تشغيل Edge Microgateway. سيتم تشغيل خادم Edge Microgateway HTTP على جهازك المحلي، وستُجري طلبات من واجهة برمجة التطبيقات إلى ذلك الخادم مباشرةً.

1- بدء مدخل Edge Microgateway

استخدِم الأمر edgemicro start لبدء استخدام Edge Microgateway.

  1. تأكَّد من أن لديك المفاتيح التي تم عرضها في السابق عند تشغيل الأمر edgemicro Configuration". ظهرت هذه النتيجة على النحو التالي: 
    You need key and secret while starting edgemicro instance

key: da4778e7c240a5d4585fc559eaba5083328828bc9f3a7f583e8b73e
secret: 3aad7439708b4aeb38ee08e82189921ad00e6fc1ba8a8ae9f929ee2
  2. (اختياري) اطبع معلومات المساعدة للأمر edgemicro start.
    edgemicro start -h
  3. لبدء تشغيل Edge Microgateway، نفِّذ الأمر التالي: 
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    المكان:

    • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
    • env هي بيئة في مؤسستك (مثل test أو prod).
    • key هو المفتاح الذي يعرضه الأمر Configuration سابقًا.
    • secret هو المفتاح الذي يعرضه الأمر Configuration سابقًا.

    مثال

    edgemicro start -o docs -e test -k 701e70e718ce6dc1880616b3c39177d64a88754d615c7a4e1f78b6181d000723 -s 05c14356e42d136b83dd135cf8a18531ff52d7299134677e30ef4e34ab0cc824

    الناتج

    يسترد الأمر start (البدء) الكثير من معلومات الإعدادات من Apigee Edge (التي يتم تمريرها إلى نافذة الوحدة الطرفية). ستظهر في النتيجة قائمة بالخوادم الوكيلة الواعية للبوابة الصغيرة والمنتجات التي تم اكتشافها. في نهاية النتيجة، من المفترَض أن يظهر لك على النحو التالي:

    ...

current nodejs version is v12.5.0
current edgemicro version is 3.1.0
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991
  4. تحقق من حالة البوابة الصغيرة. في نافذة طرفية أخرى، اضغط على cd إلى الدليل نفسه الذي بدأت فيه استخدام Edge Micro وأدخِل الأمر التالي: 
    edgemicro status
current nodejs version is v12.5.0
current edgemicro version is 3.1.0
edgemicro is running with 8 workers

What happened?

يتم تنزيل معلومات إعداد Edge Microgateway من Apigee Edge وتخزينها مؤقتًا محليًا. وتتضمن هذه المعلومات ما يلي:

  • المفتاح العام الذي أنشأناه وخزّنناه سابقًا في خريطة قيمة المفتاح المشفرة (KVM).
  • تمثيل لجميع الخوادم الوكيلة الواعية بـ Edge Microgateway والمتوفرة في المؤسسة/البيئة. وهذه هي جميع الخوادم الوكيلة التي تتم تسميتها بالبادئة edgemicro_.
  • تمثيل لجميع منتجات واجهة برمجة التطبيقات الموجودة في المؤسسة/البيئة.

وباستخدام هذه المعلومات، يتعرّف Edge Microgateway على الخوادم الوكيلة ومسارات الخادم الوكيل التي يُسمح لها بمعالجتها. وهو يستخدم معلومات المنتج لفرض الأمان (بالطريقة نفسها التي يستخدمها أي خادم وكيل لواجهة برمجة التطبيقات على Apigee Edge، حيث ترتبط مفاتيح تطبيق المطوّرين بالمنتجات). سنتحدّث قريبًا عن خطوات تأمين Edge Microgateway.

2. اختبار حافة مصغَّرة

عند تشغيل Edge Microgateway، يمكنك استدعاء الخادم الوكيل. تم تنزيل إعدادات الخادم الوكيل edgemicro_hello من Edge عندما بدأت تشغيل Edge Microgateway. تذكَّر أنّ المسار الأساسي للخادم الوكيل هو /hello.

لاختبار Edge Microgateway، نبدأ بالمسار الأساسي ونضيف مسار المورد /echo. تجدر الإشارة إلى أنّ كل العناصر التي تلي المسار الأساسي (بما في ذلك أي مَعلمات طلب بحث) يتم تمريرها ببساطة إلى هدف الخلفية:

curl -i http://localhost:8000/hello/echo
{"error":"missing_authorization","error_description":"Missing Authorization header"}

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

4. إيقاف حافة ميكروغيتواي

  1. في نافذة طرفية منفصلة، cd إلى الدليل نفسه الذي تم بدء تشغيل Edge Microgateway عليه.
  2. أدخِل أمر الإيقاف:
    edgemicro stop

الجزء 4: طريق حافة الأمان المصغَّرة

يمكنك تأمين طلبات البيانات من واجهة برمجة التطبيقات التي يتم إجراؤها من خلال Edge Microgateway باستخدام مفتاح واجهة برمجة التطبيقات أو رمز دخول.

طلبات بيانات من واجهة برمجة التطبيقات الآمنة باستخدام رمز دخول OAuth2

اتّبِع الخطوات التالية إذا كنت تريد مصادقة طلبات البيانات من واجهة برمجة التطبيقات باستخدام رمز دخول OAuth2:

1. الحصول على المفاتيح المطلوبة

  1. في واجهة مستخدم Edge، انتقِل إلى "تطبيق المطوِّر" الذي أنشأته سابقًا. وكان اسم التطبيق EdgeMicroTestApp.
  2. في صفحة تطبيق المطور، اعرض مفتاح العميل وسر العميل وانسخهما. هذه القيم مطلوبة للحصول على رمز الدخول في الخطوة التالية.

2. الحصول على رمز الدخول

هناك طريقتان للحصول على رمز الدخول. سنعرض لك الطريقتين.

استخدام واجهة سطر الأوامر للحصول على رمز الدخول

إنّ الطريقة الأولى سهلة الاستخدام، وهي تتّبع النمط الذي استخدمناه في البرنامج التعليمي. الطريقة الثانية أكثر فائدة بشكل عام لمطوّري تطبيقات العملاء الذين يحتاجون إلى طلب الرموز المميّزة. يتم تنفيذ نقطة نهاية الرمز المميز في خادم edgemicro-auth الوكيل، الذي تم نشره عند ضبط Edge Microgateway.

  1. (اختياري) يمكنك الاطّلاع على المساعدة بخصوص الأمر token get: 
    edgemicro token get -h
  2. أنشئ الرمز المميّز من خلال استبدال قيمتَي مفتاح المستهلك وسر العميل من تطبيق المطوّر الذي أنشأته على Apigee Edge في المعلّمتَين -i و-s: 
    edgemicro token get -o [org] -e [env] -i [consumer_key] -s [consumer_secret]

    المكان:

    • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
    • env هي بيئة في مؤسستك (مثل test أو prod).
    • consumer_id هو رقم تعريف المستهلك في تطبيق المطوّر الذي أنشأته سابقًا.
    • consumer_secret هو سر العميل في تطبيق المطوّر الذي أنشأته سابقًا.

    مثال

    edgemicro token get -o docs -e test -i G0IAeU864EtBo99NvUbn6Z4CBwVcS2 -s uzHTbwNWvoSmOy

    الناتج (عيّنة)

    current nodejs version is v12.5.0
{ token: 'eyJ0eXAiOiJKV1QiLCJhbGciSUzI1NiJ9.eyJhcHBsaWNhdGl
vbl9uYW1lIjoiNWNiMGY0tOWMzOC00YmJjLWIzNzEtZGMxZTQzOGYxZGMxI
iwiY2xpZW50X2lkIjoiNVVdBWEdvSU9lbzYwYWV3OTRQN0c1TUFaRTNhSnA
iLCJzY29wZXMiOltdLCJhcGlfcHJvjdF9saXN0IjpbIsVkZ2VNaWNyb1Rlc
3RQcm9kdWN0IlmlhdCI6MTQ3ODIwODMzMiwiZXhwIjoxNDc4MjEwMTMxfQ.
v3Q8Rs0W9FO_XpERwIAMMXhjGamRmmmWgrAy1wJv0-99oajx5ASI5qjNubM
nCF14xxwlVXHcz1VfedA8Nx7Ih145zhWWuPKL9muzhXXnVBRFeBMeeLqJk4
QQ7Bhst7xH_68nJSTE20Egu95DHOCUemfrepDFH0VggY4BmzvwLkBNfz_te
E_YqwKZbpGOLMdKK1vMk0fk0x19SieIMS_aJYeOAklrzUhnFxWJFrsAWsax
NLx_BbQcZzYfK1JSDUrhRNVBuPHMnGjNA_oHw2J4qa6Hsp62PfchG-DIW_t
-0BFnYf3rYXmqyNORqFrOMdl4VxqQ' }

(اختياري) استخدام واجهة برمجة التطبيقات للحصول على رمز مميّز

إذا كنت معتادًا على استدعاء خوادم Edge الوكيلة باستخدام curl أو برنامج HTTP آخر، من المهم معرفة أنّه يمكنك استدعاء نقطة نهاية الرمز المميّز مباشرةً بدلاً من استخدام الأمر edgemicro مميّز. إليك مثال على curl. ما عليك سوى استبدال أسماء المؤسسة والبيئة في عنوان URL، وإدخال قيم مفتاح العميل:مفتاح العميل المفصول بنقطتين في عنوان المصادقة الأساسية:

curl -i -X POST "http://[org]-[env].apigee.net/edgemicro-auth/token" -d '{ "client_id": "your consumer key", "client_secret": "your consumer secret", "grant_type": "client_credentials" }' -H "Content-Type: application/json"

المكان:

  • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
  • env هي بيئة في مؤسستك (مثل test أو prod).
  • client_id هو رقم تعريف المستهلك في تطبيق المطوّر الذي أنشأته سابقًا.
  • client_secret هو سر العميل في تطبيق المطوّر الذي أنشأته سابقًا.

الناتج (عيّنة)

يعرض الأمر، سواء استخدمت أمر واجهة سطر الأوامر edgemicro مميّزًا أو استدعيت نقطة النهاية باستخدام curl، رمز دخول موقَّعًا يمكن استخدامه لإجراء استدعاءات للبرنامج. شيء مثل هذا:

MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFsnhB0Yvg6JKWxKWBDP9o
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik241yfBku7olooXKRKTRKOUoXa
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0=

3. التحقّق من الإعدادات في Edge Microgateway

  1. افتح الملف "$HOME/.edgemicro/org-env-config.yaml". يمكنك الاطّلاع على صفحة أين يتم تثبيت Edge Microgateway إذا لم تتمكن من تحديد موقع هذا الملف.
  2. يمكنك التأكُّد من ضبط خصائص مكوّن Oauth الإضافي على false. تكون النتائج غير صحيحة تلقائيًا، ولكن من الأفضل التحقّق منها مرة أخرى: 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. في ملف org-env-config.yaml أيضًا، تأكَّد من إضافة المكوِّن الإضافي لبروتوكول oauth إلى العنصر plugins:sequence، على النحو التالي: 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. إذا أجريت أي تغييرات على الملف، فأعد تحميل التغييرات إلى مثيل Edge Microgateway قيد التشغيل. يعيد هذا الأمر ضبط إعدادات Edge Microgateway باستخدام وقت الاستراحة صفر: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    المكان:

    • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
    • env هي بيئة في مؤسستك (مثل test أو prod).
    • key هو المفتاح الذي يعرضه الأمر Configuration سابقًا.
    • secret هو المفتاح الذي يعرضه الأمر Configuration سابقًا.

    مثال

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d

4. الاتصال بواجهة برمجة التطبيقات بأمان

مع وجود رمز الدخول في متناول اليد، يمكنك الآن إجراء طلب بيانات من واجهة برمجة التطبيقات بشكل آمن. مثال:

  curl -i -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhcHBsaWNhdGlvbl
9uYW1lIjoiYmU2YmZjYjAtMWQ0Ni00Y2IxLWFiNGQtZTMxNzRlNTAyMDZkIiwiY2xpZW50X2lkIjoiOGxTTTVIRHdyM
VhIT1ZwbmhURExhYW9FVG5STVpwWk0iLCJzY29wZXMiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIk1pY3JvZ2F0ZXdh
eVRlQcm9kdWN0Il0sImCI6MTQzNTM0NzY5MiwiZXhwIjoxNDM1MzQ5NDkxfQ.PL30Y6uK1W1f2ONPEsBDB_BT31c6
IsjWGfwpz-p6Vak8r767tAT4mQAjuBpQYv7_IU4DxSrnxXQ_q536QYCP4p4YKfBvyqbnW0Rb2CsPFziy_n8HIczsWO
s0p4czcK63SjONaUpxV9DbfGVJ_-WrSdqrqJB5syorD2YYJPSfrCcgKm-LpJc6HCylElFDW8dHuwApaWcGRSV3l5Wx
4A8Rr-WhTIxDTX7TxkrfI4THgXAo37p3au3_7DPB_Gla5dWTzV4j93xLbXPUbwTHzpaUCFzmPnVuYM44FW5KgvBrV0
64RgPmIFUxSqBWGQU7Z1w2qFmWuaDljrMDoLEreI2g" http://localhost:8000/hello/echo

تعرض واجهة برمجة التطبيقات الرؤوس والمعلومات الأخرى من الخادم الوهمي.

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

إذا كنت تريد استخدام مفتاح واجهة برمجة التطبيقات للتفويض، يُرجى اتّباع الخطوات التالية:

1. الحصول على مفتاح واجهة برمجة التطبيقات

  1. في واجهة مستخدم Edge، انتقِل إلى "تطبيق المطوِّر" الذي أنشأته سابقًا. وكان اسم التطبيق EdgeMicroTestApp.
  2. في صفحة تطبيق المطوِّر، اعرض مفتاح العميل وانسخه. هذه القيمة هي مفتاح واجهة برمجة التطبيقات. ستستخدم هذا المفتاح لإجراء طلبات بيانات من واجهة برمجة التطبيقات تمت مصادقتها.

2. التحقّق من الإعدادات في Edge Microgateway

  1. افتح الملف $HOME/.edgemicro/org-env-config.yaml. راجِع مكان تثبيت Edge Microgateway إذا لم تتمكّن من تحديد موقع هذا الملف.
  2. يمكنك التأكُّد من ضبط خصائص مكوّن Oauth الإضافي على false. وهي خاطئة تلقائيًا، ولكن يمكنك التحقّق منها مجددًا: 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. في ملف org-env-config.yaml أيضًا، تأكَّد من إضافة المكوِّن الإضافي لبروتوكول oauth إلى العنصر plugins:sequence، على النحو التالي: 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. إذا أجريت أي تغييرات على الملف، فأعد تحميل التغييرات إلى مثيل Edge Microgateway قيد التشغيل. يعيد هذا الأمر ضبط إعدادات Edge Microgateway باستخدام وقت الاستراحة صفر: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    المكان:

    • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
    • env هي بيئة في مؤسستك (مثل test أو prod).
    • key هو المفتاح الذي يعرضه الأمر Configuration سابقًا.
    • secret هو المفتاح الذي يعرضه الأمر Configuration سابقًا.

    مثال

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c30177d64a88754d615c74e1f78b6181d

3. طلب بيانات من واجهة برمجة التطبيقات بأمان باستخدام مفتاح واجهة برمجة التطبيقات

استدعِ واجهة برمجة التطبيقات باستخدام العنوان x-api-key على النحو التالي. قيمة مفتاح المستهلك التي نسختها من "تطبيق المطوّر" هي مفتاح واجهة برمجة التطبيقات. بشكل تلقائي، يتوقع منك Edge Microgateway استخدام المفتاح في عنوان يُسمى x-api-key على النحو التالي:

curl -i http://localhost:8000/hello/echo -H "x-api-key: [apikey]"

المكان:

  • apikey هي قيمة مفتاح المستهلك المأخوذة من EdgeMicroTestApp.

مثال:


curl -i http://localhost:8000/hello/echo -H 'x-api-key: XsU1R4zGXz2ERxd0ilYQ5szwuljr5bB'

أصبح لديك الآن طريق Edge Microgateway يعمل بشكل كامل وآمن. في الجزء التالي من البرنامج التعليمي، سنلقي نظرة على المكوّنات الإضافية التي تضيف وظائف إلى Edge Microgateway.

الجزء 5: إضافة المكوِّن الإضافي لمنع Spike

سنضيف في هذا الجزء ميزة تحدّ من معدّل الإرسال تُعرف باسم "توقف الارتفاع المفاجئ" في مثيل Edge Microgateway.

ما هي المكوّنات الإضافية؟

المكون الإضافي هو وحدة Node.js التي تضيف وظائف إلى Edge Microgateway. تتبع وحدات المكوّنات الإضافية نمطًا ثابتًا ويتم تخزينها في مكان معروف باسم Edge Microgateway، ما يتيح للبوابة المصغّرة رصد هذه الوحدات وتحميلها تلقائيًا. يمكنك الاطّلاع على المزيد من المعلومات حول المكوّنات الإضافية في القسم استخدام المكوّنات الإضافية.

إضافة مكوِّن إضافي لإيقاف أحداث الارتفاع المفاجئ

يوفر المكوِّن الإضافي لإيقاف الارتفاع الحماية من الارتفاع المفاجئ في عدد الزيارات. وتزيد من عدد الطلبات التي تتم معالجتها بواسطة مثيل Edge Microgateway.

في Edge Microgateway، يتم تنفيذ توقف أحداث الارتفاع كوحدة مكوّن إضافي. لتفعيله، يجب إضافته إلى ملف إعداد Edge Microgateway.

  1. افتح الملف $HOME/.edgemicro/org-env-config.yaml.أين تم تثبيت Edge Microgateway إذا لم تتمكن من تحديد موقع هذا الملف.
  2. أضف العنصر التالي. يمكنك إضافته إلى أي مكان في الملف. 
       spikearrest:
      timeUnit: minute   
      allow: 10   
      buffersize: 0
  3. أضِف spikearrest إلى العنصر edgemicro:sequence على النحو الموضّح أدناه. توضِّح خاصية إعداد التسلسل طريقة تنفيذ وحدات المكوّن الإضافي لبرنامج Edge Microgateway. 
    edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
  sequence:
    - oauth
    - spikearrest
  4. احفظ ملف الإعداد.
  5. أعِد تحميل Edge Microgateway باستخدام الأمر reload. يجب تشغيل هذا الأمر من الدليل الذي بدأت فيه Edge Microgateway. 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    المكان:

    • org هو اسم مؤسستك في Edge (يجب أن تكون مشرف مؤسسة).
    • env هي بيئة في مؤسستك (مثل test أو prod).
    • key هو المفتاح الذي يعرضه الأمر Configuration سابقًا.
    • secret هو المفتاح الذي يعرضه الأمر setup (الضبط).

    مثال

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d
  6. جرِّب طلب بيانات من واجهة برمجة التطبيقات عدة مرات بتتابع سريع. بعد المكالمة الثانية، يعرض Edge Microgateway هذا الخطأ: 
    {"message":"SpikeArrest engaged","status":503}

ويرجع السبب في ذلك إلى أنّ الإيقاف الزائد يخفّف من عدد المكالمات التي يمكن إجراؤها خلال الوحدة الزمنية المحدّدة. في هذه الحالة، يمكنك إجراء 10 مكالمات في الدقيقة، أو مكالمة واحدة كل 6 ثوانٍ.

الرصيد الإضافي: إضافة المكوِّن الإضافي للحصة

باتباع النمط نفسه المستخدَم لضبط إيقاف تشغيل المحتوى المتزايد، يمكنك إضافة مكوِّنات إضافية أخرى، مثل المكوّن الإضافي quota. كما هو الحال مع حد التوقف المؤقت، يتم تضمين المكوّن الإضافي للحصة مع كل عملية تثبيت لبرنامج Edge Microgateway. تحدّد الحصة عدد رسائل الطلبات التي يُسمح للتطبيق بإرسالها إلى واجهة برمجة التطبيقات خلال فترة زمنية محددة (بالدقائق أو الساعات).

الجزء 6: عرض الإحصاءات على Apigee Edge

لدينا الآن مثيل Edge Microgateway يعمل بكامل وظائفه، لذا لنرَ ما الأمر. وبشكل تلقائي، تتم إضافة وحدة المكوّن الإضافي لتحليل البيانات إلى Edge Micro. وستنقل هذه الوحدة تلقائيًا بيانات الإحصاءات من Edge Micro إلى حافة Apigee، حيث يستهلكها نظام Edge Analytics. لنرى:

  1. سجِّل الدخول إلى مؤسستك على Apigee Edge.
  2. اختَر إحصاءات Google > أداء الخادم الوكيل.
  3. في لوحة بيانات أداء الخادم الوكيل، اختَر edgemicro_hello الوكيل.
  4. يعرض لك الرسم البياني معلومات عن أنماط زيارات الخادم الوكيل، مثل إجمالي عدد الزيارات ومتوسط وقت الاستجابة ومتوسط وقت الاستجابة المستهدَف وغير ذلك.

يمكنك الاطّلاع على المزيد من المعلومات حول لوحات بيانات Edge Analytics على الصفحة الرئيسية للوحات بيانات "إحصاءات Google" ضمن مستندات Edge. لمزيد من المعلومات حول المكوّنات الإضافية، يمكنك الاطّلاع على استخدام المكوّنات الإضافية.