Edge for Private Cloud גרסה 4.16.05
משתמשים ב-apigee-adminapi.sh לביצוע אותן משימות תצורה של Edge שאתם מבצעים על ידי ביצוע קריאות Management API. היתרון של הכלי apigee-adminapi.sh הוא זה:
- להשתמש בממשק שורת פקודה פשוט
- הטמעת השלמה של פקודות מבוססות-כרטיסייה
- מספקת עזרה ומידע על השימוש
- אפשרות להציג את הקריאה המתאימה ל-API אם תחליטו לנסות את ה-API
כלי השירות apigee-adminapi.sh אינו החלפה לכלי השירות apigee-provision. בפועל, הכלי apigee-provision משתמש השירות apigee-adminapi.sh כדי לבצע את המשימות שלו.
ההבדלים העיקריים בין שני סוגי ההמרות הם:
- כלי השירות apigee-adminapi.sh מבצע פונקציות אטומיות שמחליפות קריאות נפרדות ל-Edge API. לדוגמה, כדי ליצור לארגון, לסביבה ומארח וירטואלי נדרשים שלוש פקודות apigee-adminapi.sh נפרדות שמתאימות לשלוש קריאות ל-API.
- apigee-provision הכלי מיועד לביצוע פעולה מלאה ברמה גבוהה בפקודה אחת. עבור לדוגמה, אפשר ליצור ארגון, סביבה ומארח וירטואלי באמצעות שם משתמש אחד פקודת apigee-provision של העברת קובץ תצורה עם כל המידע הדרוש.
במסמכי התיעוד של Edge נעשה שימוש בשתי תוכניות השירות במקרים הרלוונטיים.
התקנה של apigee-adminapi.sh
כלי השירות apigee-adminapi.sh הוא מותקנת אוטומטית כשמתקינים את apigee-provision או את הכלי apigee-validator.
כלי השירות מותקן במיקום הבא:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
תחביר apigee-adminapi.sh
כלי השירות apigee-adminapi.sh משתמשת בתחביר פשוט של שורת פקודה. תמיד אפשר להשתמש במקש Tab כדי להציג הנחיה אפשרויות הפקודות הזמינות.
כדי לראות את כל הפקודות האפשריות, צריך להפעיל את כלי השירות ללא אפשרויות:
> apigee-adminapi.sh
אם תקישו על מקש Tab לאחר ההקלדה apigee-adminapi.sh, תוצג רשימה של אפשרויות אפשרויות:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
מקש Tab מציג אפשרויות בהתאם להקשר של הפקודה. אם תזינו מקש Tab אחרי ההקלדה:
> apigee-adminapi.sh orgs
יופיעו האפשרויות הזמינות להשלמת הפקודה orgs:
add apis apps delete envs list pods userroles
יש להשתמש באפשרות -h כדי להציג בכל פקודה שהיא. לדוגמה, אם אתם משתמשים באפשרות -h כפי שמוצג כאן:
> apigee-adminapi.sh orgs -h
כלי השירות מציג מידע עזרה מלא עבור כל האפשרויות האפשריות לפקודה orgs. הפריט הראשון בפלט מציג את העזרה עבור 'הוספת ארגונים' הפקודה:
+++++++++++++++++++++++++++++++++++++++++++ orgs add Required: -o ORG Organization name Optional: -H HEADER add http header in request --admin ADMIN_EMAIL admin email address --pwd ADMIN_PASSWORD admin password --host EDGE_SERVER edge server to make request to --port EDGE_PORT port to use for the http request --ssl set EDGE_PROTO to https, defaults to http --debug ( set in debug mode, turns on verbose in curl ) -h Displays Help
פרמטרים להגדרה באמצעות מתגי שורת הפקודה ומשתני סביבה
עליכם להזין את כל הפרמטרים לפקודה באמצעות מתגי שורת הפקודה, או באמצעות במשתני סביבה. הוספת מקף בודד (-) או מקף כפול לתחילת השורה (--) לפי הצורך.
לדוגמה, מהעזרה שמוצגת למעלה לגבי 'הוספת ארגונים' אפשר לציין שם הארגון באחד מהשניים:
- שימוש בשורת הפקודה -o
מתג:
> apigee-adminapi.sh orgs -o testOrg - הגדרת משתנה סביבה בשם ORG:
> ייצוא ORG=testOrg
> apigee-adminapi.sh orgs
אם משמיטים פרמטרים כלשהם מהפקודה, כלי השירות יציג הודעת שגיאה. שמתאר את הפרמטרים החסרים. לדוגמה, אם משמיטים את משתנה הסביבה --host או --host שמציין כשתיצרו ארגון, תופיע הודעת השגיאה הבאה:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
שני פרמטרים נפוצים שאתם מגדירים לעיתים קרובות כמשתני סביבה הם כתובת האימייל של האדמין במערכת sys הכתובת וכתובת ה-IP של שרת הניהול:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
העברת קובץ אל apigee-adminapi.sh חברת תשתיות
חלק מפקודות השירות apigee-adminapi.sh שתואמים לקריאות ל-PUT ול-POST API שמקבלות גוף בקשה. לדוגמה, יצירת כתובת אתר וירטואלית תואם לקריאה ל-POST API שדורשת מידע על המארח הווירטואלי ב גוף הבקשה.
כשמשתמשים בכלי apigee-adminapi.sh כדי יוצרים מארח וירטואלי, או כל פקודה שמקבלת גוף בקשה, אפשר להעביר המידע הנדרש בשורת הפקודה, כפי שמוצג בהמשך:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005
לחלופין, אפשר להעביר קובץ שמכיל את אותו המידע שנכלל בבקשה בגוף ה-POST. לדוגמה, הפקודה הבאה מקבלת קובץ שמגדיר את המארח הווירטואלי:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
שבו הקובץ vhostcreate מכיל את גוף ה-POST של הקריאה. בדוגמה הזו, מדובר בגוף בקשה בפורמט XML:
<VirtualHost name="myVHostUtil"> <HostAliases> <HostAlias>192.168.56.101:9005</HostAlias> </HostAliases> <Interfaces/> <Port>9005</Port> </VirtualHost>
הצגת מידע על תוצאות ניפוי הבאגים ועל ה-API
משתמשים באפשרות --debug כדי השירות apigee-adminapi.sh כדי להציג מידע מפורט על הפקודה. המידע הזה כולל את פקודת ה-cURL שנוצר על ידי הכלי apigee-adminapi.sh כדי לבצע את הפעולה.
לדוגמה, בפקודה הזו נעשה שימוש באפשרות --debug:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
הפלט הבא יוצג, כולל פקודת ה-cURL שנוצרה:
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code} -u ***oo@bar.com:***** http://localhost:8080/v1/o -d <Organization name="testOrg2" type="paid"/> * About to connect() to localhost port 8080 (#0) * Trying ::1... connected * Connected to localhost (::1) port 8080 (#0) * Server auth using Basic with user 'foo@bar.com' > POST /v1/o HTTP/1.1 > Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5 > User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1 Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2 > Host: localhost:8080 > Accept: */* > Content-Type: application/xml > Content-Length: 43 > } [data not shown] < HTTP/1.1 201 Created < Content-Type: application/json < Date: Tue, 03 May 2016 02:08:32 GMT < Content-Length: 291 < { [data not shown] * Connection #0 to host localhost left intact * Closing connection #0