ניהול תכונות באמצעות מטא-נתונים

בדף הזה מוסבר איך לנהל חלק מהתכונות של מכונות Workbench ב-Gemini Enterprise Agent Platform, באמצעות שינוי של צמדי המפתח/ערך של המטא-נתונים של המכונה.

מפתחות מטא-נתונים

בטבלה הבאה מפורט מידע על התכונות ומפתחות המטא-נתונים שלהן.

תכונה תיאור מפתח המטא-נתונים ערכים קבילים וערכי ברירת מחדל
הפעלת Cloud Storage FUSE בקובץ אימג' של קונטיינר

הפקודה הזו טוענת את /dev/fuse לקונטיינר ומפעילה את gcsfuse לשימוש בקונטיינר.

container-allow-fuse
  • ‫true: מפעיל את Cloud Storage FUSE.
  • ‫false (ברירת המחדל): לא מפעיל את Cloud Storage FUSE.
nbconvert

מאפשרת לייצא ולהוריד תיקיות Notebook כסוג קובץ אחר.

notebook-disable-nbconvert
  • ‫true: משבית את nbconvert.
  • ‫false (ברירת המחדל): הפעלת nbconvert.
מחיקה לאשפה

שימוש בהתנהגות האשפה של מערכת ההפעלה כשמוחקים מ-JupyterLab.

notebook-enable-delete-to-trash
  • ‫true: מאפשרת למחוק לאשפה.
  • ‫false (ברירת המחדל): שימוש בהתנהגות ברירת המחדל של JupyterLab.
Managed Service for Apache Spark

מאפשרת גישה לקרנלים של Managed Service for Apache Spark.

מידע נוסף מופיע במאמר יצירת מכונה שמופעל בה Managed Service for Apache Spark.

disable-mixer
  • ‫true: השבתת הגישה לקרנלים של Managed Service for Apache Spark.
  • ‫false (ברירת המחדל): מאפשרת גישה לקרנלים של Managed Service for Apache Spark.
BigQuery

הפעלת הפלאגין BigQuery JupyterLab, שמספק סייר של מערכי נתונים, עורך שאילתות SQL והיסטוריית שאילתות ב-JupyterLab.

disable-bigquery
  • ‫true: השבתת הפלאגין של BigQuery JupyterLab.
  • ‫false (ברירת המחדל): הפעלת הפלאגין של BigQuery JupyterLab.
כיבוי במצב של חוסר פעילות

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

מידע נוסף מופיע במאמר כיבוי במצב חוסר פעילות.

idle-timeout-seconds מספר שלם שמייצג את משך הזמן ללא פעילות בשניות. ערך ברירת המחדל הוא 10800 שניות (180 דקות).
מאפייני אורחים

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

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

enable-guest-attributes
  • ‫true (ברירת מחדל): הפעלת מאפייני אורח.
  • ‫false: השבתת מאפייני האורחים.
  • תיקונים מתוזמנים למערכת ההפעלה

    תזמון עדכונים אוטומטיים של מערכת ההפעלה של המכונה. הפעולה הזו מפעילה את שירות השדרוג האוטומטי של Debian, והיא רלוונטית רק לתמונות שמבוססות על VM.

    install-unattended-upgrades
    • ‫true: הפעלה של עדכונים אוטומטיים של מערכת ההפעלה.
    • false (ברירת המחדל): השבתה של עדכונים אוטומטיים של מערכת ההפעלה.
    משתמש Jupyter בהתאמה אישית

    מציינת את השם של משתמש ברירת המחדל של Jupyter. ההגדרה הזו קובעת את שם התיקייה של תיקיות ה-Notebook. לדוגמה, במקום ספריית ברירת המחדל /home/jupyter/, אפשר לשנות את הספרייה ל-/home/CUSTOM_NAME. מפתח המטא-נתונים הזה לא משפיע על הגישה למכונה.

    jupyter-user מחרוזת. ערך ברירת המחדל הוא jupyter.
    הקובץ בהורדה

    מאפשרת להוריד קבצים מ-JupyterLab.

    notebook-disable-downloads
    • ‫true: השבתת הורדת קבצים.
    • ‫false (ברירת המחדל): מאפשרת הורדת קבצים.
    גישת רוט (Root)

    הפעלת גישת רוט (Root).

    notebook-disable-root
    • ‫true: השבתת גישת רוט (Root).
    • ‫false (ברירת מחדל): הפעלת גישת root.
    גישה לטרמינל

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

    notebook-disable-terminal
    • ‫true: משבית את הגישה למסוף.
    • ‫false (ברירת מחדל): הפעלת הגישה לטרמינל.
    שדרוגים מתוזמנים

    תזמון שדרוגים אוטומטיים של המכונה.

    notebook-upgrade-schedule לוח הזמנים השבועי או החודשי שהגדרתם, בפורמט unix-cron. לדוגמה, 00 19 * * MON פירושו פעם בשבוע ביום שני, בשעה 19:00 לפי שעון גריניץ' (GMT). התכונה הזו מושבתת כברירת מחדל. כדי להשבית את התכונה הזו או להשאיר אותה מושבתת, צריך להשמיט את מפתח המטא-נתונים notebook-upgrade-schedule מההגדרות, או להגדיר את הערך שלו כמחרוזת ריקה ("").
    סקריפט לאחר ההפעלה

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

    post-startup-script ‫URI של סקריפט לאחר הפעלה ב-Cloud Storage, לדוגמה: gs://bucket/hello.sh. התכונה הזו מושבתת כברירת מחדל.
    התנהגות סקריפט לטעינה בזמן ההפעלה

    ההגדרה קובעת מתי ואיך הסקריפט לטעינה בזמן ההפעלה יפעל אחרי ההפעלה.

    post-startup-script-behavior
    • ‫run_once (ברירת המחדל): מריץ את הסקריפט לטעינה בזמן ההפעלה פעם אחת אחרי יצירת המכונה או השדרוג שלה.
    • ‫run_every_start: הפעלת הסקריפט לאחר ההפעלה אחרי כל הפעלה.
    • ‫download_and_run_every_start: הורדה מחדש של הסקריפט לטעינה בזמן ההפעלה מהמקור שלו, והרצת הסקריפט אחרי כל הפעלה.
    דיווח על תקינות האירוע

    בדיקת תקינות כל 30 שניות למדדי VM.

    report-event-health
    • ‫true (ברירת מחדל): הפעלת דיווח על תקינות האירועים.
    • ‫false: השבתת הדיווח על תקינות האירוע.
    הפעלה של JupyterLab 4 או מעבר ל-JupyterLab 3

    מפעילים את JupyterLab 3. ‫JupyterLab 4 מופעל כברירת מחדל.

    enable-jupyterlab4
    • ‫true (ברירת מחדל): הפעלה של JupyterLab 4.
    • ‫false: הפעלה של JupyterLab 3.
    Antigravity CLI

    הפעלה של Antigravity CLI, עם משבצת מרכז האפליקציות, מיומנויות Notebook, פלאגין ו-%%agy cell magic, במכונות שמשתמשות בתמונת Debian 12‏ (workbench-instances-2603) או בגרסה מאוחרת יותר. הערך מוחל על המכונה כשהיא מופעלת.

    enable-antigravity
    • ‫true (ברירת המחדל למכונות חדשות): מפעיל את Antigravity CLI.
    • ‫false: משבית את Antigravity CLI.

    סדר ההרצה של סקריפטים לטעינה בזמן ההפעלה

    אם אתם משתמשים בכמה סקריפטים לטעינה בזמן ההפעלה במכונה של Agent Platform Workbench, הם פועלים בסדר הבא:

    1. ‫startup-script: מופעל ראשון בכל הפעלה אחרי ההפעלה הראשונית.
    2. ‫startup-script-url: פועל שני בכל הפעלה אחרי ההפעלה הראשונית.
    3. workbench-startup-scripts: פועל אחרי שסקריפטי האתחול של Compute Engine‏ (startup-script ו-startup-script-url) מסתיימים.
    4. ‫post-startup-script: פועל אחרי שהשלב workbench-startup-scripts מסתיים.

    שימו לב: במפתח המטא-נתונים post-startup-script, צריך לספק את הסקריפט בתור URI של Cloud Storage. אי אפשר לספק את תוכן הסקריפט ישירות כערך.

    מטא-נתונים שמנוהלים על ידי Compute Engine

    חלק ממפתחות המטא-נתונים מוגדרים מראש על ידי Compute Engine. מידע נוסף מופיע במאמר מפתחות מטא-נתונים מוגדרים מראש.

    מפתחות מטא-נתונים מוגנים

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

    מפתחות המטא-נתונים השמורים כוללים, בין היתר:

    • agent-health-check-interval-seconds
    • agent-health-check-path
    • cos-update-strategy
    • custom-container-image
    • custom-container-payload
    • data-disk-uri
    • dataproc-allow-custom-clusters
    • dataproc-cluster-name
    • dataproc-configs
    • dataproc-default-subnet
    • dataproc-locations-list
    • dataproc-machine-types-list
    • dataproc-notebooks-url
    • dataproc-region
    • dataproc-service-account
    • disable-check-xsrf
    • euc-enabled
    • framework
    • generate-diagnostics-bucket
    • generate-diagnostics-file
    • generate-diagnostics-options
    • google-logging-enabled
    • image-url
    • install-monitoring-agent
    • install-nvidia-driver
    • installed-extensions
    • last_updated_diagnostic
    • last_updated_diagnostics
    • notebooks-api
    • notebooks-api-version
    • notebooks-examples-location
    • notebooks-location
    • proxy-backend-id
    • proxy-byoid-url
    • proxy-mode
    • proxy-status
    • proxy-url
    • proxy-user-mail
    • report-container-health
    • report-event-url
    • report-notebook-metrics
    • report-system-health
    • report-system-status
    • resource-url
    • restriction
    • serial-port-logging-enable
    • service-account-mode
    • shutdown-script
    • title
    • use-collaborative
    • user-data
    • version

    יצירת מכונה עם מטא-נתונים ספציפיים

    אתם יכולים ליצור מכונה של Agent Platform Workbench עם מטא-נתונים ספציפיים באמצעות מסוף Google Cloud ,‏ Google Cloud CLI,‏ Terraform או Notebooks API.

    המסוף

    כשיוצרים מכונה של Agent Platform Workbench, אפשר להוסיף מטא-נתונים בקטע Environment שב-Advanced options.

    הכפתור Add metadata בקטע Environment

    gcloud

    כשיוצרים מכונה של Agent Platform Workbench, אפשר להוסיף מטא-נתונים באמצעות הפקודה הבאה:

    gcloud workbench instances create INSTANCE_NAME --metadata=KEY=VALUE

    Terraform

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

    כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.

    resource "google_workbench_instance" "default" {
      name     = "workbench-instance-example"
      location = "us-central1-a"
    
      gce_setup {
        machine_type = "n1-standard-1"
        vm_image {
          project = "cloud-notebooks-managed"
          family  = "workbench-instances"
        }
        metadata = {
          key = "value"
        }
      }
    }

    Notebooks API

    כדי לנהל את התכונות המתאימות, משתמשים ב-method‏ instances.create עם ערכי מטא-נתונים.

    עדכון המטא-נתונים של מכונה

    אפשר לעדכן את המטא-נתונים של מכונה של Agent Platform Workbench באמצעות מסוף Google Cloud ,‏ Google Cloud CLI,‏ Terraform או Notebooks API.

    המסוף

    כדי לעדכן את המטא-נתונים של מכונה של Agent Platform Workbench:

    1. נכנסים לדף Instances במסוף Google Cloud .

      כניסה לדף Instances

    2. ברשימת המכונות, לוחצים על השם של המכונה שרוצים לעדכן.

    3. בדף Instance details, לוחצים על Software and security.

    4. בקטע Metadata, מעדכנים את צמדי המפתח/ערך של המטא-נתונים שרוצים לשנות.

    5. לוחצים על שליחה.

    gcloud

    כדי לעדכן את המטא-נתונים במכונה של Agent Platform Workbench, משתמשים בפקודה הבאה:

    gcloud workbench instances update INSTANCE_NAME --metadata=KEY=VALUE

    Terraform

    אתם יכולים לשנות את צמדי המפתח/ערך של המטא-נתונים כדי לנהל את התכונות התואמות במכונות של Agent Platform Workbench.

    כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.

    resource "google_workbench_instance" "default" {
      name     = "workbench-instance-example"
      location = "us-central1-a"
    
      gce_setup {
        machine_type = "n1-standard-1"
        vm_image {
          project = "cloud-notebooks-managed"
          family  = "workbench-instances"
        }
        metadata = {
          key = "updated_value"
        }
      }
    }

    Notebooks API

    כדי לנהל את התכונות המתאימות, משתמשים ב-method‏ instances.patch עם ערכי מטא-נתונים ו-gce_setup.metadata ב-updateMask.

    הסרת מטא-נתונים ממכונה

    אפשר להסיר מטא-נתונים ממכונה של Agent Platform Workbench באמצעות מסוף Google Cloud ,‏ Google Cloud CLI,‏ Terraform או Notebooks API.

    המסוף

    כדי להסיר מטא-נתונים ממכונה של Agent Platform Workbench:

    1. נכנסים לדף Instances במסוף Google Cloud .

      כניסה לדף Instances

    2. ברשימת המכונות, לוחצים על שם המכונה שרוצים לשנות.

    3. בדף Instance details, לוחצים על Software and security.

    4. בקטע Metadata, מימין לצמד המפתח/ערך שרוצים למחוק, לוחצים על  Delete.

    5. לוחצים על שליחה.

    gcloud

    כדי להסיר מטא-נתונים ממכונה של Agent Platform Workbench, משתמשים בפקודה הבאה:

    gcloud workbench instances update INSTANCE_NAME --metadata=KEY

    Terraform

    אתם יכולים להסיר צמדים של מפתח/ערך במטא-נתונים כדי לנהל את התכונות התואמות של מכונה ב-Agent Platform Workbench.

    כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.

    resource "google_workbench_instance" "default" {
      name     = "workbench-instance-example"
      location = "us-central1-a"
    
      gce_setup {
        machine_type = "n1-standard-1"
        vm_image {
          project = "cloud-notebooks-managed"
          family  = "workbench-instances"
        }
        metadata = {
        }
      }
    }

    Notebooks API

    כדי להסיר את התכונה המתאימה, משתמשים ב-updateMask ב-gce_setup.metadata וב-instances.patch עם ערך מטא-נתונים שמוגדר כמחרוזת ריקה.