ארגון משאבים באמצעות תוויות

תוויות הן צמדי מפתח/ערך שאפשר להשתמש בהן ב- Google Cloud כדי לקבץ משאבים קשורים או משויכים. לדוגמה, ב-Compute Engine אפשר להשתמש בתוויות כדי לקבץ מכונות וירטואליות בקטגוריות כמו ייצור, הכנה או פיתוח, וכך לחפש משאבים ששייכים לכל שלב פיתוח.

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

לפני שמתחילים

  • קוראים את התיעוד בנושא דיסקים של אחסון מתמיד.
  • אפשר לקרוא את מאמר התיעוד בנושא תמונות.
  • אם עדיין לא עשיתם את זה, תצטרכו להגדיר אימות. אימות הוא תהליך שבו מאמתים את הזהות שלכם כדי לקבל גישה לממשקי API ולשירותים של Google Cloud . כדי להריץ קוד או דוגמאות מסביבת פיתוח מקומית, אפשר לבצע אימות ל-Compute Engine באחת מהדרכים הבאות:

    צריך לבחור את הכרטיסייה הרלוונטית לאופן שבו תכננתם להשתמש בדוגמאות בדף הזה:

    המסוף

    כשמשתמשים במסוף Google Cloud כדי לגשת לשירותים Google Cloud ולממשקי ה-API, לא צריך להגדיר אימות.

    gcloud

    1. התקינו את ה-CLI של Google Cloud. אחר כך, מאתחלים את ה-CLI של Google Cloud באמצעות הפקודה הבאה: 

      gcloud init

      אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

  • הגדרת אזור ותחום כברירת מחדל

    • REST

    כדי להשתמש בסביבת פיתוח מקומית בדוגמאות של API בארכיטקטורת REST שבדף הזה, צריך להשתמש בפרטי הכניסה שאתם נותנים ל-CLI של gcloud.

      התקינו את ה-CLI של Google Cloud.

      אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

    מידע נוסף מופיע במאמר אימות לשימוש ב-REST במסמכי האימות של Google Cloud .

מהן תוויות?

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

הדרישות לגבי תוויות

התוויות שמוחלות על משאב צריכות לעמוד בדרישות הבאות:

  • אפשר להוסיף לכל משאב עד 64 תוויות.
  • כל תווית חייבת להיות צמד מפתח/ערך.
  • האורך המינימלי של המפתחות הוא תו אחד, והאורך המקסימלי הוא 63 תווים. המפתחות לא יכולים להיות ריקים. הערכים יכולים להיות ריקים, והאורך המקסימלי שלהם הוא 63 תווים.
  • המפתחות והערכים יכולים להכיל רק אותיות קטנות, ספרות, קווים תחתונים ומקפים. כל התווים צריכים להיות בקידוד UTF-8, ואפשר להשתמש בתווים בינלאומיים. המפתחות צריכים להתחיל באות קטנה או בתו בינלאומי.
  • החלק של המפתח בתווית חייב להיות ייחודי בתוך משאב יחיד. עם זאת, אפשר להשתמש באותו מפתח עם כמה משאבים.

המגבלות האלה חלות על המפתח והערך של כל תווית, וגם על המשאבים Google Cloud הבודדים שיש להם תוויות. אין הגבלה על מספר התוויות שאפשר להחיל על כל המשאבים בפרויקט.

שימושים נפוצים בתוויות

ריכזנו כאן כמה תרחישי שימוש נפוצים בתוויות:

  • תוויות של צוותים או מרכזי עלויות: אפשר להוסיף תוויות שמבוססות על צוות או על מרכז עלויות כדי להבחין בין מקרים שבהם צוותים שונים הם הבעלים של מופעים (לדוגמה, team:research ו-team:analytics). אפשר להשתמש בסוג הזה של תוויות לניהול חשבונות או לתקצוב.

  • תוויות של רכיבים: לדוגמה, component:redis,‏ component:frontend,‏ component:ingest ו-component:dashboard.

  • תוויות של סביבה או שלב: לדוגמה, environment:production ו-environment:test.

  • תוויות מצב: לדוגמה, state:active,‏ state:readytodelete ו-state:archive.

  • תוויות בעלות: משמשות לזיהוי הצוותים שאחראים על הפעולות, לדוגמה: team:shopping-cart.

  • תוויות של מכונות וירטואליות: אפשר לצרף תווית למכונה וירטואלית. תגי מכונה וירטואלית שהגדרתם בעבר מופיעים כתווית ללא ערך.

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

תוויות ותגים

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

שימוש בתוויות ב-Compute Engine

אפשר להחיל תוויות על המשאבים הבאים של Compute Engine:

  • מכונות וירטואליות (VM)
  • תמונות
  • דיסקים לאחסון מתמיד
  • תמונות מצב של Persistent Disk

אפשר גם להשתמש בתוויות ברכיבים קשורים Google Cloud כמו אלה:

  • קטגוריות של Cloud Storage
  • משאבי רשת:
    • כללי העברה שמשמשים עם מאזני עומסים פנימיים של אפליקציות (לא נתמכים כללי העברה של מאזני עומסים אחרים)
    • מנהרות VPN
    • כתובות IP חיצוניות סטטיות

לדוגמה, אפשר להוסיף את התוויות הבאות כצמדי מפתח/ערך למשאבים:

{
 "labels": {
    "vmrole": "webserver",
    "environment": "production",
    "location": "west",...
    }
 }

יצירת מקורות מידע עם תוויות

כשיוצרים משאב חדש, אפשר להחיל עליו תוויות.

המסוף

  1. עוברים לדף המשאב שרוצים ליצור.

  2. בקטע תוויות, לוחצים על הוספת תווית.

  3. ממשיכים בתהליך היצירה.

gcloud

כדי להוסיף תווית, משתמשים בפקודת המשנה create עם הדגל --labels. אפשר להוסיף תוויות למשאבי Compute Engine באמצעות הפקודות הבאות של gcloud:

דוגמה

gcloud compute instances create ... \
    --labels webserver=backend,media=images

REST

ב-API, במהלך בקשת POST להוספת משאב חדש, מוסיפים את המאפיין labels בגוף הבקשה כדי להחיל תוויות על המשאב החדש.

לדוגמה, קטע הקוד הבא שולח בקשת POST ליצירת מכונת VM עם התוויות webserver:backend ו-media:images:

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances

{
 "name": "myVM",
 "machineType": "zones/us-central1-f/machineTypes/custom-2-15360-ext",
  ...,
 "labels": {
   "webserver": "backend",
   "media": "images"
  }
}

הוספה או עדכון של תוויות למשאבים קיימים

אפשר להוסיף תוויות או לעדכן תוויות קיימות במשאבים באמצעותGoogle Cloud המסוף, ה-CLI של gcloud או Compute Engine API. כדי להוסיף או לעדכן תוויות לכללי העברה, משתמשים ב-CLI של gcloud או ב-Compute Engine API.

המסוף

  1. עוברים לדף המשאב שרוצים להוסיף לו תוויות.

    • למכונות וירטואליות, עוברים אל VM instances.
    • כדי לראות את תמונות המצב, עוברים אל תמונות מצב.
    • לתמונות, עוברים אל תמונות.
    • לגבי דיסקים, עוברים אל Disks.
    • לכתובות IP חיצוניות סטטיות, אפשר לעבור אל External IP addresses.
    • למנהרות VPN, עוברים אל VPN.

  2. מסמנים את תיבות הסימון לצד המשאבים שרוצים להוסיף להם תווית.

  3. כדי להרחיב את העמודה 'תוויות', לוחצים על הצגת חלונית המידע.

  4. בחלונית, לוחצים על תוויות.

  5. כדי להוסיף תוויות, לוחצים על הוספת תווית ומוסיפים את צמד המפתח/ערך.

  6. כדי לעדכן תוויות, בוחרים את התוויות הקיימות ומשנים את הערכים שלהן.

  7. שומרים את השינויים.

gcloud

כדי להוסיף או לשנות תווית, משתמשים בפקודת המשנה update עם הדגל --update-labels. כדי לעדכן את התוויות של משאבי Compute Engine, אפשר להשתמש בפקודות gcloud הבאות:

דוגמה

gcloud compute disks update example-disk \
    --update-labels backend=webserver,media=images

אם מספקים מפתח תווית שכבר קיים, Google Cloud CLI מעדכן את המפתח הקיים עם ערך התווית החדש. אם מספקים מפתח חדש, הכלי מוסיף אותו לרשימת התוויות.

REST

כדי להוסיף או לעדכן תוויות, שולחים בקשת POST לשיטה setLabels של המשאב עם טביעת האצבע העדכנית ורשימה מלאה של התוויות להוספה:

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

לדוגמה, בקטע הקוד הבא מבוצעת בקשת POST למופע של מכונה וירטואלית כדי להגדיר את התוויות environment:test ו-an-existing-tag:yes:

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances/example-instance/setLabels

{
 "labels": {
  "environment": "test",
  "an-existing-tag": "yes"
 },
 "labelFingerprint": "42WmSpB8rSM="
}

הצגת תוויות

אפשר לראות את התוויות של המשאבים באמצעות Google Cloud המסוף, ה-CLI של gcloud או Compute Engine API. כדי לראות את התוויות של כללי העברה, משתמשים ב-CLI של gcloud או ב-Compute Engine API.

המסוף

  1. עוברים לדף המשאב.

    • למכונות וירטואליות, עוברים אל VM instances.
    • כדי לראות את תמונות המצב, עוברים אל תמונות מצב.
    • לתמונות, עוברים אל תמונות.
    • לגבי דיסקים, עוברים אל Disks.
    • לכתובות IP חיצוניות סטטיות, עוברים אל External IP addresses.
    • למנהרות VPN, עוברים אל VPN.

  2. לוחצים על המשאב כדי לראות את הפרטים שלו.

  3. מאתרים את התוויות.

gcloud

כדי להציג תוויות, משתמשים בפקודת המשנה describe. אפשר לראות את התוויות של משאבי Compute Engine באמצעות הפקודות הבאות של gcloud:

דוגמה

gcloud compute disks describe example-disk

הפלט מכיל את התוויות:

...
id: '5047929990219134234'
kind: compute#disk
labelFingerprint: GHZ1Un209U=0
labels:
  environment: dev
  department: finance
...

REST

כדי לאחזר תוויות, שולחים GET בקשה למשאב הבא:

לדוגמה, קטע הקוד הבא שולח בקשת GET לאחזור תוויות של מכונה וירטואלית:

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME

מחליפים את מה שכתוב בשדות הבאים:

  • ‫PROJECT_ID: מזהה הפרויקט
  • ‫ZONE: האזור של המכונה הווירטואלית
  • ‫VM_NAME: השם של ה-VM

קבלת טביעת אצבע של תווית לבקשות API

כשמעדכנים או מוסיפים תוויות ב-API, צריך לספק את טביעת האצבע העדכנית של התוויות עם הבקשה, כדי למנוע התנגשויות עם בקשות אחרות. טביעת אצבע נדרשת רק לבקשות API. לא נדרשת טביעת אצבע עבור Google Cloud console ועבור הכלי Google Cloud CLI.

כדי לקבל את הגרסה העדכנית של labelsFingerprint, צריך לשלוח בקשת GET למקורות המידע הבאים:

לדוגמה, קטע הקוד הבא מחזיר labelsFingerprint למכונת VM:

GET https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances/example-instance

התשובה מכילה את המאפיין labelFingerprint:

200 OK

{
 "kind": "compute#instance",
 "id": "4392196237934605253",
 "creationTimestamp": "2015-09-15T14:05:16.475-07:00",
 "zone": "https://content.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f",
 "status": "RUNNING",
 ...
 "labels": {
  "environment": "test"
 },
 "labelFingerprint": "p1ty_9HoBk0="
}

הסרת תווית

אפשר להסיר תוויות ממשאבים באמצעות מסוף Google Cloud , ה-CLI של gcloud או Compute Engine API. כדי להסיר תוויות מכללי העברה, צריך להשתמש ב-CLI של gcloud או ב-Compute Engine API.

המסוף

  1. עוברים לדף המשאב שרוצים להסיר ממנו תוויות.

    • למכונות וירטואליות, עוברים אל VM instances.
    • כדי לראות את תמונות המצב, עוברים אל תמונות מצב.
    • לתמונות, עוברים אל תמונות.
    • לגבי דיסקים, עוברים אל Disks.
    • לכתובות IP חיצוניות סטטיות, עוברים אל External IP addresses.
    • למנהרות VPN, עוברים אל VPN.

  2. מסמנים את תיבות הסימון לצד המשאבים שרוצים להסיר מהם את התוויות.

  3. כדי להרחיב את העמודה 'תוויות', לוחצים על הצגת חלונית המידע.

  4. כדי למחוק תווית, לוחצים על מחיקה.

  5. שומרים את השינויים.

gcloud

כדי להוסיף או לשנות תווית, משתמשים בפקודת המשנה update עם הדגל --remove-labels. כדי להסיר תוויות מהמשאבים של Compute Engine, משתמשים בפקודות הבאות של gcloud:

דוגמה

gcloud compute disks update example-disk \
    --remove-labels backend,media

REST

כדי להסיר תוויות, שולחים בקשת POST לשיטה setLabels של המשאב הבא עם טביעת האצבע העדכנית ורשימה מלאה של התוויות להחלה:

כדי להסיר את כל התוויות, מציינים את labelsFingerprint הנוכחי ושולחים רשימה ריקה של תוויות. אפשר גם לציין רשימה של התוויות שרוצים לשמור (ולהשמיט את התוויות שרוצים להסיר). לדוגמה, קטע הקוד הבא מסיר את כל התוויות מה-VM:

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances/example-instance/setLabels

{
 "labels": { },
 "labelFingerprint": "42WmSpB8rSM="
}

סינון חיפושים באמצעות תוויות

אפשר לחפש את המשאבים ולסנן את התוצאות לפי תוויות באמצעותGoogle Cloud המסוף, ה-CLI של gcloud או Compute Engine API. כדי לסנן כללי העברה לפי תוויות, משתמשים ב-CLI של gcloud או ב-Compute Engine API.

המסוף

  1. עוברים לדף המשאב שרוצים לקבל רשימה מסוננת של משאבים.

    • למכונות וירטואליות, עוברים אל VM instances.
    • כדי לראות את תמונות המצב, עוברים אל תמונות מצב.
    • לתמונות, עוברים אל תמונות.
    • לגבי דיסקים, עוברים אל Disks.
    • לכתובות IP חיצוניות סטטיות, עוברים אל External IP addresses.
    • למנהרות VPN, עוברים אל VPN.

  2. אם מתבקשים, בוחרים פרויקט ולוחצים על המשך.

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

    לדוגמה, כדי להציג רק משאבים עם התווית env:dev, אפשר להזין אחת מהאפשרויות הבאות:

    • מזינים את המפתח: env
    • מזינים את הערך: dev
    • מזינים את צמד המפתח/ערך: env:dev

gcloud

כדי לסנן לפי תוויות, משתמשים בפקודת המשנה list של המשאבים הבאים עם הדגל --filter:

הערך של הדגל --filter צריך להיות בפורמט labels.KEY=VALUE. לדוגמה, אם רוצים לסנן לפי תווית עם env כמפתח ו-dev כערך, אפשר להריץ את הפקודה הבאה:

gcloud compute instances list \
    --filter labels.env=dev

למידע נוסף על תחביר המסננים ב-CLI של gcloud, אפשר לעיין במאמרי העזרה בנושא gcloud topic filters.

REST

כדי לסנן משאבים, שולחים בקשת GET לשיטה list של המשאבים הבאים וכוללים את שדה הסינון:

לדוגמה, כדי לרשום את כל המכונות הווירטואליות בפרויקט myproject ובאזור us-central1-a עם תווית שיש לה צמד מפתח/ערך של env:dev, מגדירים את שדה המסנן ל-labels.env:dev בבקשת list. אם כוללים את שדה המסנן כפרמטר של מחרוזת שאילתה, צריך להשתמש בערך פרמטר שמקודד בכתובת URL,‏ filter=labels.env%3Adev:

GET https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances?filter=labels.env%3Adev

מידע נוסף זמין במאמרי העזרה של filter בתיעוד של Compute Engine API.

הקשר בין תוויות של מכונות וירטואליות לבין תגים

בעבר, תוויות ותגים היו קשורים זה לזה. לדוגמה, אם הוספתם את התווית webserver:test למכונה וירטואלית, Compute Engine הוסיף אוטומטית את התג webserver למכונה הווירטואלית.

עכשיו, תוויות ותגים הם נפרדים. אם יוצרים תווית במכונה וירטואלית,‏ Compute Engine לא יוצר תג למכונה הווירטואלית. אם אתם צריכים ליצור תג במכונה וירטואלית, אתם צריכים ליצור את התג באופן ידני.

לסקירה כללית על התגים

המאמרים הבאים