مرجع CLI برای Edge Microgateway

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

Edge Microgateway v. 3.3.x

نمای کلی

«میانای خط فرمان Edge Microgateway» به شما امکان می‌دهد همه جنبه‌های نمونه Edge Microgateway را کنترل و مدیریت کنید.

مدیریت گواهینامه‌ها

فرمان‌های cert به شما امکان می‌دهد جفت کلید عمومی/خصوصی را که برای امضای توکن‌های حامل استفاده می‌شود نصب و مدیریت کنید. مشتریان از این توکن‌ها برای برقراری تماس‌های ایمن ازطریق «ریزدروازه Edge» استفاده می‌کنند. کلیدها در Apigee Edge در «نقشه مقدار کلید» (KVM) رمزگذاری‌شده ذخیره می‌شوند. ‫Edge Microgateway از کلید عمومی برای اعتبارسنجی نشان‌های حامل امضاشده استفاده می‌کند. این کلیدها زمانی تولید می‌شوند که فرمان پیکربندی edgemicro را اجرا می‌کنید، همان‌طور که در راه‌اندازی و پیکربندی 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» را قادر می‌سازد با نمونه 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 قرار دارد. (افزوده‌شده در نسخه ۲.۴.x)
-x, --proxyName (اختیاری) مسیر پایه را برای پراکسی edgemicro-auth تنظیم می‌کند. اگر پراکسی edgemicro-auth تحت مسیری متفاوت از مسیر پیش‌فرض، /edgemicro-auth، مستقر شده باشد، این ویژگی به شما امکان می‌دهد مسیر جدید را در Edge Microgateway تنظیم کنید. به‌طور پیش‌فرض، مسیر پایه /edgemicro-auth است. (افزوده‌شده نسخه ۲.۴.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 برای احراز هویت خود هنگام پست کردن ناهمزمان داده‌های Analytics در 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 اطلاعات استفاده از برونداد.

یادداشت‌های استفاده

درصورت موفقیت، فرمان سه مورد را برمی‌گرداند. اولین مورد نشانی وبی است که باید در فایل پیکربندی قرار دهید. دو مورد دیگر جفت کلیدی هستند که هنگام شروع نمونه Edge Microgateway موردنیاز هستند.

  • نشانی وب bootstrap: این نشانی وب به سرویس Apigee Edge اشاره می‌کند که به نمونه Edge Microgateway امکان می‌دهد داده‌های تجزیه‌وتحلیل را به Apigee Edge ارسال کند. باید آن نشانی وب را در فایل پیکربندی Edge Microgateway کپی کنید: ~/.edgemicro/org-env-config.yaml.
  • کلید: کلید. این کلید و رمز به‌عنوان ورودی فرمان CLI که برای شروع نمونه Edge Microgateway استفاده می‌شود لازم است.
  • رمز: رمز.

مثال

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 نشانی وب زمان اجرا را برای نمونه ابر خصوصی شما مشخص می‌کند.
-m, --mgmt-url نشانی وب سرور مدیریت برای نمونه ابر خصوصی شما.
-v, --virtualHosts فهرست جداشده با کاما از میزبان‌های مجازی برای سازمان:محیط. پیش‌فرض «default,secure».
-c, --configDir (اختیاری) مسیر فایل پیکربندی Edge Microgateway را مشخص می‌کند. به‌طور پیش‌فرض، فایل پیکربندی در ./config/config.yaml قرار دارد. (افزوده‌شده در نسخه ۲.۴.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 را ملغی می‌کند. پیش‌فرض: ۸۰۰۰
-c, --cluster

(اختیاری) «دروازه کوچک Edge» را در حالت خوشه‌ای شروع می‌کند.

توجه: از نسخه ۲.۳.۱، این گزینه برداشته شده است. در نسخه ۲.۳.۱ و نسخه‌های جدیدتر، Edge Micro همیشه در حالت خوشه‌ای شروع می‌شود.

-c, --configDir (اختیاری) مسیر فایل پیکربندی Edge Microgateway را مشخص می‌کند. به‌طور پیش‌فرض، فایل پیکربندی در ./config/config.yaml قرار دارد. (افزوده‌شده در نسخه ۲.۴.x)
-u, --configUrl (اختیاری) نقطه‌پایانی را مشخص می‌کند که Edge Microgateway فایل پیکرببندی خود را از آن بارگیری می‌کند. (به نسخه ۲.۵.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) رمزگشایی می‌کند. رمز اطلاعاتی درباره برنامه توسعه‌دهنده 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: '' }

تولید کد

یک کد حامل امضاشده تولید می‌کند. این کد به برنامه‌های کارخواه اجازه می‌دهد تا تماس‌های API اصالت‌سنجی‌شده با Edge Microgateway برقرار کنند. این کد یک «کد وب JSON» (JWT) سازگار با OAuth 2.0 است. این ابزار به مقادیر «کلید مصرف‌کننده» (شناسه کارخواه) و «رمز مصرف‌کننده» (رمز کارخواه) از برنامه توسعه‌دهنده ثبت‌شده در 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-aware شما.
-s, --secret «رمز کارخواه» از برنامه «توسعه‌دهنده» منسوب به پراکسی Microgateway-aware شما.
-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' }

همچنین می‌توانید بااستفاده از API مدیریت، یک JWT تولید کنید:

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 محیطی در سازمان شما است (مثلاً «test» یا «prod»).
  • ‫$CLIENT_ID «شناسه مصرف‌کننده» در «برنامه توسعه‌دهنده» است که قبلاً ساخته‌اید.
  • ‫$CLIENT_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 قرار دارد. (افزوده‌شده در نسخه ۲.۴.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 خود مستقر کرده باشید. (به نسخه ۲.۵.x اضافه شد)

توجه: اگر نمونه Edge Micro کنونی‌تان را قبل‌از نسخه ۲.۵.۲ پیکربندی کرده‌اید، اگر می‌خواهید از چرخش کلید استفاده کنید باید این پراکسی را ارتقا دهید. فقط یک‌بار باید این ارتقا را انجام دهید.

استفاده

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. پیش‌فرض نشانی وب پایه برای استقرار ابری Apigee‏ api.enterprise.apigee.com است. برای استقرار در محل، نشانی وب پایه ممکن است متفاوت باشد.

مثال

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 نشانی وب کارگزار نیابتی 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 از آن استفاده می‌کند. (اضافه‌شده در ۳.۱.۶)
-c مسیر گواهینامه سفارشی که Apigee Edge از آن استفاده می‌کند. (اضافه‌شده در ۳.۱.۶)
-n, --nbf

تأخیر را برحسب دقیقه برای مؤثر شدن کلید خصوصی جدید پیکربندی کنید. این تأخیر به نمونه‌های دروازه کوچک زمان می‌دهد تا با کلید عمومی جدید بازآوری شوند. بهتر است تأخیر را بیشتر از تنظیم پیکربندی config_change_poll_internal تنظیم کنید، که به‌طور پیش‌فرض ۱۰ دقیقه است. برای اطلاعات بیشتر، پیکربندی تأخیر «نه قبل‌از» را ببینید. (اضافه‌شده در ۳.۱.۶)

توجه: اگر از این گزینه با نسخه‌های edgemicro-auth قدیمی‌تر از نسخه توزیع‌شده با Edge Microgateway 3.1.6 استفاده کنید، پرچم نادیده گرفته می‌شود.

-i, --kid (اختیاری) شناسه‌ای که برای مطابقت دادن کلید خاصی استفاده می‌شود. ‫Edge Microgateway از این مقدار برای انتخاب از میان مجموعه‌ای از کلیدها درطول چرخش کلید استفاده می‌کند. اگر این پارامتر حذف شود (توصیه‌شده)، Edge Microgateway کلیدی مبتنی بر مُهر زمان تولید می‌کند. برای اطلاعات بیشتر، به «بخش ۴.۵» از مشخصات «کلید وب JSON» مراجعه کنید.
-r, --rotatekeyuri ‫URI کلید را بچرخانید.

«فضای ابری عمومی لبه‌ای»: اختیاری.
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 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 (یا -u یا -t لازم است) نام کاربری Apigee شما. باید سرپرست سازمان برای سازمان مشخص‌شده باشید. اگر به‌جای آن پارامتر -t را مشخص کنید، این پارامتر الزامی نیست.
-p, --password (اختیاری) گذرواژه شما. اگر این پارامتر را در خط فرمان ارائه ندهید، از شما خواسته می‌شود آن را ارائه دهید.
-k, --key (الزامی) کلید لغو.
-s, --secret (الزامی) رمز برای باطل کردن.
-t, --token (-u یا -t الزامی است) به شما امکان می‌دهد به‌جای نام کاربری/گذرواژه از کد OAuth برای اصالت‌سنجی استفاده کنید. اگر -t مشخص شده باشد، پارامتر -u الزامی نیست. همچنین تماس‌های ایمن با میانای برنامه‌سازی کاربردی با کد دسترسی OAuth2 را ببینید. برای مثال:
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

نمونه‌ها

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

درصورت موفقیت، پیام زیر را خواهید دید:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully