apigeectl

‫apigeectl הוא ממשק שורת פקודה (CLI) להתקנה ולניהול של Apigee Hybrid באשכול Kubernetes. מידע על הורדה והתקנה של apigeectl זמין במאמר הורדה והתקנה של apigeectl.

היקפים להחלת apigeectl

באמצעות flags של apigeectl אתם קובעים לאילו היקפים הפקודה מחילה שינויים בהגדרות. סקירה כללית של ההיקפים בסביבת זמן הריצה של Apigee Hybrid זמינה במאמר סקירה כללית של הגדרת שירות זמן הריצה.

היקףרכיביםapigeectl דגל
אחסון Cassandra --datastore
אחסון בזיכרון Redis --redis
סביבה Runtime
Synchronizer
UDCA		 --all-envs
--env
ארגון Apigee Connect Agent
MART
Watcher		 --org
דיווח Logger
Metrics		 --telemetry

התחביר של apigeectl

apigeectl [command] [flags]

כאשר:

  • ‫command: מציינים את הפעולה שרוצים לבצע. רשימה מלאה של הפקודות מופיעה במאמר פקודות apigeectl.

  • ‫flags: מציין את הפרמטרים של הפקודה. רשימה מלאה של הדגלים מופיעה במאמר apigeectl flags.

פקודות apigeectl

בטבלה הבאה מפורטות הפקודות של apigeectl:

פקודה תיאור
apply

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

‫apigeectl apply בלי דגלים יחיל שינויים על כל הרכיבים באשכול.

דגלים של apigeectl: --all-envs, --datastore, --dry-run, --env, -f, --file-override-config, --help, --org, --print-yaml, --redis, --settings virtualhosts, --telemetry,--verbose

check‑ready

בודקת את הסטטוס של הפודים של רכיב ההיברידי. כשכל תרמילי הרכיבים מוכנים, מוצגת ההודעה 'All containers ready'. בסקריפטים אוטומטיים, הפקודה יוצאת עם סטטוס 0 כשכל הקונטיינרים מוכנים. אם יש לפחות פוד אחד שלא מוכן, הפקודה יוצאת עם סטטוס 1.

‫apigeectl flags: -f, --file-override-config, --help, --verbose

delete

מחיקת רכיבים היברידיים מהאשכול. כדי להסיר את כל הרכיבים, משתמשים בדגל --all. אם לא מציינים את --all, רק הרכיבים הספציפיים ל-Apigee מוסרים (הרכיבים שהותקנו עם apigeectl init לא נמחקים). רכיבים ספציפיים ל-Apigee הם רכיבים שמותקנים באמצעות הפקודה apply.

‫apigeectl delete בלי דגלים אופציונליים מחילה את הפקודה delete על כל הרכיבים שנפרסו באשכול.

apigeectl diagnostic delete -f OVERRIDES_FILE מוחק את מרחב השמות apigee-diagnostic שנוצר על ידי apigeectl diagnostic. הסימון -f / --file-override-config נדרש עם apigeectl diagnostic delete

דגלים של apigeectl: --all, --all-envs, --datastore, --env, -f, --file-override-config, --help, --org, --redis, --telemetry, --verbose

diagnostic

מפעיל את כלי איסוף האבחון, שאוסף נתוני אבחון על רכיבי Kubernetes של מופע Apigee Hybrid לפי דרישה, ומאחסן אותם בקטגוריות של Google Cloud Storage.

כדי להשתמש בכלי לאיסוף נתונים לצורך אבחון, צריך קטגוריה בשם ב-Google Cloud Storage, חשבון שירות עם התפקיד Storage Admin וקטע diagnostic: שנוסף לקובץ overrides. כך עושים זאת:

כשמפעילים את כלי איסוף האבחון, הוא יוצר מרחב שמות של Kubernetes בשם apigee-diagnostic. צריך למחוק את הקובץ הזה באמצעות apigeectl diagnostic delete לפני שמפעילים שוב את הכלי לאיסוף נתונים לצורך אבחון.

מפעילים את הכלי לאיסוף נתוני אבחון: 

apigeectl diagnostic -f OVERRIDES_FILE

מחיקת כלי לאיסוף נתוני אבחון: 

apigeectl diagnostic delete -f OVERRIDES_FILE

דגלים של apigeectl: --file-override-config

encode

מחזירה רשימה של שמות מקודדים של כל האובייקטים מסוג ApigeeDeployments בארגון שצוין או בסביבה שצוינה בארגון שצוין. השמות המקודדים כוללים את שם הרכיב עם שם מגובב של הארגון, ואם משתמשים בדגל --env, גם שם מגובב של הסביבה. ‫Apigee hybrid יוצר שמות מגובבים של ארגונים וסביבות כדי למנוע התנגשויות במרחב השמות.

חובה להשתמש ב---org org-name או גם ב---org org-name וגם בדגלים --env env-name עם encode. לדוגמה:

./apigeectl encode --org hybrid-example
List of ApigeeDeployments are:
  apigee-connect-agent-hybrid-example-6a82f8a
  apigee-mart-hybrid-example-6a82f8a
  apigee-watcher-hybrid-example-6a82f8a
 
./apigeectl encode --org hybrid-example --env example-env
List of ApigeeDeployments are:
  apigee-runtime-hybrid-example-example-env-9e87e2d
  apigee-synchronizer-hybrid-example-example-env-9e87e2d
  apigee-udca-hybrid-example-example-env-9e87e2d

דגלים של apigeectl: --env, --org

help עזרה אונליין בנושא Prints.
init

הכלי מתקין את Apigee Operators ואת CRDs במרחב השמות apigee-system.

מריצים את apigeectl init אחרי התקנה חדשה או שדרוג, לפני שמריצים את apigeectl apply.

‫apigeectl flags: -f, --file-override-config, --help, --verbose

version מדפיס את פרטי הגרסה של ה-CLI.

הדגל apigeectl: --help

התראות apigeectl

בטבלה הבאה מפורטים הדגלים של apigeectl:

סימון תיאור
--all ‫delete בלבד: מחיקת כל ההתקנה של Apigee hybrid, למעט ASM ‏ (Istio) ו-cert-manager מהאשכול.
--all-envs

הפקודה apigeectl מופעלת על כל הסביבות בארגון שצוין בקובץ התצורה של ההחלפות.
--datastore

ההגדרה חלה על היקף מאגר הנתונים (Cassandra).
‑‑dry‑run מבצע את הפקודה שצוינה בלי לשנות את האשכול. אפשר להשתמש באפשרות הזו עם ‑‑print-yaml כדי להוציא את מפרט האובייקט שעבר רינדור לקובץ.

צריך להשתמש ב-‑‑dry‑run עם אחד משני הערכים הבאים, בהתאם לגרסה של kubectl שמופעלת. משתמשים בפקודה gcloud version כדי לבדוק את הגרסה של kubectl:

  • ‫kubectl גרסה 1.17.x או גרסה ישנה יותר: ‑‑dry‑run=true
  • ‫kubectl גרסה 1.18.x ואילך: ‑‑dry‑run=client
--env env-name

התצורה מוחלת על הסביבה שצוינה. הדגל הזה יחיל את ההגדרה על רכיבים בהיקף הסביבה: apigee-runtime, ‏ apigee-synchronizer ו-apigee-udca.

צריך להשתמש ב---env עם הדגל --org. לדוגמה: 

apigeectl apply --org hybrid-example --env example-env \
      -f overrides/overrides.yaml
‑f
‑‑file‑override‑config		 מציינים קובץ YAML שמכיל מאפייני תצורה בהתאמה אישית לפריסה היברידית. ערך ברירת המחדל הוא ./overrides.yaml. נדרש קובץ של שינויים חריגים לפקודות apply,‏ check-ready,‏ delete ו-init.

חובה לציין את הנתיב המלא באמצעות הדגל הזה. מידע נוסף זמין במאמר בנושא ניהול רכיבים של מישור זמן הריצה.
-h
--help		 הצגת עזרה לגבי הפקודה.
--org

התצורה חלה על הארגון שצוין. הדגל הזה יחיל את ההגדרה על רכיבי היקף הארגון apigee-connect-agent, ‏ apigee-mart ו-apigee-watcher.
--print‑yaml מדפיס את הפלט של תבנית ההגדרות האישיות ל-stdout. דוגמה לשימוש בדגל הזה מופיעה במאמר הדפסת ההגדרה לקובץ.
--redis

ההגדרה חלה על היקף אחסון הנתונים בזיכרון (Redis).
--restore

‫(Introduced in v1.6.6) משחזר את Cassandra לתמונת מצב שנשמרה בעבר, שצוינה על ידי המאפיין snapshotTimestamp בתצורת restore של הקובץ overrides.yaml. הגיבוי משוחזר מהקטגוריה של Cloud Storage או משרת מרוחק, בהתאם להגדרת backup בקובץ overrides.yaml. מידע נוסף זמין במאמר בנושא שחזור אזור מגיבוי.
-s
‑‑settings virtualhosts

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

לדוגמה, אם מבצעים שינוי בהגדרות של virtualhosts בקובץ הביטולים, אפשר להחיל אותו על האשכול באמצעות הפקודה הבאה:

apigeectl apply -f my-overrides.yaml --settings virtualhosts \
    --org example-org --env example-env
--telemetry

ההגדרה חלה על רכיבי טלמטריה כמו apigee-logger ו-apigee-metrics.
--verbose

הדפסת יומנים מפורטים ל-std err.

דוגמאות

אתחול הגדרת האשכול

מחילים את הגדרות רכיבי הדרישות המוקדמות על האשכול באמצעות init. צריך להריץ את הפקודה init לפני apply. 

apigeectl init -f my_overrides.yaml

החלת הגדרת האשכול

כדי להחיל הגדרות היברידיות על אשכול Kubernetes, משתמשים בפקודה apply. בפעם הראשונה שמריצים את apply, כל רכיבי זמן הריצה ההיברידיים נוצרים באשכול. אם מבצעים שינויים בהגדרות, מריצים מחדש את apply כדי להחיל רק את השינויים, או משתמשים בדגלים כדי להחיל שינויים רק על היקף ספציפי.

בדוגמה הבאה מוסבר איך להחיל את ההגדרה של רכיבי מישור זמן ריצה היברידי על האשכול:

apigeectl apply -f my_overrides.yaml

החלת ההגדרה על רכיב יחיד

כדי להגביל את הפקודה apply לרכיב מסוים, משתמשים בדגלים שמתוארים במאמר דגלים של apigeectl.

בדוגמה הבאה, ההגדרה חלה רק על רכיב Cassandra:

apigeectl apply --datastore -f my_overrides.yaml

הדפסת התצורה לקובץ

אם מנסים לנפות באגים בבעיה בהתקנה, כדאי להדפיס את כל הגדרות האשכול לקובץ כדי לבדוק את הגדרות התצורה. הדגל --print-yaml מדפיס את ההגדרה ההיברידית ל-stdout, והדגל --dry-run מאפשר להריץ את הפקודה בלי לבצע שינויים באשכול.

apigeectl apply -f my_overrides.yaml --dry-run=client --print-yaml > apigee-hybrid.yaml

בדיקת הסטטוס של ה-pod

בדוגמה הבאה נבדק הסטטוס של פודים שנפרסו באשכול:

apigeectl check-ready -f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

מחיקת ההיברידי מהאשכול

הדוגמה הבאה מוחקת רק את רכיבי זמן הריצה ההיברידיים באשכול Kubernetes. כדי למחוק את כל התוויות, משתמשים בדגל --all.

apigeectl delete -f my_overrides.yaml