شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
Edge Microgateway نسخه 3.1.x
نمای کلی
Edge Microgateway CLI به شما امکان می دهد تمام جنبه های یک نمونه Edge Microgateway را کنترل و مدیریت کنید.
مدیریت گواهی ها
دستورات cert به شما امکان می‌دهند جفت کلید عمومی/خصوصی را نصب و مدیریت کنید که برای امضای توکن‌های حامل مورد استفاده مشتریان برای برقراری تماس‌های ایمن از طریق Edge Microgateway استفاده می‌شود. کلیدها در Apigee Edge در یک نقشه ارزش کلیدی رمزگذاری شده (KVM) ذخیره می شوند. Edge Microgateway از کلید عمومی برای تأیید اعتبار توکن های حامل امضا شده استفاده می کند. این کلیدها هنگام اجرای دستور edgemicro configure تولید می شوند، همانطور که در راه اندازی و پیکربندی Edge Microgateway توضیح داده شده است. در صورت نیاز می توانید از دستورات گواهی که در اینجا توضیح داده شده است برای بازسازی و مدیریت این کلیدها استفاده کنید.
یک گواهی نصب کنید
کلیدها را در یک نقشه ارزش کلید رمزگذاری شده (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 تنظیم کنید. به طور پیش فرض، مسیر پایه /edgemicro-auth است. (نسخه 2.4.x اضافه شد) |
-t, --token | (اختیاری) به شما امکان می دهد به جای نام کاربری/رمز عبور از یک نشانه OAuth برای احراز هویت استفاده کنید. همچنین به تماس‌های ایمن API با نشانه دسترسی OAuth2 مراجعه کنید. به عنوان مثال:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts | (اختیاری) میزبان‌های مجازی پیش‌فرض را که « default,secure » هستند، لغو می‌کند. اگر میزبان‌های مجازی غیر از این پیش‌فرض‌ها برای سازمان Edge: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 مورد نیاز هستند.
- URL بوت استرپ : این URL به یک سرویس Apigee Edge اشاره می کند که یک نمونه Edge Microgateway را قادر می سازد تا داده های تحلیلی را به Apigee Edge ارسال کند. شما باید آن URL را در فایل پیکربندی 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 | فهرستی از میزبان های مجازی جدا شده با کاما برای سازمان شما: محیط زیست. پیش فرض " default,secure ". |
-c, --configDir | (اختیاری) مسیر فایل پیکربندی Edge Microgateway را مشخص می کند. به طور پیش فرض، فایل پیکربندی در ./config/config.yaml است. (نسخه 2.4.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
قبل از راه اندازی Edge Microgateway، ابتدا باید پیکربندی edgemicro (Public Cloud) یا پیکربندی edgemicro private (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 را لغو می کند. پیش فرض: 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 برای فعال کردن خوشه بندی استفاده می کند. Clustering به 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 (JWT) با OAuth 2.0 است. به عنوان ورودی، مقادیر کلید مصرف کننده (شناسه مشتری) و Consumer Secret (راز مشتری) را از یک برنامه توسعه دهنده ثبت شده در Apigee Edge نیاز دارد. همچنین به تماس‌های ایمن API با نشانه دسترسی 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 | Client Secret از برنامه Developer مرتبط با پروکسی 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' }
یک نشانه را تأیید کنید
یک توکن حامل امضا شده را در برابر کلید عمومی ذخیره شده در 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
وضعیت خوشه microgateway را بررسی کنید
به طور پیش فرض، 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
توقف خوشه microgateway
کلاستر 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
ارتقاء KVM
برای استفاده از چرخش کلید ، باید نقشه ارزش کلید ارتقا یافته را در سازمان Apigee Edge خود نصب کنید. (نسخه 2.5.x اضافه شد)
توجه: اگر نمونه Edge Micro فعلی خود را قبل از نسخه 2.5.2 پیکربندی کرده اید، باید KVM خود را برای استفاده از چرخش کلید ارتقا دهید. فقط یک بار باید این ارتقا را انجام دهید.استفاده
edgemicro upgradekvm -o [organization] -e [environment] -u [username]
پارامترها
| پارامترها | توضیحات |
|---|---|
-o, --org | سازمان Apigee که Edge Microgateway را برای آن پیکربندی کرده اید. |
-e, --env | محیطی که Edge Microgateway را برای آن پیکربندی کرده اید. |
-u, --username | نام کاربری Apigee شما. شما باید یک مدیر سازمان برای سازمان مشخص شده باشید. |
-p, --password | (اختیاری) رمز عبور شما. اگر این پارامتر را در خط فرمان ارائه نکنید، از شما خواسته می شود. |
-v, --virtualhost | (اختیاری) میزبان مجازی پروکسی. |
-t, --token | (اختیاری.) به شما امکان می دهد از یک نشانه OAuth برای احراز هویت به جای نام کاربری/رمز عبور استفاده کنید. همچنین به تماس‌های ایمن API با نشانه دسترسی OAuth2 مراجعه کنید. به عنوان مثال:edgemicro upgradekvm -o docs -e test -t <your token> |
-b, --baseuri | (اختیاری) URI پایه برای سازمان شما در Apigee Edge. پیش فرض URI پایه برای استقرار ابری Apigee api.enterprise.apigee.com است. برای استقرارهای داخلی، URL پایه ممکن است متفاوت باشد. |
مثال
edgemicro upgradekvm -o docs -e test -u jdoe@example.com
خروجی (موفقیت)
پس از موفقیت، دستور خروجی مشابه زیر را برمی گرداند:
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 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-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 | (اختیاری) URI پایه برای سازمان شما در 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
کلیدهای چرخان
از دستور edgemicro rotatekey برای چرخاندن جفت‌های کلید عمومی/خصوصی که برای تولید توکن‌های JWT برای امنیت OAuth در Edge Microgateway استفاده شده‌اند، استفاده کنید.
برای کسب اطلاعات بیشتر، به چرخش کلیدهای JWT مراجعه کنید.
استفاده
edgemicro rotatekey -o [organization] -e [environment] -u [username] -k [kid]
پارامترها
| پارامترها | توضیحات |
|---|---|
-o, --org | (الزامی) سازمان Apigee که Edge Microgateway را برای آن پیکربندی کرده اید. |
-e, --env | (الزامی) محیطی که Edge Microgateway را برای آن پیکربندی کرده اید. |
| -u، --نام کاربری | (الزامی) نام کاربری Apigee شما. شما باید یک مدیر سازمان برای سازمان مشخص شده باشید. |
-p, --password | (اختیاری) رمز عبور شما. اگر این پارامتر را در خط فرمان ارائه نکنید، از شما خواسته می شود. |
-k, --kid | (الزامی) شناسه ای که برای مطابقت با یک کلید خاص استفاده می شود. Edge Microgateway از این مقدار برای انتخاب از میان مجموعه ای از کلیدها در حین چرخش کلید استفاده می کند. برای اطلاعات بیشتر، به بخش 4.5 مشخصات کلید وب JSON مراجعه کنید. |
-b, --baseuri | (اختیاری) URI پایه برای سازمان شما در Apigee Edge. پیش فرض URI پایه برای استقرار ابری Apigee api.enterprise.apigee.com است. برای استقرارهای داخلی، URL پایه ممکن است متفاوت باشد. |
مثال
edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2
خروجی (موفقیت)
پس از موفقیت، دستور خروجی مشابه زیر را برمی گرداند:
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 مشاهده کنید که کلیدهای جدیدی به microgateway KVM اضافه شده است.
نظارت برای همیشه
از دستور 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
برای توقف برای همیشه:
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