apigeectl הוא ממשק שורת פקודה (CLI) להתקנה ולניהול של Apigee Hybrid באשכול Kubernetes.
מידע על הורדה והתקנה של apigeectl זמין במאמר הורדה והתקנה של apigeectl.
התחביר של apigeectl
apigeectl [command] [flags]
כאשר:
command: מציינים את הפעולה שרוצים לבצע. רשימה מלאה של הפקודות מופיעה במאמר פקודות apigeectl.
flags: מציין את הפרמטרים של הפקודה. רשימה מלאה של הדגלים מופיעה במאמר apigeectl flags.
פקודות apigeectl
בטבלה הבאה מפורטות הפקודות של apigeectl:
| פקודה | תיאור |
|---|---|
apply |
הפקודה מחילה הגדרות על רכיבי זמן הריצה של Apigee Hybrid באשכול Kubernetes.
משתמשים בדגל אם לא מציינים את הדגל |
check‑ready |
בודקת את הסטטוס של הפודים של רכיב ההיברידי. כשכל תרמילי הרכיבים מוכנים, מוצגת ההודעה 'All containers ready'. בסקריפטים אוטומטיים, הפקודה יוצאת עם סטטוס 0 כשכל הקונטיינרים מוכנים. אם יש לפחות פוד אחד שלא מוכן, הפקודה יוצאת עם סטטוס 1. אם לא מציינים את הדגל |
delete |
מחיקת רכיבים היברידיים מהאשכול. כדי להסיר את כל הרכיבים, משתמשים בדגל אם לא מציינים את הדגל |
help |
עזרה אונליין בנושא Prints. |
init |
החלת הגדרות לרכיבי חובה, כמו Istio ו-Apigee Deployment, על האשכול.
משתמשים בדגל |
version |
מדפיס את פרטי הגרסה של ה-CLI. |
התראות apigeectl
בטבלה הבאה מפורטים הדגלים של apigeectl:
| סימון | תיאור |
|---|---|
-c, --components |
מציין רכיב יחיד שהפקודה חלה עליו.
אם לא מציינים את הדגל הזה, הפקודה חלה על כל הרכיבים (כל הפריסה) באשכול. הערכים האפשריים כוללים:
לדוגמה,
לחלופין, כדי לציין כמה רכיבים, מוסיפים ערכים מופרדים בפסיקים: |
--dry-run |
מבצעת את הפקודה שצוינה בלי לשנות את האשכול. אפשר להשתמש באפשרות הזו עם ‑‑print-yaml כדי להוציא את מפרט האובייקט שעבר עיבוד לקובץ.
|
‑f, ‑‑file‑override‑config |
מציינים קובץ YAML שמכיל מאפייני תצורה בהתאמה אישית לפריסה היברידית. ערך ברירת המחדל הוא
./overrides.yaml. נדרש קובץ של שינויים חריגים לפקודות apply, check-ready, delete ו-init.
חובה לציין את הנתיב המלא באמצעות הדגל הזה. מידע נוסף זמין במאמר בנושא ניהול רכיבים של מישור זמן הריצה. |
-h, --help |
הצגת עזרה לגבי הפקודה. |
--print-yaml |
מדפיס את הפלט של תבנית ההגדרות האישיות ל-stdout. דוגמה לשימוש בדגל הזה מופיעה במאמר הדפסת ההגדרה לקובץ. |
-s, --settings |
מציינת הגדרה שהפקודה חלה עליה. בשלב הזה, הדגל הזה
נתמך רק בהגדרה לדוגמה, אם מבצעים שינוי בהגדרות של apigeectl apply -f my-overrides.yaml --settings virtualhosts -c runtime |
דוגמאות
אתחול הגדרת האשכול
מחילים את הגדרות רכיבי הדרישות המוקדמות על האשכול באמצעות init.
צריך להריץ את הפקודה init לפני apply.
apigeectl init -f my_overrides.yaml
החלת הגדרת האשכול
כדי להחיל הגדרות היברידיות על אשכול Kubernetes, משתמשים בפקודה apply. בפעם הראשונה שמריצים את apply, כל רכיבי זמן הריצה ההיברידיים נוצרים באשכול. אם מבצעים שינויים בהגדרות, מריצים מחדש את הפקודה apply כדי להחיל רק את השינויים, או משתמשים בפקודה -c כדי להחיל רק רכיב ספציפי.
בדוגמה הבאה מוסבר איך להחיל את ההגדרה של רכיבי מישור זמן ריצה היברידי על האשכול:
apigeectl apply -f my_overrides.yaml
החלת ההגדרה על רכיב יחיד
כדי להגביל את הפקודה apply לרכיב מסוים, משתמשים בדגל -c, כמו שמתואר במאמר דגלים של apigeectl.
בדוגמה הבאה, ההגדרה חלה רק על רכיב ה-Synchronizer:
apigeectl apply -c synchronizer -f my_overrides.yaml
בדוגמה הבאה, ההגדרה חלה רק על רכיבי Cassandra ו-runtime:
apigeectl apply -c cassandra,runtime -f my_overrides.yaml
הדפסת התצורה לקובץ
אם מנסים לנפות באגים בבעיה בהתקנה, כדאי להדפיס את כל הגדרות האשכול לקובץ כדי לבדוק את הגדרות התצורה. הדגל --print-yaml מדפיס את ההגדרה ההיברידית ל-stdout, והדגל --dry-run מאפשר להריץ את הפקודה בלי לבצע שינויים באשכול.
apigeectl apply -f my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml
בדיקת הסטטוס של ה-pod
בדוגמה הבאה נבדק הסטטוס של פודים שנפרסו באשכול:
apigeectl check-ready All containers ready in namespace 'my-namespace'
מחיקת ההיברידי מהאשכול
הדוגמה הבאה מוחקת רק את רכיבי זמן הריצה ההיברידיים באשכול Kubernetes. כדי למחוק את כל התוויות, משתמשים בדגל --all.
apigeectl delete -f my_overrides.yaml