مرجع واجهة سطر الأوامر (CLI) لـ Edge Microgateway

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

الإصدار 3.2.x من Edge Microgateway

نظرة عامة

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

إدارة الشهادات

تتيح لك أوامر cert تثبيت وإدارة مفاتيح التشفير العلنية أو الخاصة المستخدَمة لتوقيع الرموز المميزة لحاملها التي تستخدمها البرامج لتنفيذ مكالمات آمنة من خلال Edge Microgateway. يتم تخزين المفاتيح على Apigee Edge في "خريطة قيم المفاتيح" (KVM) مشفّرة. يستخدم Edge Microgateway المفتاح العام للتحقّق من صحة الرموز المميزة لحامل التوقيع. يتم إنشاء هذه المفاتيح عند تنفيذ الأمر edgemicro configure، كما هو موضّح في إعداد Edge Microgateway وضبطه. يمكنك استخدام أوامر cert الموضّحة هنا لإعادة إنشاء هذه المفاتيح وإدارتها إذا لزم الأمر.

تثبيت شهادة

تثبِّت هذه السياسة المفاتيح في "خريطة قيم المفاتيح" (KVM) مشفَّرة وتعرض المفتاح العام كنتيجة. يتم تحديد نطاق مفاتيح التشفير لمؤسسة معيّنة.

الاستخدام

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-f, --force (اختياري) إذا كان المفتاح مخزّنًا في جهاز KVM المشفّر، يمكنك فرض استبداله.
-h, --help معلومات استخدام الناتج

مثال

edgemicro cert install -o docs -e test -u jdoe@example.com -f

الناتج

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

حذف شهادة

تحذف هذه الطريقة زوج المفاتيح الخاص بمؤسسة.

الاستخدام

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-h, --help معلومات استخدام الناتج

مثال

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

الناتج

deleting vault
Vault deleted!

الاطّلاع على شهادة

يتحقّق هذا الإعداد مما إذا كانت مؤسستك قد ثبّتت شهادة.

الاستخدام

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-h, --help معلومات استخدام الناتج

مثال

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

الناتج (نجاح)

checked cert successfully

الناتج (تعذُّر)

إذا لم تكن الشهادة متوفّرة، سيتم عرض رسالة خطأ.

الحصول على المفتاح العام

تعرض هذه الطريقة المفتاح العام للمؤسسة المحدّدة. لا يتطلّب إجراء مصادقة.

الاستخدام

edgemicro cert public-key -o [organization] -e [environment]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway.
-h, --help عرض معلومات الاستخدام

مثال

edgemicro cert public-key -o docs -e test

الناتج (مثال)

-----BEGIN CERTIFICATE-----

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=?

-----END CERTIFICATE-----

إعداد Edge Microgateway لخدمة Apigee Edge Cloud

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

الاستخدام

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-r, --url (اختياري) تحدّد هذه السمة الاسم المستعار للمضيف الافتراضي الخاص بمؤسستك:البيئة. يمكنك الاطّلاع على مستندات Edge للتعرّف على المضيفات الافتراضية. القيمة التلقائية: org-env.apigee.net
-c, --configDir (اختياري) تحدّد هذه السمة المسار إلى ملف إعداد Edge Microgateway. يكون ملف الإعدادات تلقائيًا في ./config/config.yaml. (تمت إضافة هذه الميزة في الإصدار 2.4.x)
-x, --proxyName (اختياري) يضبط المسار الأساسي لخادم وكيل edgemicro-auth. إذا تم نشر وكيل edgemicro-auth ضمن مسار مختلف عن المسار التلقائي، /edgemicro-auth، تتيح لك هذه الميزة ضبط المسار الجديد في Edge Microgateway. تكون قيمة basepath التلقائية هي /edgemicro-auth. (تمت الإضافة في الإصدار 2.4.x)
-t, --token (اختياري) يتيح لك استخدام رمز مميّز OAuth للمصادقة بدلاً من اسم المستخدم/كلمة المرور. يمكنك أيضًا الاطّلاع على إجراء طلبات آمنة من واجهة برمجة التطبيقات باستخدام رمز دخول OAuth2. على سبيل المثال:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (اختياري) يتجاوز المضيفات الافتراضية التلقائية، وهي "default,secure". استخدِم هذا الخيار إذا كانت لديك مضيفات افتراضية محدّدة لبيئة مؤسسة Edge غير هذه الإعدادات التلقائية. راجِع مستندات Edge للتعرّف على المضيفات الافتراضية.
-d, --debug (اختياري) يقدّم معلومات تصحيح الأخطاء.
-h, --help معلومات استخدام الناتج

ملاحظات الاستخدام

يخزّن هذا الأمر معلومات الإعداد في ~/.edgemicro/org-env-config.yaml.

مثال

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

الناتج

عند النجاح، يعرض الأمر مجموعة من المفاتيح التي عليك استخدامها عند بدء Edge Microgateway.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

إنشاء المفاتيح

ينشئ الأمر genkeys مفتاح العميل مع المفتاح السرّي تستخدمه Edge Microgateway لإثبات ملكيتها عند نشر بيانات الإحصاءات بشكل غير متزامن إلى Apigee Edge.

الاستخدام

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-t, --token (اختياري) يتيح لك استخدام رمز مميّز OAuth للمصادقة بدلاً من اسم المستخدم/كلمة المرور. يمكنك أيضًا الاطّلاع على إجراء طلبات آمنة من واجهة برمجة التطبيقات باستخدام رمز دخول OAuth2. على سبيل المثال:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help عرض معلومات الاستخدام

ملاحظات الاستخدام

عند النجاح، يعرض الأمر ثلاثة عناصر. الأول هو عنوان URL عليك وضعه في ملف الإعداد. أما الاثنان الآخران، فهما عبارة عن زوج مفاتيح مطلوب عند بدء تشغيل مثيل Edge Microgateway.

  • عنوان URL الخاص بالتشغيل: يشير عنوان URL هذا إلى خدمة Apigee Edge التي تتيح لمثيل Edge Microgateway إرسال بيانات الإحصاءات إلى Apigee Edge. عليك نسخ عنوان URL هذا إلى ملف إعداد Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
  • المفتاح: المفتاح هذا المفتاح والسري مطلوبان كمدخل لأمر واجهة سطر الأوامر (CLI) المستخدَم لبدء مثيل من Edge Microgateway.
  • استبدِل secret بالرمز السري.

مثال

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

الناتج (مثال)

عند النجاح، يعرض الأمر مجموعة من المفاتيح التي عليك استخدامها عند بدء Edge Microgateway.

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

إعداد Edge Microgateway لـ Apigee Edge Private Cloud

يضبط هذا الخيار Edge Microgateway للعمل مع عملية تثبيت Apigee Edge Private Cloud.

الاستخدام

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-r, --runtime-url تحدّد هذه السمة عنوان URL لوقت التشغيل الخاص بمثيل السحابة الإلكترونية الخاصة.
-m, --mgmt-url عنوان URL الخاص بخادم الإدارة لآلة السحابة الخاصة الافتراضية
-v, --virtualHosts قائمة قيم مفصولة بفاصلة للمضيفات الافتراضية لمؤسستك:البيئة. Default "default,secure".
-c, --configDir (اختياري) تحدّد هذه السمة المسار إلى ملف إعداد Edge Microgateway. يكون ملف الإعدادات تلقائيًا في ./config/config.yaml. (تمت إضافة هذه الميزة في الإصدار 2.4.x)
-t, --token (اختياري) يتيح لك استخدام رمز مميّز OAuth للمصادقة بدلاً من اسم المستخدم/كلمة المرور. يمكنك أيضًا الاطّلاع على إجراء طلبات آمنة من واجهة برمجة التطبيقات باستخدام رمز دخول OAuth2. على سبيل المثال:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (اختياري) يقدّم معلومات تصحيح الأخطاء.
-h, --help معلومات استخدام الناتج

ملاحظات الاستخدام

يخزّن هذا الأمر معلومات الإعداد في ~/.edgemicro/org-env-config.yaml.

مثال

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

الناتج

عند النجاح، يعرض الأمر مجموعة من المفاتيح التي عليك استخدامها عند بدء Edge Microgateway.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

بدء Edge Microgateway

قبل بدء Edge Microgateway، يجب أولاً تشغيل edgemicro configure (السحابة الإلكترونية العامة) أو edgemicro private configure (السحابة الإلكترونية الخاصة). يعرض الأمر configure قيمتَي المفتاح والسرّ المطلوبتَين لبدء Edge Microgateway.

الاستخدام

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-k, --key قيمة المفتاح التي يتم إرجاعها عند تنفيذ الأمر "edgemicro configure".
-s, --secret قيمة المفتاح السرّي التي يتم عرضها عند تنفيذ الأمر "edgemicro configure"
-p, --processes (اختياري) عدد العمليات التي سيتم بدؤها القيمة التلقائية: عدد النوى في نظامك.
-d, --pluginDir (اختياري) المسار المطلق إلى دليل المكوّن الإضافي.
-r, --port (اختياري) يتم تجاهل رقم المنفذ المحدّد في ملف ~/.edgemicro/org-env-config.yaml. القيمة التلقائية: 8000
-c, --cluster

(اختياري) يبدأ Edge Microgateway في وضع المجموعة.

ملاحظة: تمت إزالة هذا الخيار اعتبارًا من الإصدار 2.3.1. في الإصدار 2.3.1 والإصدارات الأحدث، يبدأ Edge Micro دائمًا في وضع المجموعة.

-c, --configDir (اختياري) تحدّد هذه السمة المسار إلى ملف إعداد Edge Microgateway. يكون ملف الإعدادات تلقائيًا في ./config/config.yaml. (تمت إضافة هذه الميزة في الإصدار 2.4.x)
-u, --configUrl (اختياري) تحدّد نقطة نهاية سيتم منها تنزيل ملف الإعدادات في Edge Microgateway. (تمت الإضافة في الإصدار 2.5.x)
-d, --debug (اختياري) يقدّم معلومات تصحيح الأخطاء.
-h, --help عرض معلومات الاستخدام

ضبط المنفذ

يتيح لك الأمر start تحديد رقم منفذ لتجاوز المنفذ المحدّد في ملف الإعداد. يمكنك أيضًا تحديد رقم منفذ باستخدام متغيّر البيئة PORT. على سبيل المثال:

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

أو

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

إذا كان المنفذ قيد الاستخدام، ستعرض Edge Microgateway رسالة خطأ.

لمحة عن التجميع

يستخدم Edge Microgateway وحدة تجميع Node.js لتفعيل التجميع. تتيح عملية التجميع الاستفادة من أنظمة متعددة النواة في Edge Microgateway. لمعرفة التفاصيل، يُرجى الاطّلاع على مستندات Node.js هذه.

مثال

edgemicro start -o docs -e test -k abc123 -s xyz456

مثال على الناتج:

...

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
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

إدارة الرموز المميّزة

تتيح لك أوامر token الحصول على رموز الدخول الموقّعة عبر OAuth2 وفك تشفيرها والتحقّق منها. يمكنك أيضًا الاطّلاع على إجراء طلبات آمنة من واجهة برمجة التطبيقات باستخدام رمز دخول OAuth2.

فك ترميز رمز مميّز

يفكّ ترميز رمز مميّز موقَّع ومشفَّر إلى تمثيله بنص عادي بتنسيق JSON JWT (Java Web Token). يحمل الرمز المميّز معلومات حول تطبيق المطوّر على Apigee Edge الذي وفّر المفاتيح المستخدَمة لإنشاء الرمز المميّز، بما في ذلك اسم التطبيق وclient_id وقائمة المنتجات وغير ذلك.

الاستخدام

edgemicro token decode -f [filename]

المعلّمات

المعلمات الوصف
-f, --file اسم ملف يحتوي على رمز JWT المميّز لفك تشفيره
-h, --help معلومات استخدام الناتج

مثال

edgemicro token decode -f token.jwt

الناتج (مثال)

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

إنشاء رمز مميّز

تنشئ هذه الدالة رمزًا مميزًا موقَّعًا لحامل الإذن. يسمح الرمز المميز لتطبيقات العميل بإجراء طلبات مصادقة لواجهة برمجة التطبيقات إلى Edge Microgateway. الرمز المميّز هو رمز JSON مميّز للويب (JWT) متوافق مع OAuth 2.0. يتطلّب ذلك إدخال قيمتَي &quot;مفتاح المستهلك&quot; (معرّف العميل) و&quot;سر المستهلك&quot; (سر العميل) من تطبيق مطوّر مسجّل على Apigee Edge. يمكنك أيضًا الاطّلاع على تأمين طلبات البيانات من واجهة برمجة التطبيقات باستخدام رمز دخول OAuth2.

الاستخدام

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-1, --key معرّف العميل من تطبيق المطوّر المرتبط بخادم وكيل متوافق مع Microgateway
-s, --secret سرّ العميل من تطبيق المطوّر المرتبط بخادم وكيل متوافق مع Microgateway
-h, --help عرض معلومات الاستخدام

مثال

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

الناتج (مثال)

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

يمكنك أيضًا إنشاء رمز JWT باستخدام Management API:

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

المكان:

  • $ORG هو اسم مؤسسة Edge (يجب أن تكون مشرف مؤسسة).
  • $ENV هي بيئة في مؤسستك (مثل "اختبار" أو "إنتاج").
  • $CLIENT_ID هو رقم تعريف المستهلك في تطبيق المطوّر الذي أنشأته سابقًا.
  • $CLIENT_SECRET هو Consumer Secret في تطبيق المطوّر الذي أنشأته سابقًا.

تأكيد رمز مميّز

تتحقّق هذه السياسة من صحة رمز مميّز موقَّع لحامل الشهادة باستخدام المفتاح العام المخزَّن على Apigee Edge للمؤسسة والبيئة المحدّدتين.

الاستخدام

edgemicro token verify -o [org] -e [env] -f [filename]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-f, --file اسم ملف يحتوي على رمز JWT المطلوب التحقّق منه
-h, --help معلومات استخدام الناتج

مثال

edgemicro token get -o docs -e test -f token.jwt

مثال على الناتج لرمز مميّز صالح

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

نموذج الإخراج لرمز مميز غير صالح

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

مثال على الناتج لرمز مميز منتهي الصلاحية

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

بدء إعداد جديد لـ Edge Microgateway

نفِّذ هذا الأمر مرة واحدة بعد تثبيت Edge Microgateway لأول مرة. ينشئ ملف إعداد تلقائيًا جديدًا: ~/.edgemicro/default.yaml.

الاستخدام

edgemicro init

المعلّمات

المعلمات الوصف
-c, --configDir (اختياري) تحدّد هذه السمة المسار إلى ملف إعداد Edge Microgateway. يكون ملف الإعدادات تلقائيًا في ./config/config.yaml. (تمت إضافة هذه الميزة في الإصدار 2.4.x)
-h, --help عرض معلومات الاستخدام

مثال

edgemicro init

الناتج (نجاح)

config initialized to /MyHome/.edgemicro/default.yaml

التحقّق من إعدادات Edge Microgateway

تتحقّق هذه السمة من إعداد Edge Microgateway بشكلٍ صحيح.

الاستخدام

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

المعلّمات

مثال

edgemicro verify -o docs -e test -k abc123 -s xyz456

الناتج (نجاح)

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

التحقّق من حالة مجموعة البوابات المصغّرة

يبدأ Edge Microgateway في وضع المجموعة تلقائيًا. يمكنك استخدام هذا الأمر للتحقّق من حالة المجموعة.

الاستخدام

edgemicro status

المعلّمات

المعلمات الوصف
-h, --help عرض معلومات الاستخدام

مثال

edgemicro status

الناتج (نجاح)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

إيقاف مجموعة البوابة المصغّرة

توقِف مجموعة Edge Microgateway.

الاستخدام

edgemicro stop

المعلّمات

المعلمات الوصف
-h, --help عرض معلومات الاستخدام

مثال

edgemicro stop

الناتج (نجاح)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

إعادة تحميل مجموعة البوابة المصغّرة

توفير إعادة تشغيل بدون توقّف بعد تغيير الإعدادات تعيد تحميل Edge Microgateway من خلال جلب إعدادات جديدة.

الاستخدام

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-k, --key قيمة المفتاح التي يتم إرجاعها عند تنفيذ الأمر "edgemicro configure".
-s, --secret قيمة المفتاح السرّي التي يتم عرضها عند تنفيذ الأمر "edgemicro configure"
-h, --help معلومات استخدام الناتج

مثال

edgemicro reload -o docs -e test -k abc123 -s xyz456

الناتج (نجاح)

...

Reload Completed Successfully

ترقية وكيل edgemicro-auth

لاستخدام تغيير المفتاح، يجب أن يكون لديك وكيل edgemicro-auth تمت ترقيته ومُنتشر في مؤسسة Apigee Edge. (تمت إضافة هذه الميزة في الإصدار 2.5.x)

ملاحظة: إذا سبق لك ضبط مثيل Edge Micro الحالي قبل الإصدار 2.5.2، عليك ترقية هذا الخادم الوكيل إذا أردت استخدام ميزة تدوير المفاتيح. ولن تحتاج إلى إجراء هذه الترقية سوى مرة واحدة.

الاستخدام

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-u, --username اسم مستخدم Apigee يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-v, --virtualhost (اختياري) المضيف الافتراضي للخادم الوكيل
-b, --baseuri (اختياري) معرّف الموارد المنتظم الأساسي لمؤسستك على Apigee Edge. القيمة التلقائية هي عنوان URI الأساسي لعمليات نشر السحابة الإلكترونية في Apigee، وهو api.enterprise.apigee.com. أما عمليات النشر المحلية، فقد يختلف عنوان URL الأساسي.

مثال

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

الناتج (نجاح)

عند النجاح، يعرض الأمر ناتجًا مشابهًا لما يلي:

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

ترقية "خريطة القيم الرئيسية" (KVM)

استخدِم الأمر edgemicro upgradekvm لترقية KVM في مؤسسة Apigee. يجب ترقية KVM إذا كنت تريد استخدام تدوير المفاتيح.

الاستخدام

‫Edge for Public Cloud:

edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]

‫Edge for Private Cloud:

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت Edge Microgateway لها.
-e, --env بيئة ضبطت فيها Edge Microgateway
-k, --key قيمة المفتاح التي يتم إرجاعها عند تنفيذ الأمر "edgemicro configure".
-s, --secret قيمة المفتاح السرّي التي يتم عرضها عند تنفيذ الأمر "edgemicro configure"
-p, --proxyuri معرّف الموارد المنتظم (URI) لخادم وكيل edgemicro_auth

السحابة الإلكترونية العامة من Edge: اختياري.‫
Edge Private Cloud: مطلوبة.

مثال على Edge Public Cloud:

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

مثال على Edge Private Cloud:

-p 'https://[hostname]/edgemicro-auth'

مثال

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

الناتج (نجاح)

عند النجاح، يعرض الأمر ناتجًا مشابهًا لما يلي:

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

تدوير المفاتيح

استخدِم الأمر edgemicro rotatekey لتدوير أزواج المفاتيح العامة والخاصة التي تم استخدامها لإنشاء رموز JWT المميزة المستخدَمة في أمان OAuth على Edge Microgateway.

لمزيد من المعلومات، يُرجى الاطّلاع على تدوير مفاتيح JWT.

الاستخدام

‫Edge for Public Cloud:

edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]

‫Edge for Private Cloud:

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

المعلّمات

المعلمات الوصف
-o, --org (مطلوب) مؤسسة Apigee التي أعددت Edge Microgateway لها.
-e, --env (مطلوب) بيئة أعددت Edge Microgateway لها.
-k, --key قيمة المفتاح التي يتم إرجاعها عند تنفيذ الأمر "edgemicro configure".
-s, --secret قيمة المفتاح السرّي التي يتم عرضها عند تنفيذ الأمر "edgemicro configure"
-p مسار إلى مفتاح خاص مخصّص ستستخدمه Apigee Edge. (تمت الإضافة في الإصدار 3.1.6)
-c مسار شهادة مخصّصة سيتم استخدامها من قِبل Apigee Edge. (تمت الإضافة في الإصدار 3.1.6)
-n, --nbf

اضبط مدة التأخير بالدقائق لكي يصبح المفتاح الخاص الجديد ساريًا. يسمح هذا التأخير بتحديث مثيلات البوابة المصغّرة باستخدام المفتاح العام الجديد. من الممارسات الجيدة ضبط التأخير على قيمة أكبر من إعدادات config_change_poll_internal، وهي 10 دقائق تلقائيًا. لمزيد من المعلومات، يُرجى الاطّلاع على ضبط تأخير "ليس قبل". (تمت الإضافة في الإصدار 3.1.6)

ملاحظة: إذا كنت تستخدم هذا الخيار مع إصدارات من edgemicro-auth أقدم من الإصدار الموزّع مع Edge Microgateway 3.1.6، سيتم تجاهل العلامة.

-i, --kid (اختياري) معرّف يُستخدَم لمطابقة مفتاح معيّن. يستخدم Edge Microgateway هذه القيمة للاختيار من بين مجموعة من المفاتيح أثناء تدوير المفاتيح. في حال حذف هذه المَعلمة (وهو الإجراء الذي ننصح به)، تنشئ Edge Microgateway مفتاحًا مستندًا إلى الطابع الزمني. لمزيد من المعلومات، راجِع القسم 4.5 من مواصفات JSON Web Key.
-r, --rotatekeyuri معرّف الموارد المنتظم (URI) لتدوير المفتاح

‫Edge Public Cloud: اختيارية.‫
Edge Private Cloud: مطلوبة.

مثال على السحابة الإلكترونية العامة:

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

مثال على Edge Private Cloud:

-r '[hostname]/edgemicro-auth/rotateKey'

مثال

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

الناتج (نجاح)

عند النجاح، يعرض الأمر ناتجًا مشابهًا لما يلي:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

بعد التدوير، يمكنك الاطّلاع في واجهة مستخدم Edge على أنّه تمت إضافة مفاتيح جديدة إلى KVM الخاص ببوابة الخدمة المصغّرة.

مثال

يستخدم هذا المثال العلامتَين -p و-c لتحديد مسار مفتاح خاص/شهادة. تتيح لك هذه الخيارات تمرير زوج مخصّص من المفتاح الخاص والشهادة.

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

المراقبة الدائمة

استخدِم الأمر edgemicro forever لإدارة عملية Forever، وهي أداة Node.js تعيد تلقائيًا تشغيل تطبيق Node.js في حال تعذُّر تشغيل التطبيق أو حدوث خطأ فيه. اطّلِع أيضًا على المراقبة الدائمة.

الاستخدام

يجب ضبط متغيّرات البيئة التالية قبل تنفيذ الأمر edgemicro forever:

  • EDGEMICRO_ORG: مؤسسة Apigee التي أعددت Edge Microgateway لها.
  • EDGEMICRO_ENV: بيئة ضبطت فيها Edge Microgateway.
  • EDGEMICRO_KEY: هي قيمة المفتاح التي تم إرجاعها عند تنفيذ الأمر edgemicro configure.
  • EDGEMICRO_SECRET: هي قيمة المفتاح السرّي التي تم إرجاعها عند تنفيذ الأمر "edgemicro configure".
edgemicro forever -f [forever_file] -a [start|stop]

المعلّمات

المَعلمةالوصف
-f, --fileتحدّد هذه السمة موقع ملف forever.json.
-a, --actionإما start أو stop القيمة التلقائية هي "البداية".

أمثلة:

لبدء استخدام ميزة "الاستماع بلا توقّف"، اتّبِع الخطوات التالية:

edgemicro forever -f ~/mydir/forever.json -a start

لإيقاف Forever:

edgemicro forever -a stop

إبطال المفاتيح

استخدِم الأمر edgemicro revokekeys لإبطال بيانات الاعتماد الخاصة بالمفتاح والسريّة لإعداد Edge Microgateway.

الاستخدام

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

المعلّمات

المعلمات الوصف
-o, --org (مطلوب) مؤسسة Apigee التي أعددت Edge Microgateway لها.
-e, --env (مطلوب) بيئة أعددت Edge Microgateway لها.
-u, --username (مطلوب) اسم مستخدم Apigee. يجب أن تكون مشرف مؤسسة للمؤسسة المحدّدة.
-p, --password (اختياري) كلمة المرور سيُطلب منك تقديم هذه المَعلمة إذا لم تقدّمها في سطر الأوامر.
-k, --key (مطلوب) المفتاح المراد إبطاله.
-s, --secret (مطلوب) السر المطلوب إبطاله.

أمثلة

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

عند النجاح، ستظهر لك الرسالة التالية:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully