הפניות CLI ל-Edge Microgateway

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

Edge Microgateway v. 2.4.x

סקירה כללית

ה-CLI של Edge Microgateway מאפשר לכם לשלוט בכל ההיבטים של מכונת Edge Microgateway ולנהל אותה.

ניהול אישורים

באמצעות הפקודות cert אפשר להתקין ולנהל את זוג המפתחות הציבורי/פרטי שמשמש לחתימה על אסימונים למוכ"ז שמשמשים לקוחות לביצוע קריאות מאובטחות דרך Edge Microgateway. המפתחות מאוחסנים ב-Apigee Edge במפת ערכי מפתח מוצפנת (KVM). Edge Microgateway משתמש במפתח הציבורי כדי לאמת אסימונים למוכ"ז חתומים. המפתחות האלה נוצרים כשמריצים את הפקודה של הגדרת ה-edgemicro, כמו שמוסבר במאמר הגדרה והגדרה של Edge Microgateway. במקרה הצורך, תוכלו להשתמש בפקודות cert שמתוארות כאן כדי ליצור מחדש ולנהל את המפתחות האלה.

התקנת אישור

התקנת המפתחות במפת ערכי מפתח מוצפנת (KVM) באמצעות שירות החנויות המאובטחות של Apigee Edge, והחזרת המפתח הציבורי כפלט. צמדי מפתחות מוגבלים לארגון שצוין.

שימוש

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 v6.1.0
current edgemicro version is 2.2.4-beta
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 Cloud

מאפשר Edge Microgateway לפעול עם מופע Cloud Apigee Edge. הוא אורז ומבצע רצף פקודות כדי לפרוס שרת proxy נדרש לאימות ב-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 (אופציונלי) מציינת את כינוי המארח הווירטואלי עבור Organization:environment. למידע נוסף על מארחים וירטואליים, אפשר לעיין במסמכי התיעוד של Edge. ברירת מחדל: org-env.apigee.net
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה נמצא ב-./config/config.yaml. (נוסף v2.4.x)
-x, --proxyName (אופציונלי) מגדיר את נתיב הבסיס לשרת ה-proxy של edgemicro-auth. אם שרת ה-Proxy מסוג edgemicro-auth פרוס בנתיב שונה מברירת המחדל, /edgemicro-auth, התכונה הזו תאפשר לכם להגדיר את הנתיב החדש ב-Edge Microgateway. כברירת מחדל, הנתיב הבסיסי הוא /edgemicro-auth. (נוסף v2.4.x)
-t, --token (אופציונלי) מאפשר לך להשתמש באסימון OAuth לצורך אימות במקום בשם משתמש/סיסמה. למשל:

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 (אופציונלי) הסיסמה שלכם. אם לא מציינים את הפרמטר הזה בשורת הפקודה, תופיע הודעה.
-h, --help מידע על השימוש בפלט.

הערות שימוש

לאחר הצלחה, הפקודה מחזירה שלושה פריטים. הראשונה היא כתובת URL שצריך למקם בקובץ התצורה. שני זוגות המפתחות האחרים הם זוג מפתחות שנדרש כשמפעילים מכונה של Edge Microgateway.

  • Botstrap URL: כתובת ה-URL הזו מפנה לשירות Apigee Edge שמאפשר למכונה של Edge Microgateway לשלוח נתוני ניתוח אל Apigee Edge. צריך להעתיק את כתובת ה-URL הזו לקובץ התצורה של Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
  • key: המפתח. המפתח הזה והסוד נדרשים כקלט לפקודת ה-CLI המשמשת להפעלת מכונה של Edge Microgateway.
  • secret: הסוד.

דוגמה

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

המדיניות מגדירה את Edge Microgateway לעבודה עם התקנת ענן פרטי של Apigee Edge.

שימוש

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 רשימה מופרדת בפסיקים של מארחים וירטואליים עבור Organization:environment. ברירת המחדל "default,secure".
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה נמצא ב-./config/config.yaml. (נוסף v2.4.x)
-t, --token (אופציונלי) מאפשר לך להשתמש באסימון OAuth לצורך אימות במקום בשם משתמש/סיסמה. למשל:

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 privacy setting (ענן פרטי). פקודת ההגדרה מחזירה את המפתח ואת הערכים הסודיים הנדרשים להפעלת 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. ברירת מחדל: 8,000
-c, --cluster

(אופציונלי) הפעלת Edge Microgateway במצב אשכול.

הערה: החל מגרסה 2.3.1, האפשרות הזו הוסרה. בגרסה 2.3.1 ואילך, Edge Micro תמיד מתחיל לפעול במצב אשכול.
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה נמצא ב-./config/config.yaml. (נוסף v2.4.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

פלט לדוגמה:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

ניהול אסימונים

הפקודות token מאפשרות לך לקבל, לפענח ולאמת אסימוני גישה מסוג OAuth2 חתומים. תוכלו לקרוא גם על קריאות ל-API מאובטח באמצעות אסימון גישה מסוג OAuth2.

פענוח אסימון

מתבצע פענוח של אסימון מקודד וחתום לייצוג JWT (Java Web Token) בפורמט JSON פשוט. אסימון שמעביר מידע על אפליקציית המפתחים של 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. כדי להשתמש בה, צריך להזין את ערכי מפתח הצרכן (מזהה לקוח) וסוד צרכן (סוד לקוח) מאפליקציית מפתח רשומה ב-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 מזהה הלקוח מאפליקציית המפתח שמשויך לשרת proxy שתומך ב-Microgateway.
-s, --secret סוד הלקוח מאפליקציית המפתחים המשויכת לשרת ה-proxy שתומך ב-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' }

שליחת בקשת HTTP לקבלת אסימון

תוכלו גם ליצור בקשת HTTP גולמית כדי לקבל את האסימון. הנה דוגמה ל-curl. פשוט מחליפים את שמות הארגון והסביבה בכתובת ה-URL, ומחליפים את הערכים של 'מזהה הצרכן' ו'סוד הצרכן' בפרמטרים client_id ו-client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

אימות אסימון

אימות אסימון למוכ"ז חתום מול המפתח הציבורי שמאוחסן ב-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) }

קבלת אסימונים למוכ"ז באופן ישיר

יכול להיות שעדיף לקבל אסימונים למוכ"ז ישירות על ידי שליחת בקשת HTTP לנקודת הקצה של האסימון ב-Apigee Edge. נקודת הקצה של האסימון בפועל מוטמעת בשרת ה-proxy שנפרס באמצעות פקודת ה-CLI של שירות הקצה לפריסה.

הנה דוגמה ל-curl. פשוט מחליפים את שמות הארגון והסביבה בכתובת ה-URL, ומחליפים את הערכים של 'מזהה צרכן' ו'סוד צרכן' שהתקבלו מאפליקציה למפתחים ב-Apigee Edge בפרמטרים client_id ו-client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

פלט לדוגמה:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

הפעלת תצורה חדשה של Edge Microgateway

מריצים את הפקודה הזו פעם אחת אחרי ההתקנה הראשונה של Edge Microgateway. יצירת קובץ תצורה חדש שמוגדר כברירת מחדל: ~/.edgemicro/default.yaml.

שימוש

edgemicro init

פרמטרים

פרמטרים התיאור
-c, --configDir (אופציונלי) מציין את הנתיב לקובץ התצורה של Edge Microgateway. כברירת מחדל, קובץ התצורה נמצא ב-./config/config.yaml. (נוסף v2.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

בדיקת הסטטוס של אשכול המיקרו-גייט

נוסף: גרסה 2.2.4-בטא

כברירת מחדל, Edge Microgateway מופעל במצב אשכול. אפשר להשתמש בפקודה הזו כדי לבדוק את הסטטוס של האשכול.

שימוש

edgemicro status

פרמטרים

פרמטרים התיאור
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro status

פלט (הצלחה)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

מתבצעת עצירה של אשכול המיקרו-גייט

נוסף: גרסה 2.2.4-בטא

הפסקת אשכול Edge Microgateway.

שימוש

edgemicro stop

פרמטרים

פרמטרים התיאור
-h, --help מידע על השימוש בפלט.

דוגמה

edgemicro stop

פלט (הצלחה)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

טעינה מחדש של אשכול המיקרו-גייט

נוסף: גרסה 2.2.4-בטא

מספקת הפעלה מחדש ללא זמן השבתה לאחר שינוי הגדרה. טוען מחדש את 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