شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
میکروگیتوی اج نسخه ۳.۳.x
نمای کلی
رابط خط فرمان Edge Microgateway به شما امکان میدهد تمام جنبههای یک نمونه Edge Microgateway را کنترل و مدیریت کنید.
مدیریت گواهینامهها
دستورات cert به شما امکان میدهند جفت کلید عمومی/خصوصی را که برای امضای توکنهای حامل مورد استفاده توسط کلاینتها برای برقراری تماسهای امن از طریق Edge Microgateway استفاده میشود، نصب و مدیریت کنید. کلیدها در 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 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 | (اختیاری) نام مستعار میزبان مجازی را برای سازمان شما مشخص میکند:environment. برای کسب اطلاعات بیشتر در مورد میزبانهای مجازی، به مستندات 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 برای احراز هویت استفاده کنید. همچنین به بخش فراخوانیهای امن API با توکن دسترسی OAuth2 مراجعه کنید. برای مثال:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts | (اختیاری) میزبانهای مجازی پیشفرض را که " default,secure " هستند، لغو میکند. اگر میزبانهای مجازی دیگری غیر از این پیشفرضها برای Edge organization:environment خود مشخص کردهاید، از این گزینه استفاده کنید. برای کسب اطلاعات بیشتر در مورد میزبانهای مجازی، به مستندات 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 برای احراز هویت استفاده کنید. همچنین به بخش فراخوانیهای امن API با توکن دسترسی OAuth2 مراجعه کنید. برای مثال:edgemicro genkeys -o docs -e test -t <your token> |
-h, --help | اطلاعات استفاده خروجی. |
یادداشتهای استفاده
پس از موفقیت، دستور سه مورد را برمیگرداند. مورد اول یک URL است که باید در فایل پیکربندی قرار دهید. دو مورد دیگر یک جفت کلید هستند که هنگام شروع یک نمونه Edge Microgateway مورد نیاز هستند.
- آدرس بوتاسترپ : این آدرس به یک سرویس 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 | URL زمان اجرا را برای نمونه ابر خصوصی شما مشخص میکند. |
-m, --mgmt-url | آدرس اینترنتی (URL) سرور مدیریت برای نمونه ابر خصوصی شما. |
-v, --virtualHosts | فهرست میزبانهای مجازی برای سازمان شما:environment که با کاما از هم جدا شدهاند. پیشفرض " default,secure " است. |
-c, --configDir | (اختیاری) مسیر فایل پیکربندی Edge Microgateway را مشخص میکند. به طور پیشفرض، فایل پیکربندی در ./config/config.yaml قرار دارد. (نسخه ۲.۴.x اضافه شده است) |
-t, --token | (اختیاری) به شما امکان میدهد به جای نام کاربری/رمز عبور، از یک توکن OAuth برای احراز هویت استفاده کنید. همچنین به بخش فراخوانیهای امن API با توکن دسترسی 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، ابتدا باید دستور edgemicro configure (Public Cloud) یا edgemicro private configure (Private Cloud) را اجرا کنید. دستور 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 Microgateway را در حالت خوشهای (کلاستر) راهاندازی میکند. توجه: از نسخه ۲.۳.۱، این گزینه حذف شده است. در نسخه ۲.۳.۱ و نسخههای بعدی، 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 امضا شده را دریافت، رمزگشایی و تأیید کنید. همچنین به فراخوانیهای امن API با توکن دسترسی OAuth2 مراجعه کنید.
رمزگشایی یک توکن
یک توکن حامل امضا شده و کدگذاری شده را به نمایش JSON JWT (توکن وب جاوا) با متن ساده رمزگشایی میکند. یک توکن اطلاعاتی در مورد برنامه توسعهدهنده 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 Web Token (JWT) سازگار با OAuth 2.0 است. این توکن به عنوان ورودی، مقادیر Consumer Key (شناسه کلاینت) و Consumer Secret (راز کلاینت) را از یک برنامه توسعهدهنده ثبت شده در Apigee Edge درخواست میکند. همچنین به Secure API calls with an OAuth2 access token مراجعه کنید.
کاربرد
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 در حالت خوشهای (cluster mode) شروع به کار میکند. میتوانید از این دستور برای بررسی وضعیت خوشهای (cluster) استفاده کنید.
کاربرد
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
بارگذاری مجدد خوشه میکروگیتوی
پس از تغییر پیکربندی، راهاندازی مجدد بدون قطعی (zero downtime) را فراهم میکند. با وارد کردن پیکربندی جدید، 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 الزامی است.
کاربرد
لبه برای ابر عمومی:
edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]
لبه برای ابر خصوصی:
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 ابر عمومی لبه: اختیاری. ابر خصوصی لبه: الزامی مثال ابر عمومی لبه: -p 'https://[org]-[env].apigee.net/edgemicro-auth' مثال ابر خصوصی لبه: -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 مراجعه کنید.
کاربرد
لبه برای ابر عمومی:
edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]
لبه برای ابر خصوصی:
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 | تأخیر را بر حسب دقیقه برای فعال شدن کلید خصوصی جدید پیکربندی کنید. این تأخیر به نمونههای microgateway زمان میدهد تا با کلید عمومی جدید بهروزرسانی شوند. یک روش خوب این است که تأخیر را بیشتر از تنظیم پیکربندی توجه: اگر از این گزینه با نسخههای |
-i, --kid | (اختیاری) شناسهای که برای تطبیق با یک کلید خاص استفاده میشود. Edge Microgateway از این مقدار برای انتخاب از بین مجموعهای از کلیدها در طول چرخش کلید استفاده میکند. اگر این پارامتر حذف شود (توصیه میشود)، Edge Microgateway یک کلید مبتنی بر مهر زمانی تولید میکند. برای اطلاعات بیشتر، به بخش 4.5 از مشخصات JSON Web Key مراجعه کنید. |
-r, --rotatekeyuri | URL کلید چرخش. ابر عمومی لبه: اختیاری. ابر خصوصی لبه: الزامی مثال ابر عمومی: -r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey' مثال ابر خصوصی لبه: -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 الزامی نیست. همچنین به فراخوانیهای امن API با توکن دسترسی 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