חומרי עזר

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

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

פקודות קישור

הקישור משייך שירות שנפרס לרשת Istio למוצר Apigee API. ב-CLI אפשר ליצור, להסיר, לפרט ולאמת קישורים.

הוספת קישור

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

Usage

בענן הציבורי של Edge:

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

לענן פרטי של Edge:

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 לענן פרטי.
-o, --org מחרוזת (חובה) ארגון של Apigee. עליכם להיות מנהלי חשבון ארגוני.
-p, --password מחרוזת (נדרש לאימות בסיסי בלבד) הסיסמה שלך ל-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. במקרה כזה, לא צריך יותר להזין את הסיסמה בשורת הפקודה. למידע נוסף, ראו שימוש ב- .netrc לפרטי כניסה.
-r, --runtime מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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 הקשורים לשירות המרוחק.

Usage

בענן הציבורי של Edge:

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

לענן פרטי של Edge:

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 לענן פרטי.
-o, --org מחרוזת (חובה) ארגון של Apigee. עליכם להיות מנהלי חשבון ארגוני.
-p, --password מחרוזת (נדרש לאימות בסיסי בלבד) הסיסמה שלך ל-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. במקרה כזה, לא צריך יותר להזין את הסיסמה בשורת הפקודה. למידע נוסף, ראו שימוש ב- .netrc לפרטי כניסה.
-r, --runtime מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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:

הסרת קישור

צריך להסיר את הקישור של שירות מרוחק ל-Envoy ממוצר של ממשק API.

Usage

בענן הציבורי של Edge:

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

לענן פרטי של Edge:

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 לענן פרטי.
-o, --org מחרוזת (חובה) ארגון של Apigee. עליכם להיות מנהלי חשבון ארגוני.
-p, --password מחרוזת (נדרש לאימות בסיסי בלבד) הסיסמה שלך ל-Apigee. אפשר גם לציין את הסיסמה בקובץ .netrc. במקרה כזה, לא צריך יותר להזין את הסיסמה בשורת הפקודה. למידע נוסף, ראו שימוש ב- .netrc לפרטי כניסה.
-r, --runtime מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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, הפקודה תבדוק את כל המוצרים המוגבלים.

Usage

בענן הציבורי של Edge:

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

לענן פרטי של Edge:

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 לענן פרטי.
-o, --org מחרוזת (חובה) ארגון של Apigee. עליכם להיות מנהלי חשבון ארגוני.
-r, --runtime מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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.

Usage

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

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

אם אתם משתמשים בענן פרטי של Edge:

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

פרמטרים

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

הדגל הזה מאפשר לציין את הנתיב לקובץ מפתח של חשבון שירות ב-Google Cloud, שבו לחשבון השירות יש את התפקיד Apigee Analytics Agent. המתאם משתמש ב-SA כדי להעלות נתוני ניתוח ישירות אל Apigee. אם משתמשים ב-Apigee 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) את כתובת ה-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 מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-URL בזמן הריצה של מכונת הענן הפרטי.
-s, --secret מחרוזת ההגדרה קובעת את הסוד שמוחזר מהפקודה apigee-remote-service-cli provision.
--strength int (אופציונלי) מציין את עוצמת ההצפנה של אישורי SSL שמשמשים להקצאת המתאם. ברירת מחדל 2048
-t, --token מחרוזת (היברידי בלבד) אסימון OAuth או SAML של Apigee.
-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.

Usage

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

תיאור

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

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

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

פרמטרים

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

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

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

דוגמה

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

פקודות אסימון

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

יצירת אסימון JWT

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

Usage

ב-Edge Public Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
בענן פרטי של Edge:
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 מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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 באמצעות הפקודה הזו. כדאי גם לקרוא על בדיקת אסימון.

Usage

ב-Edge Public Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
בענן פרטי של Edge:
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 מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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 של "istio" בסביבה או בארגון של Apigee Edge. בנוסף, המפתח הציבורי הישן נשמר יחד עם הערך של מזהה המפתח המקורי שלו.

Usage

אם אתם משתמשים ב-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 מחרוזת (Private Cloud בלבד) ההגדרה קובעת את כתובת ה-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, הערך של המכונה יהיה זהה לכתובת ה-URL של management (לדוגמה: http://192.162.55.100). לדוגמה, ב-Edge Public Cloud:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
לדוגמה, בענן הפרטי של Edge:
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