תקציר בנושא ה-CLI של gcloud

רשימת פקודות go-to ל-Google Cloud CLI, כלי שורת הפקודה הראשי של Google Cloud.

(המסמך כולל גם: סעיף של הנחיות ראשוניות, סעיף הסברים על הפקודות, וקובץ PDF להדפסה.)

תקציר

תחילת העבודה

תחילת העבודה עם ה-CLI של gcloud.

• gcloud init: אתחול, הרשאות והגדרת ה-CLI של gcloud.
• gcloud version: גרסת התצוגה והרכיבים המותקנים.
• gcloud components install: התקנת רכיבים ספציפיים.
• ‫gcloud components update: עדכון ה-CLI של gcloud לגרסה האחרונה.
• ‫gcloud config set project: הגדרת פרויקט ברירת מחדל לעבודה. Google Cloud
• gcloud info: הצגת פרטי הסביבה הנוכחית של ה-CLI של gcloud.

עזרה

תמיד אפשר לקבל עזרה ב-CLI של gcloud.

• gcloud help: חיפוש מונחים ספציפיים במסמכי העזר של ה-CLI של gcloud.
• gcloud feedback: שליחת משוב לצוות ה-CLI של gcloud.
• gcloud topic: חומרי עזרה נוספים בנושאים שאינם קשורים לפקודות כמו נגישות, סינון ופורמט.

התאמה אישית

אפשר לשנות את ההגדרות האישיות לנוחיותכם ב-CLI של gcloud באמצעות המאפיינים.

• gcloud config set: הגדרת נכס (כמו אזור/מחשוב) להגדרות האישיות הנוכחיות.
• gcloud config get: שליפת הערך של נכס ב-CLI של gcloud.
• gcloud config list: הצגת כל המאפיינים של ההגדרות הנוכחיות.
• gcloud config configurations create: יצירת מערך הגדרות אישיות עם שם.
• gcloud config configurations list: הצגת רשימה של כל ההגדרות האישיות הזמינות.
• gcloud config configurations activate: מעבר למערך הגדרות אישיות שקיבל שם.

הרשאות ופרטי כניסה

תנו או בטלו הרשאות ל-CLI של gcloud ונהלו את פרטי הכניסה.

• ‫gcloud auth login: הרשאת גישה ל-Google Cloud עבור ה-CLI של gcloud עם פרטי הכניסה של משתמשGoogle Cloud והגדרת החשבון הנוכחי למצב פעיל.
• ‫gcloud auth activate-service-account: הרשאת גישה ל- Google Cloud כמו gcloud auth login אבל עם פרטי כניסה של חשבון שירות.
• gcloud auth application-default: ניהול ‎(ADC) Application Default Credentials לספריות לקוח ב-Cloud.
• gcloud auth list: רשימה של כל החשבונות עם פרטי כניסה.
• gcloud auth print-access-token: הצגת אסימון הגישה של החשבון הנוכחי.
• gcloud auth revoke: הסרת פרטי הכניסה של חשבון.

פרויקטים

נהלו את מדיניות הגישה לפרויקט.

• gcloud projects describe: הצגת מטא-נתונים של פרויקט (כולל המזהה).
• gcloud projects add-iam-policy-binding: הוספת מדיניות IAM שמקושרת לפרויקט ספציפי.

IAM

הגדרת העדפות של ניהול זהות וגישה (IAM) וחשבונות שירות.

• gcloud iam list-grantable-roles: רשימת תפקידי IAM להקצאה במשאב.
• gcloud iam roles create: יצירת תפקיד מותאם אישית לפרויקט או לארגון.
• gcloud iam service-accounts create: יצירת חשבון שירות לפרויקט.
• gcloud iam service-accounts add-iam-policy-binding: הוספת מדיניות IAM שמקושרת לחשבון שירות.
• gcloud iam service-accounts set-iam-policy-binding: החלפת הקישור של מדיניות ה-IAM הנוכחית.
• gcloud iam service-accounts keys list: רשימת מפתחות של חשבונות שירות.

Docker ו-Google Kubernetes Engine ‏(GKE)

נהלו אפליקציות בקונטיינרים ב-Kubernetes.

• gcloud auth configure-docker: רישום ה-CLI של gcloud ככלי עזר של מסמך אימות ל-Docker.
• gcloud container clusters create: יצירת אשכול להרצת קונטיינרים של GKE.
• gcloud container clusters list: רשימת אשכולות להרצת קונטיינרים של GKE.
• gcloud container clusters get-credentials: עדכון kubeconfig כדי לקבל kubectl לשימוש באשכול GKE.
• gcloud container images list-tags: רשימת תגים ותקציר מטא-נתונים לקובץ אימג' של קונטיינר.

מכונות וירטואליות ו-Compute Engine

צרו, הריצו ונהלו מכונות וירטואליות בתשתית של Google Cloud .

• gcloud compute zones list: רשימת אזורי Compute Engine.
• gcloud compute instances create: יצירת מופע של מכונה וירטואלית.
• gcloud compute instances describe: הצגת פרטי המופע של מכונה וירטואלית.
• gcloud compute instances list: רשימת כל המופעים של מכונות וירטואליות בפרויקט.
• gcloud compute disks snapshot: יצירת קובץ snapshot של דיסקי אחסון מתמיד (persistent disks).
• gcloud compute snapshots describe: הצגת הפרטים של קובץ snapshot.
• gcloud compute snapshots delete: מחיקת קובץ snapshot.
• gcloud compute ssh: חיבור מופע של מכונה וירטואלית באמצעות SSH.

ללא שרת (serverless) ו-App Engine

בניית אפליקציות שניתנות להרחבה משמעותית בפלטפורמה מנוהלת ללא שרת

• gcloud app deploy: פריסת קוד האפליקציה וההגדרות האישיות לשרת של App Engine.
• gcloud app versions list: רשימה של כל הגרסאות של כל השירותים שנפרסו לשרת של App Engine.
• gcloud app browse: פתיחת האפליקציה הנוכחית בדפדפן אינטרנט.
• gcloud app create: יצירת אפליקציה של App Engine בתוך הפרויקט הנוכחי.
• gcloud app logs read: הצגת יומני האפליקציה העדכניים של ה-App Engine.

שונות

פקודות שעשויות להיות שימושיות

• gcloud kms decrypt: פענוח קובצי מידע מוצפן (ciphertext) (לקובץ של טקסט פשוט) באמצעות מפתח של Cloud Key Management Service.
• gcloud logging logs list: רשימת היומנים של הפרויקט שלכם.
• gcloud sql backups describe: הצגת מידע על גיבוי של מופע Cloud SQL.
• gcloud sql export sql: ייצוא נתונים ממופע של Cloud SQL לקובץ SQL.

הנחיות ראשוניות

תקציר הנחיות לתחילת העבודה עם ה-CLI של gcloud

התקנת ה-CLI של Google Cloud

התקינו את ה-CLI של Google Cloud בקלות בעזרת הוראות ההתקנה האלו.

דגלים, ארגומנטים, ועוד תוספות נפלאות

ארגומנטים יכולים להיות ארגומנטים תלויי מיקום או דגלים:

• ארגומנטים תלויי מיקום: מוגדרים אחרי שם הפקודה; הסדר של ארגומנטים תלויי מיקום צריך להישמר.

• דגלים: מוגדרים אחרי ארגומנטים תלויי מיקום; סדר הדגלים לא משנה.

  דגל יכול להיות אחד משני הערכים הבאים:

  • צמד של שם-ערך (--foo=bar), או
  • בוליאני (--force/no-force).

  בנוסף דגלים יכולים להיות:

  • חובה
  • אפשרות: אם דגל שמופיע כאפשרות אינו מוגדר, משתמשים בערך ברירת המחדל

דגלים כלליים

בדגלים מסוימים ניתן להשתמש בכל מקום ב-CLI של gcloud, למשל:

• --help: כאשר מתעורר ספק, הדגל הזה מציג עזרה מפורטת לגבי פקודה.
• --project: אם משתמשים בפרויקט שונה מהפרויקט הנוכחי.
• --quiet: השבתת ההנחיות האינטראקטיביות (ושימוש בערכי ברירת מחדל לקלט).
• --verbosity: דגל זה יכול לקבוע את דרגת המלל כ-debug, info, warning, error, critical, ו-none.
• --version: הצגת הפרטים של גרסת ה-gcloud.
• --format: מגדיר את פורמט הפלט כ- config, csv, default, diff, disable, flattened, get, json, list, multi, none, object, table, text, value, או yaml.

ניקוי התוצאות

הפיקו את המרב מהפלט באמצעות הדגלים סינון,‏פירמוט‏, הגבלה ומיון לפי.

למופעים של Compute Engine עם הקידומת us ולא סוג המכונה f1-micro:

gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"

לרשימת פרויקטים שנוצרו אחרי 15 באוגוסט 2018, מסודרת מהישן לחדש ביותר, מוצגת כטבלה עם עמודות של מספר פרויקט, מזהה פרויקט וזמן היצירה עם תאריכים ושעות לפי אזור הזמן המקומי:

gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime

לרשימה של עשרה מופעי Compute Engine עם התווית my-label (מכל ערך שהוא):

gcloud compute instances list --filter="labels.my-label:*" --limit=10

הסבר על פקודות

אלו הדפוסים שעליהם מבוססות הפקודות ב-CLI של gcloud; שימושיים במציאת פקודות באופן עצמאי.

מציאת פקודות ה-CLI של gcloud

ל-CLI של gcloud יש מבנה בצורה של עץ; צמתים ללא עלים הם קבוצות של פקודות וצמתים עם עלים הם פקודות. (בנוסף, השלמה באמצעות לחיצה על מקש Tab פועלת בפקודות ובמשאבים!)

רוב הפקודות של gcloud בנויות בפורמט הבא:

gcloud + release level (optional) + component + entity + operation + positional args + flags

לדוגמה: gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a

רמת הגרסה

רמת הגרסה מתייחסת לסטטוס הגרסה של הפקודה.

לדוגמה: alpha לפקודות אלפא, beta לפקודות בטא, ואין צורך ברמת גרסה לפקודות GA.

רכיב

המונח רכיב מתייחס לשירותים השונים של Google Cloud .

לדוגמה: compute בשביל Compute Engine, app בשביל App Engine וכן הלאה.

ישות

המונח ישות מתייחס לצורת הרבים של אלמנט או של אוסף אלמנטים שתחת רכיב.

לדוגמה: disks, firewalls, images, instances, regions, zones למחשוב

פעולה

המונח פעולה מתייחס לצורת פועל הציווי של הפעולה שצריך לבצע על היישות.

לדוגמה: פעולות נפוצות הן describe, list, create/update, delete/clear, import, export, copy, remove, add, reset, restart, restore, run ו-deploy.

ארגומנטים תלויי מיקום

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

דוגמה: <INSTANCE_NAMES> הוא הארגומנט הנדרש תלוי המיקום של gcloud compute instances create.

דגלים

המונח דגלים מתייחס לארגומנטים הנוספים, --flag-name(=value), שמועברים לפקודה אחרי הארגומנטים תלויי המיקום.

דוגמה: --machine-type=<MACHINE_TYPE> ו---preemptible הם דגלים אפשריים עבור gcloud compute instances create.