راه‌اندازی و پیکربندی Edge Microgateway

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

Edge Microgateway v. 2.3.x

نمای کلی

این آموزش شما را در مراحل لازم برای راه‌اندازی و اجرای نمونه‌ای از Edge Microgateway راهنمایی می‌کند.

پس‌از تکمیل مراحل اینجا، نصب Edge Microgateway کاملاً پیکربندی‌شده و کارآمدی خواهید داشت که قادر به پردازش درخواست‌های API است. با ایجاد تماس‌های API ایمن ازطریق Edge Microgateway به هدف زمینه‌ای، راه‌اندازی را آزمایش خواهید کرد. همچنین با نحوه افزودن افزایه مهار جهش به Microgateway آشنا خواهید شد.

این راهنما به این بخش‌ها تقسیم شده است:

پیش‌نیاز: نصب Edge Microgateway

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

وقتی نصب تمام شد، به بخش بعدی، «بخش ۱: پیکربندی Edge Microgateway» بروید.

بخش ۱: پیکربندی Edge Microgateway

در این بخش، از فرمان میانای خط فرمان (CLI) برای پیکربندی Edge Microgateway برای ارتباط با Apigee Edge استفاده خواهید کرد. اگر از Apigee Edge Cloud استفاده می‌کنید، مراحل پیکربندی Apigee Edge Cloud را دنبال کنید. اگر از Apigee Private Cloud استفاده می‌کنید، مراحل مربوط به Apigee Edge Private Cloud را دنبال کنید.

مراحل پیکربندی Apigee Edge Cloud

برای استفاده از Edge Microgateway با Apigee Edge Cloud، این مراحل را دنبال کنید:

  1. اگر قبلاً این کار را نکرده‌اید، Edge Microgateway را مقداردهی اولیه کنید (فقط یک‌بار باید این مرحله را انجام دهید):
    edgemicro init
  2. (اختیاری) راهنمای چاپ برای فرمان edgemicro configure:
    edgemicro configure -h
  3. برای پیکربندی Edge Microgateway، فرمان زیر را اجرا کنید:
    edgemicro configure -o [org] -e [env] -u [username]

    مکان:

    • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • username نشانی ایمیل منسوب به حساب Apigee شما است.

مثال

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

برونداد

./edgemicro configure -o docs -e test -u jdoe@apigee.com
password:
current nodejs version is v6.1.0
current edgemicro version is 2.2.3-beta
password:
file doesn't exist, setting up
Give me a minute or two... this can take a while...
App edgemicro-auth deployed.
creating vault
adding private_key
adding public_key
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1

saving configuration information to: /Home/.edgemicro/wwitman-test-config.yaml

vault info:
 -----BEGIN CERTIFICATE-----
MIICpDCCAYwCCQCaDpaTttaDANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3QwHhcNMTYxAxMjA0NzIyWhcNMTYxMTAyMjA0NzIyWjAUMRIwEAYD
VQQDEwlsb2NhbGhvcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDA
YbtbsFe50GgBrI8QTih5yzxxxvCfdubGrLWmovwwCCFthno3u8lS54ekOL9jQu
JTJsocJfNhZxvnXifDsCk5Muwx87Z/D0BYLw9ZhM8TMyA2MCkXgC6RfKT69IdJ
jT3X+3D0s+apr3lACsDhgOfaeQfeHAm1SSwH/VemaJqdImGkQMtM8uscMDwG6k
vBbCSNS+hh6ZH1m3tAkcKXqvj/E1hbrHNTWr+uiYFRByUzeo1I607daQD4Lxid
il4Ng3hr3LC1gEzvobWgVyhQ2ovYB57T886H7dGghTnOUxLm2y/TwmQya+44SL
JSsDwauArMF38cRKZZ7VAgMBAAEwDQYJKoZIhvcNAQELBQADEBAHwwu+gOn8Tq
jKOYBTXtOX11HPMTxmyvZ/I57R4roE7Z/lXg/DXwbiFpFG2uamXNKq7yTDJH2i
iiqdERZOGfv7TJMjRlxEnfVHoCV7UKguKq4zeeAEU2x55yFwpWNrarx0kMXRwI
v3WgGfo2bimFQrCjDCNIkDKmYYt4SXIF5zUJmBWPCaK9aJoQb7ARXQO9s2zoOI
XZ5bCUDbehQZ+6LyqC0hgDXiIZYy7R0j93yCbQgoHaHUMEprJEEjE24SHdsWBO
nxGZxB20JLq5AHTm8lbZp7XtvbU0jVpxyrBo2/olFnmpvBVOq9eIp042IVD7nT
J4rPejdK6C4=
-----END CERTIFICATE-----

The following credentials are required to start edge micro
  key: e88ec9d5da17cd88ca338d532b7c7a8c4f43ddd3da139d95955ab345af30352d
  secret: d7f64854eb6889d06b809dd7c161dba5eeba4a2657277fd819921bf992221a8f

edgemicro configuration complete!

مراحل پیکربندی Apigee Private Cloud

برای استفاده از Edge Microgateway با Apigee Private Cloud، این مراحل را دنبال کنید:

  1. اطلاعات راهنمای فرمان edgemicro private configure را چاپ کنید. به این روش می‌توانید راهنمای هر فرمان یا گزینه فرمان Edge Microgateway CLI را چاپ کنید. 
    edgemicro private configure -h
  2. فرمان زیر را اجرا کنید. این کار به اطلاعات استاندارد درباره حساب Apigee Edge Private Cloud شما نیاز دارد: نام سازمان، نام محیط، نام کاربری (نشانی ایمیل)، گذرواژه، نشانی IP سرور مدیریت و نشانی IP مسیریاب. برای استفاده از این فرمان باید سرپرست سازمان Edge باشید: 
    edgemicro private configure -o [org] -e [env] -u [username] -r [runtime_url] -m [mgmt_url] -v [virtual_host]

    مکان:

    • ‫org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • ‫env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • runtime_url نشانی وب زمان اجرا برای نمونه ابری خصوصی شما است.
    • mgmt_url نشانی وب سرور مدیریت برای نمونه ابر خصوصی شما است.
    • username نشانی ایمیل منسوب به حساب Apigee شما است.
    • virtual_host فهرست جداشده با کاما از نام‌های میزبان مجازی است. مقادیر پیش‌فرض default,secure است

مثال

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

یا، اگر نام مستعار میزبان مجازی شما myorg-test.mycompany.com است، از فرمانی مانند این استفاده می‌کنید:

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

برونداد

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

checking org for existing vault creating vault adding private_key adding public_key
configuring host http://192.168.52.106:9001 for region dc-1

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

The following credentials are required to start edge micro 
   key: a3f8f3dfe39158fc3c50b274f0af2234246e0d5f6ea4dd09389b645147151ba3 
   secret: 3e9904802fb3c0e8ca408128a11119cf13546d54dac30ace944c097a726a1263

edgemicro configuration complete!

به‌تأیید رساندن نصب

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

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

مکان:

  • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
  • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
  • ‫key کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.
  • ‫secret کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.

مثال

edgemicro verify -o docs -e test -k 93b01fd21d86331459ae52f664ae9aeb13eb94767ce40a4f621d172cdfb7e8e6 -s c8c755be97cf56c21f8b0556d7132afbd03625bbd85dc34ebfefae4f23fbcb3c

درباره پیکربندی

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

از این اطلاعات پیکربندی برای چه هدفی استفاده می‌شود؟ همان‌طور که در بخش بعدی این آموزش خواهیم دید، وقتی Edge Microgateway شروع می‌شود، باید فهرستی از پراکسی‌های میانای برنامه کاربردی ویژه Edge Microgateway-aware را از Apigee Edge دریافت کند. در بخش بعدی این آموزش، کارگزار نیابتی آگاه به Microgateway ایجاد خواهید کرد. ‫Edge Microgateway مشتریان را محدود می‌کند تا فقط با میاناهای برنامه‌سازی کاربردی که توسط این پراکسی‌های میانای برنامه‌سازی کاربردی آگاه از Microgateway ارائه می‌شوند تماس بگیرند، و مشتریان (به‌طور پیش‌فرض) ملزم خواهند بود برای هر تماس یک کد امنیتی معتبر ارائه دهند. برای خواندن بیشتر درباره این پراکسی‌ها، «آنچه باید درباره پراکسی‌های آگاه به Edge Microgateway در نمای کلی Edge Microgateway بدانید» را ببینید.

به‌عنوان سرپرست سازمان Edge، علاقه‌مند خواهید بود بدانید که پراکسی‌های آگاه از Edge Microgateway می‌توانند مانند هر پراکسی دیگری به محصولات Edge اضافه شوند. ازطریق استفاده از محصولات و برنامه‌های توسعه‌دهنده، می‌توانید نشان‌های امنیتی ویژه مشتری تولید کنید تا دسترسی به «میاناهای برنامه‌سازی کاربردی» فراخوانده‌شده ازطریق Edge Microgateway را کنترل کنید. الگوهای درگیر در این فرایند با کار کردن با هرگونه پراکسی API، محصول، و برنامه توسعه‌دهنده در Apigee Edge یکسان است. اگر می‌خواهید درباره محصولات مطالعه کنید، با محصول API چیست؟ در اسناد Edge شروع کنید.

در مرحله بعد، نحوه ایجاد پراکسی‌های آگاه از Edge Microgateway را بررسی خواهیم کرد و پس‌از آن، Edge Microgateway را راه‌اندازی و تنظیمات را آزمایش خواهیم کرد.

بخش ۲: ایجاد نهادها در Apigee Edge

در این بخش، این نهادها را در Edge ایجاد خواهید کرد:

  • کارگزار آگاه از ریزدروازه - این کارگزار ویژه‌ای است که «ریزدروازه Edge» می‌تواند هنگام راه‌اندازی آن را شناسایی کند. کارگزاران آگاه از ریزدروازه قرارداد نام‌گذاری دارند که باید از آن پیروی کنید: نام باید با edgemicro_ شروع شود. برای مثال edgemicro_hello یا edgemicro_userinfo. وقتی Edge Microgateway شروع می‌شود، فهرستی از پراکسی‌های آگاه به میکروگیت‌وی را از Edge بازیابی می‌کند همان سازمان و محیط Edge که هنگام شروع Edge Microgateway مشخص کرده‌اید.

    برای هر پراکسی آگاه از میکروگیت‌وی، Edge Microgatway نشانی وب هدف پراکسی و مسیر پایه آن را بازیابی می‌کند. کارگزاران آگاه از «درگاه کوچک» همچنین روشی مناسب برای مرتبط کردن داده‌های تجزیه‌وتحلیل تولیدشده توسط «درگاه کوچک Edge» با کارگزار در پلاتفرم Edge ارائه می‌دهند. ازآنجایی‌که Microgateway تماس‌های API را مدیریت می‌کند، داده‌های تجزیه‌وتحلیل را به‌صورت ناهمزمان به Edge ارسال می‌کند. داده‌های Analytics در «میانای کاربری Analytics Edge» در زیر نام(های) پراکسی آگاه از میکرودروازه، همان‌طور که برای هر پراکسی دیگری نمایش داده می‌شود، نشان داده خواهد شد.
  • محصول، توسعه‌دهنده، و برنامه توسعه‌دهنده - Edge Microgateway از محصولات، توسعه‌دهندگان، و برنامه‌های توسعه‌دهنده برای فعال کردن امنیت کلید API یا کد دسترسی OAuth2 استفاده می‌کند. وقتی Edge Microgateway شروع می‌شود، همه پیکربندی‌های محصول را از سازمان Apigee Edge شما بارگیری می‌کند. این سرویس از این اطلاعات برای درستی‌سنجی تماس‌های «میانای برنامه‌سازی کاربردی» که ازطریق Edge Microgateway با کلیدهای «میانای برنامه‌سازی کاربردی» یا کدهای دسترسی OAuth2 برقرار می‌شوند استفاده می‌کند.

بیشتر بخوانید: همچنین «آنچه باید درباره پراکسی‌های آگاه از Edge Microgateway بدانید» را در نمای کلی Edge Microgateway ببینید.

۱. ایجاد پراکسی API سازگار با «درگاه کوچک Edge» در Edge

  1. در Apigee Edge به سیستم سازمانتان وارد شوید.
  2. برای رفتن به «واسط کاربر Edge Classic»، روی رفتن به کلاسیک کلیک کنید.
  3. از منو بالا، میاناهای برنامه‌سازی کاربردی > پراکسی‌های میانای برنامه‌سازی کاربردی را انتخاب کنید.
  4. در صفحه «پراکسی‌های API»، روی + پراکسی API کلیک کنید.
  5. در جادوگر «ساختن پراکسی»، پراکسی معکوس (رایج‌ترین) را انتخاب کنید.
  6. روی بعدی کلیک کنید.
  7. در صفحه «جزئیات» دستیار، به‌صورت زیر پیکربندی کنید. مطمئن شوید که جادوگر را دقیقاً همان‌طور که نشان داده شده است تکمیل کنید:
    • نام پراکسی: edgemicro_hello
    • مسیر پایه پراکسی: /hello
    • میانای برنامه‌سازی کاربردی موجود: http://mocktarget.apigee.net/
  8. روی بعدی کلیک کنید.
  9. در صفحه «امنیت» دستیار، عبور (هیچ‌کدام) را انتخاب کنید.
  10. روی بعدی کلیک کنید.
  11. در صفحه «میزبانان مجازی» در دستیار، پیش‌فرض‌ها را بپذیرید.
  12. روی بعدی کلیک کنید.
  13. در صفحه «ساخت» دستیار، تنظیمات پراکسی خود را مرور کنید. مطمئن شوید که محیط آزمایشی انتخاب شده باشد.
  14. روی ساختن و پیاده‌سازی کلیک کنید.

۲. ایجاد محصول

محصولی ایجاد کنید که حاوی دو پراکسی باشد:

  • پروکسی آگاه از ریزدروازه شما: edgemicro_hello
  • پراکسی اصالت‌سنجی که توسط Edge نصب شده است Microgateway: edgemicro-auth.
  1. در «میانای کاربری Edge» (نسخه کلاسیک)، به انتشار > محصولات بروید.
  2. در صفحه «محصولات»، روی + محصول کلیک کنید. صفحه «جزئیات محصول» را به‌صورت زیر تکمیل کنید:
    • نام: EdgeMicroTestProduct
    • نام نمایشی: EdgeMicroTestProduct
    • محیط: آزمایشی و تولید
    • دسترسی: عمومی
    • نوع تأیید کلید: خودکار
    • منابع:
      • پراکسی میانای برنامه‌سازی کاربردی: edgemicro_hello را انتخاب کنید
      • بازبینی: ۱
      • مسیر منبع: /**
  3. روی وارد کردن منبع کلیک کنید.
  4. در «منابع»، روی +API Proxy کلیک کنید
  5. edgemicro-auth را انتخاب کنید
  6. روی ذخیره کلیک کنید.

۳. (اختیاری) ایجاد توسعه‌دهنده آزمایشی

برای هدف این آموزش گام‌به‌گام، می‌توانید از هر توسعه‌دهنده موجودی برای مرحله بعدی، ایجاد برنامه توسعه‌دهنده، استفاده کنید. اما اگر مایلید، اکنون توسعه‌دهنده آزمایشی ایجاد کنید:

  1. به انتشار > توسعه‌دهندگان بروید.
  2. در صفحه «محصولات»، روی + توسعه‌دهنده کلیک کنید.
  3. برای ایجاد توسعه‌دهنده آزمایشی، کادر گفتگو را تکمیل کنید.

۴. ایجاد برنامه توسعه‌دهنده

از اطلاعات اعتباری کارخواه این برنامه برای برقراری تماس‌های ایمن با «میانای برنامه‌سازی کاربردی» ازطریق Edge Microgateway استفاده خواهید کرد:

  1. به انتشار > برنامه‌های توسعه‌دهنده بروید.
  2. در صفحه «برنامه‌های توسعه‌دهنده»، روی + برنامه توسعه‌دهنده کلیک کنید.
  3. صفحه «برنامه توسعه‌دهنده» را به‌صورت زیر تکمیل کنید:
    1. نام: EdgeMicroTestApp
    2. نام نمایشی: EdgeMicroTestApp
    3. توسعه‌دهنده: اگر توسعه‌دهنده آزمایشی ایجاد کرده‌اید، آن را انتخاب کنید. یا می‌توانید از هر توسعه‌دهنده موجودی برای هدف این آموزش استفاده کنید.
    4. اطلاعات اعتباری:
      1. «انقضا»: هرگز را انتخاب کنید.
      2. روی + محصول کلیک کنید و EdgeMicroTestProduct (محصولی که همین حالا ایجاد کردید) را انتخاب کنید
  4. روی ذخیره کلیک کنید.
  5. به صفحه فهرست «برنامه‌های توسعه‌دهنده» برگشتید.
  6. برنامه‌ای را که تازه ایجاد کرده‌اید، EdgeMicroTestApp، انتخاب کنید.
  7. روی نمایش در کنار کلید مصرف‌کننده و رمز مصرف‌کننده کلیک کنید.

بخش ۳: بهره‌برداری از Edge Microgateway

اکنون که Edge Microgateway پیکربندی‌شده و حداقل یک پراکسی آگاه به Edge Microgateway در Edge دارید، زمان آن رسیده است که Edge Microgateway را راه‌اندازی کنید. کارساز HTTP «ریزدروازه Edge» روی ماشین محلی شما اجرا خواهد شد و مستقیماً با آن کارساز تماس API برقرار خواهید کرد.

۱. شروع Edge Microgateway

برای شروع Edge Microgateway، از فرمان edgemicro start استفاده کنید.

  1. مطمئن شوید که کلیدهایی را که قبلاً هنگام اجرای فرمان edgemicro configure برگردانده شده است دراختیار دارید. آن برونداد چیزی شبیه این بود: این: 
    You need key and secret while starting edgemicro instance

key: da4778e7c240a5d4585fc559eaba5083328828ac9f3a7f583e8b73e
secret: 3aad7439708b4aeb38ee08e87189921ad00e6fc1ba8a8ae9f929ee2
  2. (اختیاری) اطلاعات راهنمای فرمان edgemicro start را چاپ می‌کند.
    edgemicro start -h
  3. برای شروع Edge Microgateway، فرمان زیر را اجرا کنید: 
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    مکان:

    • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • key کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.
    • ‫secret کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.

    مثال

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

    برونداد

    دستور شروع اطلاعات پیکربندی زیادی را از Apigee Edge بازیابی می‌کند (که به پنجره پایانه پیمایش می‌کند). در برونداد، فهرستی از محصولات و پراکسی‌های آگاه از ریزدروازه را که شناسایی شده‌اند خواهید دید. در انتهای برونداد، باید چیزی شبیه به این ببینید:

    ...

PROCESS PID : 9757
installed plugin from analytics
installed plugin from oauth
eb725020-a2b0-11e6-8a52-6de156e3a6e2 edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
eb77ce60-a2b0-11e6-8a88-b96278c0c198 edge micro listening on port 8000
eb78b8c0-a2b0-11e6-bf36-717b986c91fe edge micro listening on port 8000
eb77f570-a2b0-11e6-883e-472b9104351e edge micro listening on port 8000

چه اتفاقی افتاده است؟

به پایانه‌ای که فرمان edgemicro config را در آن اجرا کردید نگاه کنید. با پیمایش به بالا در برونداد استاندارد، می‌توانید ببینید که فرمان یک بار اطلاعات پیکربندی Edge Microgateway را از Apigee Edge بازیابی می‌کند. این اطلاعات شامل موارد زیر است:

  • کلید عمومی که قبلاً ایجاد کرده‌ایم و در خزانه Apigee ذخیره کرده‌ایم.
  • نمایش JSON از همه پراکسی‌های آگاه از Edge Microgateway که در سازمان/محیط وجود دارند. این‌ها همه پراکسی‌هایی هستند که با پیشوند edgemicro_ نام‌گذاری شده‌اند.
  • نمایش JSON از همه محصولات API که در سازمان/محیط وجود دارند.

با این اطلاعات، Edge Microgateway می‌داند که مجاز به پردازش کدام پراکسی‌ها و مسیرهای پراکسی است. این محصول از اطلاعات محصول برای اعمال امنیت استفاده می‌کند (دقیقاً به همان روشی که هر پراکسی API در Apigee Edge انجام می‌دهد، جایی که کلیدهای برنامه توسعه‌دهنده با محصولات ارتباط دارند). به‌زودی مراحل ایمن‌سازی Edge Microgateway را مرور خواهیم کرد.

۲. آزمایش کردن Edge Microgateway

با اجرای Edge Microgateway، می‌توانید کارگزار را فراخوانی کنید. پیکربندی کارگزار edgemicro_hello هنگام شروع Edge Microgateway از Edge بارگیری شد. به‌خاطر داشته باشید که مسیر پایه پراکسی /hello است.

برای آزمایش Edge Microgateway، با مسیر پایه شروع می‌کنیم و مسیر منبع /echo را اضافه می‌کنیم. توجه داشته باشید که همه چیز پس‌از مسیر پایه (ازجمله هرگونه پارامتر پُرسمان) به‌سادگی به هدف زیرینه منتقل می‌شود:

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

این خطا به این دلیل رخ می‌دهد که کلید API یا کد دسترسی معتبری را همراه با درخواست ارسال نکرده‌اید. به‌طور پیش‌فرض، Edge Microgateway در هر تماس با «میانای برنامه‌سازی کاربردی» به کلید «میانای برنامه‌سازی کاربردی» یا کد دسترسی نیاز دارد. در مرحله بعدی این آموزش، این API را به‌درستی ایمن می‌کنیم و به شما نشان می‌دهیم چگونه یک کد دسترسی معتبر دریافت کنید و آن را به درخواست اضافه کنید.

۴. توقف Edge Microgateway

  1. در پنجره ترمینال جداگانه‌ای، به cd به همان دایرکتوری که Edge Microgateway را در آن شروع کردید.
  2. فرمان توقف را وارد کنید:
    edgemicro stop

بخش ۴: Secure Edge Microgateway

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

تماس‌های ایمن با میانای برنامه‌سازی کاربردی با کد دسترسی OAuth2

اگر می‌خواهید تماس‌های API را با یک کد دسترسی OAuth2 اصالت‌سنجی کنید، این مراحل را دنبال کنید:

‫۱. دریافت کلیدهای موردنیاز

  1. در «میانای کاربری Edge»، به «برنامه توسعه‌دهندگان» که قبلاً ایجاد کرده‌اید پیمایش کنید، همان‌طور که در بخش ۲: ایجاد نهادها در Apigee Edge توضیح داده شده است. نام «برنامه» EdgeMicroTestApp بود.
  2. در صفحه «برنامه توسعه‌دهنده»، «کلید مصرف‌کننده» و «رمز مصرف‌کننده» را نشان دهید و آن‌ها را کپی کنید. این مقادیر برای دریافت کد دسترسی در مرحله بعدی الزامی است.

‫۲. دریافت کد دسترسی

دو روش برای دریافت کد دسترسی وجود دارد. هر دو روش را به شما نشان خواهیم داد.

استفاده از CLI برای دریافت کد دسترسی

روش اول راحت است و از الگویی که در سراسر آموزش استفاده کرده‌ایم پیروی می‌کند. روش دوم معمولاً برای توسعه‌دهندگان برنامه مشتری که نیاز به درخواست کد دارند مفیدتر است. نقطه پایانی واقعی کد در پراکسی edgemicro-auth پیاده‌سازی شده است که هنگام پیکربندی Edge Microgateway مستقر شده است.

  1. (اختیاری) مشاهده راهنمای فرمان token get: 
    edgemicro token get -h
  2. با جایگزین کردن مقادیر «کلید مصرف‌کننده» و «رمز مصرف‌کننده» از برنامه توسعه‌دهنده‌ای که در Apigee Edge ایجاد کرده‌اید، در پارامترهای -i و -s، نشان را تولید کنید: 
    edgemicro token get -o [org] -e [env] -i [consumer_key] -s [consumer_secret]

    مکان:

    • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • ‫consumer_id «شناسه مصرف‌کننده» در «برنامه توسعه‌دهنده» است که قبلاً ایجاد کرده‌اید.
    • ‫consumer_secret «رمز مصرف‌کننده» در «برنامه توسعه‌دهنده» است که قبلاً ایجاد کرده‌اید.

    مثال

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

    برونداد (نمونه)

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

(اختیاری) استفاده از API برای دریافت کد

اگر به فراخوانی پراکسی‌های Edge بااستفاده از curl یا کارخواه HTTP دیگری عادت دارید، باید بدانید که می‌توانید نقطه پایانی کد اصالت‌سنجی را مستقیماً فراخوانی کنید، به‌جای اینکه از فرمان edgemicro token استفاده کنید. در اینجا یک مثال curl آورده شده است. کافی است نام‌های سازمان و محیطتان را در نشانی وب جایگزین کنید و مقادیر «کلید مصرف‌کننده:رمز مصرف‌کننده» را که با دونقطه از هم جدا شده‌اند در سرصفحه «اصالت‌سنجی پایه» بگذرانید:

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

مکان:

  • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
  • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
  • ‫client_id «شناسه مصرف‌کننده» در «برنامه توسعه‌دهنده» است که قبلاً ایجاد کرده‌اید.
  • ‫client_secret «رمز مصرف‌کننده» در «برنامه توسعه‌دهنده» است که قبلاً ایجاد کرده‌اید.

برونداد (نمونه)

فرمان، چه از فرمان edgemicro token CLI استفاده کرده باشید یا نقطه پایان را بااستفاده از curl فراخوانده باشید، یک رمز دسترسی امضاشده برمی‌گرداند که می‌توان از آن برای انجام تماس‌های کاربر استفاده کرد. چیزی شبیه این:

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

‫۳. پیکربندی را در Edge Microgateway بررسی کنید

  1. فایل را باز کنید ~/.edgemicro/org-env-config.yaml. همچنین «Edge Microgateway در کجا نصب شده است» را در نصب Edge Microgateway ببینید.
  2. مطمئن شوید که این ویژگی‌های افزایه oauth روی false تنظیم شده باشند. به‌طور پیش‌فرض نادرست هستند، اما بهتر است دوباره‌سنجی کنید: 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. همچنین در فایل org-env-config.yaml، مطمئن شوید افزایه oauth به عنصر plugins:sequence اضافه شده باشد، مانند این:: 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. اگر تغییری در فایل ایجاد کردید، تغییرات را در نمونه درحال اجرای Edge Microgateway مجدد بار کنید. این فرمان Edge Microgateway را با زمان توقف صفر بازپیکربندی می‌کند: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    مکان:

    • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • key کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.
    • ‫secret کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.

    مثال

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

‫۴. فراخوانی ایمن میانای برنامه‌سازی کاربردی

اکنون که کد دسترسی را دراختیار دارید، می‌توانید تماس با میانای برنامه‌سازی کاربردی را به‌طور ایمن برقرار کنید. برای مثال:

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

این API سرصفحه‌ها و اطلاعات دیگر را از سرور ساختگی برمی‌گرداند.

ایمن‌سازی میانای برنامه‌سازی کاربردی با کلید میانای برنامه‌سازی کاربردی

اگر می‌خواهید از کلید API برای مجوز استفاده کنید، این مراحل را دنبال کنید:

‫۱. دریافت کلید میانای برنامه‌سازی کاربردی

  1. در «میانای کاربری Edge»، به «برنامه توسعه‌دهندگان» که قبلاً ایجاد کرده‌اید پیمایش کنید، همان‌طور که در بخش ۲: ایجاد نهادها در Apigee Edge توضیح داده شده است. نام «برنامه» EdgeMicroTestApp بود.
  2. در صفحه «برنامه توسعه‌دهنده»، «کلید مصرف‌کننده» را نشان دهید و آن را کپی کنید. این مقدار کلید میانای برنامه‌سازی کاربردی است. از این کلید برای برقراری تماس‌های API درستی‌سنجی‌شده استفاده خواهید کرد.

‫۲. پیکربندی را در Edge Microgateway بررسی کنید

  1. فایل را باز کنید ~/.edgemicro/org-env-config.yaml. همچنین «Edge Microgateway در کجا نصب شده است» را در نصب Edge Microgateway ببینید.
  2. مطمئن شوید که این ویژگی‌های افزایه oauth روی false تنظیم شده باشند. به‌طور پیش‌فرض نادرست هستند، اما بهتر است دوباره‌سنجی کنید: 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. همچنین در فایل org-env-config.yaml، مطمئن شوید افزایه oauth به عنصر plugins:sequence اضافه شده باشد، مانند این:: 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. اگر تغییری در فایل ایجاد کردید، تغییرات را در نمونه درحال اجرای Edge Microgateway مجدد بار کنید. این فرمان Edge Microgateway را با زمان توقف صفر بازپیکربندی می‌کند: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    مکان:

    • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • key کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.
    • ‫secret کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.

    مثال

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

‫۳. با کلید میانای برنامه‌سازی کاربردی، به‌طور ایمن با میانای برنامه‌سازی کاربردی تماس بگیرید

میانای برنامه‌سازی کاربردی را با سرایند x-api-key به‌صورت زیر فراخوانی کنید. مقدار «کلید مصرف‌کننده» که از «برنامه توسعه‌دهنده» کپی کرده‌اید همان کلید API است. به‌طور پیش‌فرض، Edge Microgateway انتظار دارد که کلید را در سرایندی به‌نام x-api-key ارسال کنید، مانند این:

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

مکان:

  • apikey مقدار «کلید مصرف‌کننده» برگرفته از EdgeMicroTestApp است.

برای مثال:


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

اکنون یک Edge Microgateway کاملاً کارآمد و ایمن دارید. در بخش بعدی این آموزش، نگاهی به افزایه‌هایی خواهیم داشت که به Edge Microgateway قابلیت اضافه می‌کنند.

بخش ۵: افزودن افزایه «مهار جهش»

در این بخش، ویژگی محدود کردن نرخ به‌نام «مهار جهش» را به نمونه Edge Microgateway اضافه می‌کنیم.

افزایه چیست؟

افزایه یک واحد Node.js است که عملکرد را به Edge Microgateway اضافه می‌کند. واحدهای افزایه از الگوی ثابتی پیروی می‌کنند و در مکانی ذخیره می‌شوند که Edge Microgateway آن را می‌شناسد، و این امر باعث می‌شود ریزدروازه بتواند آن‌ها را به‌طور خودکار شناسایی و بار کند. در استفاده از افزایه‌ها می‌توانید درباره افزایه‌ها بیشتر بخوانید.

درحال افزودن افزایه «مهار جهش»

«مهار جهش» دربرابر جهش‌های ترافیک محافظت می‌کند. تعداد درخواست‌های پردازش‌شده توسط نمونه Edge Microgateway را محدود می‌کند.

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

  1. فایل را باز کنید ~/.edgemicro/org-env-config.yaml. همچنین «Edge Microgateway در کجا نصب شده است» را در نصب Edge Microgateway ببینید.
  2. عنصر زیر را اضافه کنید. می‌توانید آن را در هر جایی از فایل اضافه کنید. 
       spikearrest:
      timeUnit: minute   
      allow: 10   
      buffersize: 0
  3. ‫spikearrest را به عنصر edgemicro:sequence، همان‌طور که در زیر نشان داده شده است، اضافه کنید. ویژگی پیکربندی توالی به Edge Microgateway می‌گوید که پیمانه‌های افزایه به چه ترتیبی اجرا شوند. 
    edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
  sequence:
    - spikearrest
    - oauth
  4. فایل پیکربندی را ذخیره کنید.
  5. «دروازه کوچک Edge» را با فرمان مجدداً بار کردن مجدداً بار کنید. باید این فرمان را از فهرست راهنمای جایی که Edge Microgateway را شروع کردید اجرا کنید. 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    مکان:

    • org نام سازمان Edge شما است (باید سرپرست سازمان باشید).
    • env محیطی در سازمان شما است (مثل آزمایش یا تولید).
    • key کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.
    • ‫secret کلیدی است که قبلاً توسط فرمان پیکربندی برگردانده شده است.

    مثال

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d
  6. چندین بار پشت سر هم با API تماس بگیرید. پس‌از تماس دوم، Edge Microgateway این خطا را برمی‌گرداند: 
    {"message":"SpikeArrest engaged","status":503}

دلیل آن این است که «مهار جهش» تعداد تماس‌هایی را که می‌توان در واحد زمان مشخص‌شده برقرار کرد هموار می‌کند. بنابراین در این مورد، می‌توانید در یک دقیقه ۱۰ تماس برقرار کنید، یا هر ۶ ثانیه یک تماس.

برای اطلاعات بیشتر، «مهار جهش چگونه کار می‌کند؟» را در استفاده از افزونه‌ها ببینید.

امتیاز اضافی: افزودن افزایه سهمیه

با پیروی از همان الگویی که برای پیکربندی «مهار جهش» استفاده شده است، می‌توانید افزایه‌های دیگری مثل افزایه سهمیه را اضافه کنید. مانند «مهار جهش»، افزایه سهمیه با هر نصب Edge Microgateway ارائه می‌شود. سهمیه تعداد پیام‌های درخواستی را که یک برنامه مجاز است در یک بازه زمانی مشخص (دقیقه یا ساعت) به یک API ارسال کند، مشخص می‌کند.

برای آشنایی با نحوه عملکرد سهمیه‌ها، «استفاده از افزایه سهمیه» را در استفاده از افزایه‌ها ببینید.

بخش ۶: مشاهده Analytics در Apigee Edge

اکنون نمونه کاملاً کارا از Edge Microgateway داریم، بیایید ببینیم چه کار کرده است! به‌طور پیش‌فرض، واحد افزایه تجزیه‌وتحلیل به Edge Micro اضافه می‌شود. این واحد به‌طور بی‌صدا داده‌های واکاوش را از Edge Micro به Apigee edge انتقال می‌دهد، جایی که سیستم Edge Analytics از آن استفاده می‌کند. ببینیم:

  1. در Apigee Edge به سیستم سازمانتان وارد شوید.
  2. Analytics > Proxy Performance (Analytics > عملکرد پراکسی) را انتخاب کنید.
  3. در داشبورد «عملکرد پراکسی»، edgemicro_hello proxy را انتخاب کنید.
  4. این نمودار اطلاعاتی درباره الگوهای ترافیک پراکسی به شما نشان می‌دهد، مثل ترافیک کل، میانگین زمان پاسخ، میانگین زمان پاسخ هدف، و غیره.

در صفحه اصلی «داشبوردهای Analytics» در اسناد Edge می‌توانید درباره داشبوردهای «تجزیه‌وتحلیل لبه‌ای» بیشتر بخوانید. برای کسب اطلاعات بیشتر درباره افزایه‌ها، به استفاده از افزایه‌ها مراجعه کنید