חומרי עזר

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X.
מידע

ממשק שורת הפקודה (CLI) של apigee-remote-service-cli עוזר לכם להקצות ולנהל את Apigee Adapter ל-Envoy.

פקודות מחייבות

איגוד מקשר בין שירות שנפרס ב-Istio mesh לבין מוצר Apigee API. ה-CLI מאפשר ליצור, להסיר, להציג ולאמת קישורים.

הוספת קישור

הוספת קישור של יעד שירות מרוחק למוצר API.

שימוש

ב-Edge Public Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

ב-Edge Private Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

כאשר:

  • ‫target_name הוא השם של שירות מרוחק שאליו רוצים לקשר את המוצר.
  • ‫product_name הוא שם המוצר שאליו רוצים לקשר את השירות.

דגלים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשר חיבורי שרת לא מאובטחים כשמשתמשים ב-SSL
--legacy מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge Cloud. הוא מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה של Edge Cloud.
--mfa אסימון הרשאה רב-שלבי של Apigee (לשימוש עם --legacy בלבד)
--opdk מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge for Private Cloud.
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-p, --password מחרוזת (נדרש רק לאימות בסיסי) הסיסמה שלכם ב-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. אם תעשו את זה, לא תצטרכו להזין את הסיסמה בשורת הפקודה. מידע נוסף זמין במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-t, --token מחרוזת (נדרש רק לאימות אסימוני OAuth) אסימון OAuth או SAML שיוצרים מפרטי החשבון ב-Apigee. מידע על יצירת אסימונים זמין במאמרים שימוש ב-get_token וגישה ל-API לניהול באמצעות SAML.
-u, --username מחרוזת (נדרש רק לאימות בסיסי) שם המשתמש שלכם ב-Apigee (בדרך כלל כתובת אימייל). אפשר גם לציין את שם המשתמש בקובץ .netrc. אם תעשו זאת, לא תצטרכו לספק את שם המשתמש בשורת הפקודה. אפשר לעיין גם במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

הצגת רשימת הקישורים

רשימה של כל מוצרי ה-API שמקושרים לשירות המרוחק.

שימוש

ב-Edge Public Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

ב-Edge Private Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config..
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשר חיבורי שרת לא מאובטחים כשמשתמשים ב-SSL
--legacy מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge Cloud. הוא מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה של Edge Cloud.
--mfa אסימון הרשאה רב-שלבי של Apigee (לשימוש עם --legacy בלבד)
--opdk מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge for Private Cloud.
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-p, --password מחרוזת (נדרש רק לאימות בסיסי) הסיסמה שלכם ב-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. אם תעשו את זה, לא תצטרכו להזין את הסיסמה בשורת הפקודה. מידע נוסף זמין במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-t, --token מחרוזת (נדרש רק לאימות אסימוני OAuth) אסימון OAuth או SAML שיוצרים מפרטי החשבון ב-Apigee. מידע על יצירת אסימונים זמין במאמרים שימוש ב-get_token וגישה ל-API לניהול באמצעות SAML.
-u, --username מחרוזת (נדרש רק לאימות בסיסי) שם המשתמש שלכם ב-Apigee (בדרך כלל כתובת אימייל). אפשר גם לציין את שם המשתמש בקובץ .netrc. אם תעשו זאת, לא תצטרכו לספק את שם המשתמש בשורת הפקודה. אפשר לעיין גם במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

הסרת קישור

הסרת הקישור של Remote Service for Envoy ממוצר API.

שימוש

ב-Edge Public Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

ב-Edge Private Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

כאשר:

  • ‫target_name הוא השם של שירות מרוחק שרוצים לבטל את הקישור שלו למוצר.
  • ‫product_name הוא שם של מוצר שממנו רוצים לבטל את הקישור של היעד.

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשר חיבורי שרת לא מאובטחים כשמשתמשים ב-SSL
--legacy מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge Cloud. הוא מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה של Edge Cloud.
--mfa אסימון הרשאה רב-שלבי של Apigee (לשימוש עם --legacy בלבד)
--opdk מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge for Private Cloud.
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-p, --password מחרוזת (נדרש רק לאימות בסיסי) הסיסמה שלכם ב-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. אם תעשו את זה, לא תצטרכו להזין את הסיסמה בשורת הפקודה. מידע נוסף זמין במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-t, --token מחרוזת (נדרש רק לאימות אסימוני OAuth) אסימון OAuth או SAML שיוצרים מפרטי החשבון ב-Apigee. מידע על יצירת אסימונים זמין במאמרים שימוש ב-get_token וגישה ל-API לניהול באמצעות SAML.
-u, --username מחרוזת (נדרש רק לאימות בסיסי) שם המשתמש שלכם ב-Apigee (בדרך כלל כתובת אימייל). אפשר גם לציין את שם המשתמש בקובץ .netrc. אם תעשו זאת, לא תצטרכו לספק את שם המשתמש בשורת הפקודה. אפשר לעיין גם במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

אימות של קישור

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

שימוש

ב-Edge Public Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

ב-Edge Private Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

הפרמטר product_name הוא אופציונלי. אם לא מציינים שם מוצר, כל המוצרים המקושרים נבדקים.

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשר חיבורי שרת לא מאובטחים כשמשתמשים ב-SSL
--legacy מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge Cloud. הוא מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה של Edge Cloud.
--mfa אסימון הרשאה רב-שלבי של Apigee (לשימוש עם --legacy בלבד)
--opdk מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge for Private Cloud.
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-t, --token מחרוזת (נדרש רק לאימות אסימוני OAuth) אסימון OAuth או SAML שיוצרים מפרטי החשבון ב-Apigee. מידע על יצירת אסימונים זמין במאמרים שימוש ב-get_token וגישה ל-API לניהול באמצעות SAML.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

פקודת עזרה

יש עזרה אונליין לכל הפקודות של apigee-remote-service-cli. פשוט מקלידים:

apigee-remote-service-cli help

כדי לקבל עזרה לגבי פקודה מסוימת, מקלידים:

apigee-remote-service-cli [command] help

לדוגמה:

apigee-remote-service-cli provision help

פקודת הקצאת הרשאות

הפקודה apigee-remote-service-cli provision מתקינה שרת proxy בארגון Apigee Edge, מגדירה תעודה ויוצרת פרטי כניסה שתצטרכו כדי להגדיר את Apigee Adapter ל-Envoy.

שימוש

אם אתם משתמשים ב-Edge Public Cloud:

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

אם אתם משתמשים ב-Edge Private Cloud:

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

פרמטרים

פרמטרים סוג תיאור
--analytics-sa מחרוזת הדגל הזה זמין רק בהתקנות של Apigee hybrid ו-Apigee ב-Google Cloud.

משתמשים בדגל הזה כדי לציין את הנתיב לקובץ המפתח של חשבון שירות ב-Google Cloud, שבו לחשבון השירות יש את התפקיד Apigee Analytics Agent. ה-SA משמש את המתאם להעלאה ישירה של נתוני ניתוח ל-Apigee. אם אתם משתמשים ב-Apigee Hybrid, האפשרות הזו מאפשרת לכם להתקין את זמן הריצה של Hybrid באשכול אחד ואת המתאם באשכול אחר.

-c, --config מחרוזת הנתיב לקובץ ההגדרות של Apigee Remote Service. אפשר לעיין גם במאמר בנושא שימוש באפשרות --config.
-e, --environment מחרוזת (חובה) סביבה בארגון שלכם.
-f, --force-proxy-install (אופציונלי) מאלץ את התקנת ה-proxy של remote-service מחדש אם הוא כבר מותקן בארגון.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
-k, --key מחרוזת מציינת את המפתח שמוחזר מהפקודה apigee-remote-service-cli provision.
--legacy מגדירים את הדגל הזה אם משתמשים ב-Apigee Edge Cloud. הוא מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה של Edge Cloud.
--mfa אסימון הרשאה רב-שלבי של Apigee (לשימוש עם --legacy בלבד)
-m, --management מחרוזת (חובה אם אתם משתמשים ב-Apigee Private Cloud) כתובת ה-URL הבסיסית של ניהול Apigee. ברירת מחדל: https://api.enterprise.apigee.com
-n, --namespace מחרוזת הגדרת הפליטה כ-Envoy ConfigMap במרחב השמות שצוין. ברירת מחדל: apigee
--opdk מחרוזת ‫Apigee OPDK.
-o, --organization מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-p, --password מחרוזת (נדרש רק לאימות בסיסי) הסיסמה שלכם ב-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. אם תעשו את זה, לא תצטרכו להזין את הסיסמה בשורת הפקודה. מידע נוסף זמין במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
--rotate-int int אם n > 0, יוצרים מפתח פרטי חדש ושומרים n מפתחות ציבוריים (רק בהצפנה היברידית)
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-s, --secret מחרוזת מציינים את הסוד שמוחזר מהפקודה apigee-remote-service-cli provision.
--strength int (אופציונלי) מציינת את עוצמת ההצפנה של אישורי SSL שמשמשים להקצאת המתאם. ברירת המחדל היא 2048.
-t, --token מחרוזת (ב-Hybrid בלבד) טוקן Apigee OAuth או SAML.
-u, --username מחרוזת (נדרש רק לאימות בסיסי) שם המשתמש שלכם ב-Apigee (בדרך כלל כתובת אימייל). אפשר גם לציין את שם המשתמש בקובץ .netrc. אפשר לעיין גם במאמר בנושא שימוש ב-‎ .netrc לפרטי כניסה.
-v, --verbose (אופציונלי) יוצר פלט מפורט.
--virtual-hosts מחרוזת המדיניות הזו עוקפת את המארחים הווירטואליים שמוגדרים כברירת מחדל, שהם default,secure. משתמשים באפשרות הזו אם הגדרתם מארחים וירטואליים עבור הארגון והסביבה שלכם ב-Edge, שאינם ברירות המחדל האלה. מידע נוסף על מארחים וירטואליים זמין במאמרי העזרה של Edge.
--years int (אופציונלי) מספר השנים עד שפג התוקף של אישור ה-SSL שמשמש להקצאת משאבים. ברירת מחדל: 1

דוגמה

חשוב לשמור את הפלט של הפקודה provision בקובץ, שמשמש כקלט לפעולות אחרות של Apigee Adapter ל-Envoy.

דוגמה ל-Edge Public Cloud:

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

פקודת דוגמאות

יוצר קובצי תצורה לדוגמה לפריסות של Envoy או Istio מקומיות.

שימוש

apigee-remote-service-cli samples create [flags]

תיאור

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

אם משתמשים ב-Envoy מקורי, הפקודה מקבלת את מארח שירות היעד ואת השם הרצוי לאשכול שלו. הוא גם מגדיר חיבור SSL בהתאמה אישית מ-Envoy proxy לאשכול השירות המרוחק, אם מסופקת תיקייה שמכילה את tls.key ואת tls.crt דרך --tls.

אם משתמשים ב-Istio, שבו שרת ה-Proxy של Envoy פועל כ-sidecar, אם היעד לא מצוין, ייווצר לדוגמה httpbin. אחרת, אתם אחראים להכנת קובצי ההגדרות שקשורים לפריסה של שירותי היעד.

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-f, --force להכריח את המערכת להחליף את הספרייה הקיימת.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--host המארח של שירות היעד (ברירת המחדל היא httpbin.org)
-n, --name שם שירות היעד (ברירת המחדל היא httpbin)
--out הספרייה שבה ייצרו קובצי תצורה לדוגמה. ברירת מחדל: ./samples
-t, --template

שם התבנית. אם אתם מבצעים פריסה של Istio (היברידית בלבד), בוחרים באחת מהאפשרויות הזמינות של Istio. משתמשים באפשרות המותאמת להטמעות מותאמות של Envoy. האפשרויות הזמינות הן:

  • ‫istio-1.6 (ברירת מחדל)
  • istio-1.7
  • native
--tls הספרייה שבה מאחסנים את קובצי ה-TLS key ו-crt.

דוגמה

apigee-remote-service-cli samples create -c ./config.yaml

פקודות טוקן

אתם יכולים להשתמש באסימון JWT כדי לבצע קריאות מאומתות ל-proxy ל-API במקום להשתמש במפתח API. פקודות האסימונים מאפשרות ליצור, לבדוק ולשנות אסימוני JWT למטרה הזו.

יצירת טוקן JWT

אפשר להשתמש באסימון JWT כדי לשלוח קריאות מאומתות לשרת proxy של API אל יעד שירות מרוחק. אפשר לעיין גם במאמר בנושא שימוש באימות שמבוסס על JWT.

שימוש

ב-Edge Public Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
ב-Edge Private Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשרות לחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

פלט

אם הפעולה תצליח, יוצג אסימון JST שדומה לזה:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

בדיקת טוקן JWT

אפשר לבדוק את אסימון ה-JWT באמצעות הפקודה הזו. אפשר לעיין גם במאמר בדיקת אסימון.

שימוש

ב-Edge Public Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
ב-Edge Private Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשרות לחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

פלט

אם הפעולה בוצעה ללא שגיאות, הפלט ייראה כך:
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

סיבוב של טוקן JWT

בשלב מסוים אחרי שיוצרים JWT בפעם הראשונה, יכול להיות שיהיה צורך לשנות את זוג המפתחות הציבוריים/הפרטיים שמאוחסן ב-Apigee Edge במפת הערכים של המפתחות (KVM) המוצפנת. התהליך הזה של יצירת זוג מפתחות חדש נקרא רוטציית מפתחות. כשמבצעים רוטציה של מפתחות, נוצר זוג חדש של מפתחות פרטיים/ציבוריים והוא מאוחסן ב-KVM ‏(Key-Value Map) ‏istio בארגון או בסביבה שלכם ב-Apigee Edge. בנוסף, המפתח הציבורי הישן נשמר יחד עם ערך מזהה המפתח המקורי שלו.

שימוש

אם אתם משתמשים ב-Edge Public Cloud:
‫
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
אם אתם משתמשים ב-Edge Private Cloud:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

פרמטרים

פרמטרים סוג תיאור
-c, --config מחרוזת (חובה) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-e, --env מחרוזת (חובה) סביבה בארגון שלכם.
-h, --help הצגת עזרה לגבי פרמטרים של פקודה.
--insecure אפשר חיבורי שרת לא מאובטחים כשמשתמשים ב-SSL
--truncate int מספר האישורים לשמירה ב-jwks (ברירת מחדל היא 2)
-o, --org מחרוזת (חובה) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r, --runtime מחרוזת (רק בענן פרטי) מציינת את כתובת ה-URL של זמן הריצה של המופע של הענן הפרטי.
-v, --verbose (אופציונלי) יוצר פלט מפורט.

דוגמה

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

פלט

certificate successfully rotated

שימוש ב-‎ .netrc לפרטי כניסה

‫apigee-remote-service-cli מאחזר באופן אוטומטי את username ואת password (לאימות בסיסי כשצריך) מקובץ .netrc בספריית הבית, אם אתם משתמשים ב-Edge Public Cloud ויש לכם רשומה למכונה api.enterprise.apigee.com. אם אתם משתמשים ב-Apigee Private Cloud, הערך של המכונה זהה לכתובת ה-URL של management (לדוגמה: http://192.162.55.100). לדוגמה ב-Edge Public Cloud:
‫
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
לדוגמה, ב-Edge Private Cloud:
machine http://192.162.55.100
login jdoe@google.com
password abc123

פקודת גרסה

מדפיסים את גרסת ה-CLI.

apigee-remote-service-cli version

שימוש באפשרות הפקודה --config

האפשרות --config מציינת את המיקום של קובץ התצורה שנוצר על ידי הפקודה provision. יתרון חשוב של האפשרות הזו הוא שאפשר לדלג על רוב הפרמטרים האחרים של הפקודה, שה-CLI שולף מקובץ התצורה. האפשרויות כוללות:
  • ארגון
  • environment
  • זמן ריצה
  • סרטונים
  • לא מאובטח
  • מרחב שמות
  • מדור קודם
  • opdk

לדוגמה, אפשר להריץ את הפקודה provision כך:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

קובץ תצורה

בקטע הזה מוצגת דוגמה לקובץ הגדרות עם כל האפשרויות הזמינות.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s