שימוש במתאם Apigee ל-Envoy עם Apigee Edge

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

הדוגמה הזו ממחישה איך להשתמש במתאם Apigee ל-Envoy עם Apigee Edge.

דרישות מוקדמות

לפני שמתחילים:
מורידים ומתקינים את Apigee Adapter ל-Envoy Remote Service ו-CLI, כפי שמוסבר בקטע תחילת העבודה.

סקירה כללית

בדוגמה הזו מוסבר איך להשתמש ב-Apigee Adapter ל-Envoy עם Apigee Edge לענן ציבורי. API קריאות לשרת proxy עוברות דרך Envoy שפועל כאפליקציית נייטיב עם Edge שמספק API שירותי ניהול באמצעות שירות Apigee Remote עבור Envoy.

האיור הבא מציג את הארכיטקטורה הבסיסית לשילוב של Apigee Edge:

שרת proxy של Envoy ושירות מרוחק פועלים באופן מקומי. Envoy מטפל בתנועת ה-API לשירות היעד וממנו ומתקשרים עם שירות מרוחק. השירות המרוחק גם מתקשר עם Apigee Edge Cloud כדי לאחזר מידע על מוצר API ושרת proxy.

הקצאה של Apigee Edge

בשלב הזה משתמשים ב-CLI של שירות מרוחק כדי להקצות נכסי Apigee Adapter לנכסי Envoy ל-Apigee Edge. הפקודה של ניהול התצורה פורסת שרת proxy ל-API ל-Apigee Edge, וגם מגדיר אישור ב- Apigee ויצירה של פרטי כניסה שבהם השירות המרוחק ישתמש כדי: להתחבר מהמערכת ל-Apigee.

1. נכנסים לספרייה $CLI_HOME:

   cd $CLI_HOME

2. יוצרים את משתני הסביבה הבאים. המשתנים האלה ישמשו בתור פרמטרים לסקריפט להקצאת הרשאות ידנית:

   export ORG=organization_name
   export ENV=environment_name
   export USER=your_apigee_username
   export PASSWORD=your_apigee_password

   כאשר:

   משתנה	תיאור
   organization_name	שם הארגון שלכם ב-Apigee.
   environment_name	השם של הסביבה בארגון.
   your_apigee_username	שם המשתמש בחשבון Apigee. בדרך כלל שם המשתמש הוא כתובת אימייל.
   your_apigee_password	הסיסמה שלכם ב-Apigee.

3. מריצים את הפקודה הבאה כדי להקצות את שרת ה-proxy של השירות המרוחק ב-Apigee Edge:

   ./apigee-remote-service-cli provision --legacy --username $USER --password $PASSWORD \
       --organization $ORG --environment $ENV > config.yaml

4. בודקים את התוכן של הקובץ config.yaml. הוא אמור להיראות כך:

   # Configuration for apigee-remote-service-envoy
   # generated by apigee-remote-service-cli provision on 2020-06-06 11:55:52
   tenant:
     internal_api: https://istioservices.apigee.net/edgemicro
     remote_service_api: https://my-org-test.apigee.net/remote-service
     org_name: my-org
     env_name: test
     key: ecaa56d4101701cb877670909f3614219091b00ce559842e1b584a34b7c6a3e4
     secret: 0c66638bb865c1e13019990ea42da66b097d02a6ba333f050fb27cef20259d98

   המפתח והערכים הסודיים משמשים לאימות הבקשות משרת ה-proxy של השירות המרוחק אל Apigee Edge.

הרצת השירות Apigee Remote עבור שירות Envoy

אפשר להריץ את השירות מרחוק כקובץ בינארי מקומי או ב-Docker.

הפעלת השירות באופן מקורי

מריצים את הקובץ הבינארי של השירות באמצעות קובץ התצורה שנוצר על ידי הפקודה להקצאת הרשאות ידנית:

$REMOTE_SERVICE_HOME/apigee-remote-service-envoy -c config_file_path/config.yaml

הרצת השירות ב-Docker

קובצי אימג' של Docker מתפרסמים עם תגי גרסאות. כדי להתקין את האפליקציה הזו, צריך להשתמש בגרסה העדכנית. יש תוכלו לבחור מבין שלוש וריאציות של תמונות:

גרסה	תמונה
scratch	google/apigee-envoy-adapter:v1.0.0
Ubuntu	google/apigee-envoy-adapter:v1.0.0-ubuntu
Ubuntu עם קריפטו משעמם	google/apigee-envoy-adapter:v1.0.0-boring

לדוגמה, כדי להריץ את תמונת הגירוד עם config.yaml המקומי שלך הזמין בתור /config.yaml באמצעות טעינת עוצמת קול, משתמשים בפקודה הזו:

docker run -v ./config.yaml:/config.yaml google/apigee-envoy-adapter:v1.0.0

התקנה והפעלה של שרת ה-proxy של Envoy

כדי להתקין ולהפעיל את שרת ה-proxy של Envoy, פועלים לפי השלבים הבאים:

1. מורידים קובץ בינארי של Envoy או ליצור אותו, או להשתמש ב-Docker.
2. מריצים את Envoy באמצעות קובץ תצורה לדוגמה שמוגדר לשירות httpbin.org:

   envoy -c $REMOTE_SERVICE_HOME/samples/native/envoy-httpbin.yaml

בדיקת ההתקנה

1. התקשרות אל httpbin service:

   curl -i http://localhost:8080/httpbin/headers
   

   השירות מנוהל עכשיו על ידי Apigee, ומכיוון שלא ציינת מפתח API, הקריאה מחזירה את השגיאה הבאה.

   curl -i http://localhost:8080/httpbin/headers
   HTTP/1.1 403 Forbidden
   date: Tue, 12 May 2020 17:51:36 GMT
   server: envoy
   content-length: 0
   x-envoy-upstream-service-time: 11

2. מגדירים מוצר API ומקבלים מפתח API, כמו שמוסבר ב: איך לקבל מפתח API
3. מבצעים קריאה ל-API באמצעות המפתח:

   export APIKEY=YOUR_API_KEY
   curl -i http://localhost:8080/httpbin/headers -H "x-api-key: $APIKEY"

   הקריאה צריכה להצליח עם סטטוס 200 ולהחזיר בתשובה רשימה של כותרות. לדוגמה:

   curl -i httpbin.default.svc.cluster.local/headers -H "x-api-key: kyOTalNNLMPfOSy6rnVeclmVSL6pA2zS"
   HTTP/1.1 200 OK
   server: envoy
   date: Tue, 12 May 2020 17:55:34 GMT
   content-type: application/json
   content-length: 828
   access-control-allow-origin: *
   access-control-allow-credentials: true
   x-envoy-upstream-service-time: 301
   
   {
     "headers": {
       "Accept": "*/*",
       "Content-Length": "0",
       "Host": "httpbin.default.svc.cluster.local",
       "User-Agent": "curl/7.70.0-DEV",
       "X-Api-Key": "kyOTalNNLMPfOSy6rneclmVSL6pA2zS",
       "X-Apigee-Accesstoken": "",
       "X-Apigee-Api": "httpbin.default.svc.cluster.local",
       "X-Apigee-Apiproducts": "httpbin",
       "X-Apigee-Application": "httpbin",
       "X-Apigee-Authorized": "true",
       "X-Apigee-Clientid": "kyOTalNNLMPfOSy6rVeclmVSL6pA2zS",
       "X-Apigee-Developeremail": "user@example.com",
       "X-Apigee-Environment": "test",
       "X-Apigee-Organization": "my-org",
       "X-Apigee-Scope": "",
       "X-B3-Parentspanid": "1476f9a2329bbdfa",
       "X-B3-Sampled": "0",
       "X-B3-Spanid": "1ad5c19bfb4bc96f",
       "X-B3-Traceid": "6f329a34e8ca07811476f9a2329bbdfa"
     }
   }

השלבים הבאים

תנועת ה-API לשירות httpbin מנוהלת עכשיו על ידי Apigee. הנה רשימה של כמה פיצ'רים שתוכלו לנסות:

• אם הגדרתם את מוצר ה-API כפי שמוסבר ב איך מקבלים מפתח API מגבלת המכסה הוגדרה ל-5 בקשות לדקה. אפשר לנסות להתקשר לשירות httpbin עוד כמה פעמים כדי להפעיל את המכסה. אם תחרגו מהמכסה, תופיע השגיאה הבאה:

  HTTP/1.1 429 Too Many Requests

• לגשת ל-Apigee Analytics בממשק המשתמש של Edge. עוברים אל Analyze (ניתוח) > API Metrics (מדדי API) > API Proxy Performance (ביצועים של שרת proxy ל-API).
• ליצור אסימוני JWT ולהשתמש בהם לאימות קריאות ל-API.
• שימוש ב-CLI לניהול, ליצירה ולשליטה בקישורויות. פרטים על CLI זמינים בחומר העזר.