הגדרת ארגזי חול למשרות

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

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

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

  1. נכנסים לחשבון Google Cloud . אנחנו ממליצים למשתמשים חדשים ב- Google Cloudליצור חשבון כדי שיוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. מתקינים ומפעילים את ה-CLI של gcloud.
  7. יוצרים משימה ב-Cloud Run.

התפקידים הנדרשים

כדי לקבל את ההרשאות שדרושות להגדרת משימות ב-Cloud Run, בקשו מהאדמין להקצות לכם את תפקידי ה-IAM הבאים:

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

הפעלת ארגזי חול (sandbox)

כדי להפעיל ארגזי חול במשימות של Cloud Run, משתמשים ב-Google Cloud CLI, בהגדרת YAML או ב-Terraform:

gcloud

כדי ליצור או לעדכן את המשימה, מציינים את הדגל --sandbox-launcher:

  • כדי ליצור משימה, מריצים את הפקודה הבאה:

    gcloud beta run jobs create JOB --image IMAGE_URL --sandbox-launcher

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

  • כדי לעדכן משימה קיימת, מריצים את הפקודה הבאה:

    gcloud beta run jobs update JOB --sandbox-launcher

YAML

  1. אם אתם יוצרים משימה חדשה, דלגו על השלב הזה. אם מעדכנים משימה קיימת, מורידים את הגדרת ה-YAML שלה:

    gcloud run jobs describe JOB --format export > job.yaml
  2. מעדכנים את קובץ ה-YAML כך שיכלול את המאפיין sandboxLauncher שמוגדר כ-true בתוך הגדרת הקונטיינר:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - name: CONTAINER
                image: IMAGE_URL
                sandboxLauncher: true
    

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

    • ‫JOB: השם של המשימה ב-Cloud Run.
    • ‫CONTAINER: שם הקונטיינר.
    • ‫IMAGE_URL: הפניה לקובץ האימג' של הקונטיינר, לדוגמה us-docker.pkg.dev/cloudrun/container/job:latest
  3. יוצרים או מעדכנים את המשימה באמצעות הפקודה הבאה:

    gcloud run jobs replace job.yaml

    כברירת מחדל, הפקודה gcloud run jobs replace משתמשת בקובץ job.yaml אם הוא קיים.

Terraform

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

מוסיפים את הקוד הבא למשאב google_cloud_run_v2_job בתצורה של Terraform:
resource "google_cloud_run_v2_job" "default" {
  name     = "JOB"
  location = "REGION"

  template {
    template {
      containers {
        image            = "IMAGE_URL"
        sandbox_launcher = true
      }
    }
  }
}

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

  • ‫JOB: השם של המשימה ב-Cloud Run.
  • ‫REGION: האזור של Google Cloud . לדוגמה, europe-west1.
  • ‫IMAGE_URL: הפניה לקובץ האימג' של הקונטיינר, לדוגמה us-docker.pkg.dev/cloudrun/container/job:latest

ארגזי החול משתפים את המעבד (CPU) והקצאת הזיכרון שהוקצו למאגר המארח. חשוב לוודא שמגבלות המעבד (CPU) והזיכרון של הקונטיינר הראשי יכולות להכיל גם את האפליקציה וגם את כל ארגזי החול הפעילים שאתם מריצים בו-זמנית.

השבתת ארגזי חול

כדי להשבית את האפשרות להפעיל ארגז חול במשימה, משתמשים ב-Google Cloud CLI או בהגדרת YAML:

gcloud

מריצים את הפקודה הבאה כדי לעדכן את המשימה באמצעות הדגל --no-sandbox-launcher:

gcloud beta run jobs update JOB --no-sandbox-launcher

מחליפים את JOB בשם המשימה.

YAML

  1. אם אתם יוצרים משימה חדשה, דלגו על השלב הזה. אם מעדכנים משימה קיימת, מורידים את הגדרת ה-YAML שלה:

    gcloud run jobs describe JOB --format export > job.yaml
  2. מעדכנים את קובץ ה-YAML כדי להסיר את המאפיין sandboxLauncher מהגדרת הקונטיינר:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - name: CONTAINER
                image: IMAGE_URL
    

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

    • ‫JOB: השם של המשימה ב-Cloud Run.
    • ‫CONTAINER: שם הקונטיינר.
    • ‫IMAGE_URL: הפניה לקובץ האימג' של הקונטיינר, לדוגמה us-docker.pkg.dev/cloudrun/container/job:latest
  3. יוצרים או מעדכנים את המשימה באמצעות הפקודה הבאה:

    gcloud run jobs replace job.yaml

    כברירת מחדל, הפקודה gcloud run jobs replace משתמשת בקובץ job.yaml אם הוא קיים.

הצגת הגדרות ארגז החול

כדי לראות את ההגדרות הנוכחיות של ארגז החול במשימה ב-Cloud Run:

המסוף

  1. נכנסים לדף Jobs של Cloud Run במסוף Google Cloud :

    כניסה לדף Cloud Run jobs

  2. לוחצים על המשימה כדי לפתוח את הדף Job details.

  3. בכרטיסייה History, לוחצים על המזהה של המשימה שבוצעה מהרשימה.

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

gcloud

  1. משתמשים בפקודה הבאה:

    gcloud run jobs executions describe EXECUTION_NAME --format yaml

    מחליפים את EXECUTION_NAME בשם של הרצת המשימה.

  2. כדי לוודא שהקונטיינרים בארגז החול מופעלים, מאתרים את המאפיין sandboxLauncher: true בהגדרות שמוחזרות.

כדי להריץ קוד לא מהימן בארגז חול מהמשימה, קראו את המאמר הרצת קוד ב-Cloud Run.

הגדרת תבניות של ארגז חול

תבניות של ארגזי חול מאפשרות להגדיר קובצי אימג' של קונטיינרים לארגזי חול. במקום להריץ סשנים של ארגז חול בתוך הקונטיינר הראשי של האפליקציה, הפקודות sandbox do --template ו-sandbox run --template מפעילות קונטיינרים חדשים באמצעות קובצי האימג' שציינתם, כמו Python,‏ Node.js או סביבת הרצה בהתאמה אישית. ארגזי החול האלה פועלים בקונטיינרים משלהם, וחולקים את מגבלות ה-CPU והזיכרון של הקונטיינר הראשי. אי אפשר להגדיר מגבלות נפרדות למעבד (CPU) ולזיכרון בתבנית. ב-Cloud Run אפשר להשתמש בעד 10 תבניות של ארגזי חול. נקודות הטעינה של אמצעי האחסון חייבות להפנות לאמצעי אחסון בזיכרון במשאב Cloud Run. תבניות של ארגז חול מספקות את היכולות הבאות:

  • קובצי אימג' ייעודיים של קונטיינרים: מגדירים קובצי אימג' ייעודיים של קונטיינרים, כמו python:3.12-slim או busybox:latest, כתבניות של ארגז חול. אתם יכולים גם להשתמש בסביבות זמן ריצה ובכלים אחרים לארגזי חול שלא נדרשים בקונטיינר הראשי. כך המאגר הראשי נשאר קל, כי הכלים וסביבות זמן הריצה שמשמשים רק לארגז החול מבודדים.

  • יצירת מופעים על פי דרישה: ה-CLI של ארגז החול (/usr/local/gcp/bin/sandbox) יוצר קונטיינרים חדשים של ארגז חול מתבנית, בלי להקצות מכונות וירטואליות חדשות או לחייב על מכונות חדשות.

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

אתם יכולים להגדיר תבניות של ארגזי חול באמצעות הגדרת YAML או Cloud Run Admin API:

YAML

  1. אם אתם יוצרים משימה חדשה, דלגו על השלב הזה. אם מעדכנים משימה קיימת, מורידים את הגדרת ה-YAML שלה:

    gcloud run jobs describe JOB --format export > job.yaml
  2. מעדכנים את קובץ ה-YAML של המשימה כך שיכלול את הגדרת התבניות של sandboxes:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: JOB
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: IMAGE_URL
                sandboxLauncher: true
                volumeMounts:
                - name: VOLUME_NAME
                  mountPath: CONTAINER_MOUNT_PATH
              volumes:
              - name: VOLUME_NAME
                emptyDir:
                  medium: Memory
              sandboxes:
                templates:
                - name: TEMPLATE_NAME
                  image: TEMPLATE_IMAGE_URL
                  volumeMounts:
                  - name: VOLUME_NAME
                    mountPath: SANDBOX_MOUNT_PATH
                    subPath: SUBPATH
    

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

    • ‫JOB: השם של המשימה ב-Cloud Run.

    • ‫IMAGE_URL: כתובת ה-URL של קובץ האימג' של הקונטיינר שבו משתמשים בקונטיינר הראשי.
    • ‫TEMPLATE_NAME: שם התבנית.
    • ‫TEMPLATE_IMAGE_URL: כתובת ה-URL של קובץ האימג' של הקונטיינר שמשמשת לתבנית של ארגז החול.
    • אופציונלי: VOLUME_NAME: שם אמצעי האחסון לטעינה.
    • אופציונלי: CONTAINER_MOUNT_PATH: הנתיב שבו מותקן אמצעי האחסון בתוך מאגר התגים הראשי.
    • אופציונלי: SANDBOX_MOUNT_PATH: הנתיב שבו מאוחסן אמצעי האחסון בתוך מאגר ארגז החול.
    • אופציונלי: SUBPATH: נתיב יחסי של תת-ספרייה בתוך הנפח לטעינה בקונטיינר של ארגז החול, כמו my-subdir. כדי להגדיר תת-ספרייה שונה לכל ארגז חול בזמן הריצה, משתמשים בפלייסהולדר $(VARIABLE_NAME), למשל $(SANDBOX_DIR):
      • השדה VARIABLE_NAME יכול להכיל רק אותיות ASCII וקווים תחתונים. אין תמיכה בספרות ובמקפים.
      • כדי לפתור את הפלייסהולדר בזמן הריצה, מעבירים את הדגל --template-var=VARIABLE_NAME=VALUE יחד עם --template.
      • ‫subPath לא יוצר ספריות באופן אוטומטי. לפני שמריצים את sandbox do או את sandbox run, יוצרים את הספרייה SUBPATH שפוענחה בנפח מהמאגר הראשי, למשל באמצעות mkdir -p.
  3. יוצרים או מעדכנים את המשימה באמצעות הפקודה הבאה:

    gcloud run jobs replace job.yaml

    כברירת מחדל, הפקודה gcloud run jobs replace משתמשת בקובץ job.yaml אם הוא קיים.

‫API בארכיטקטורת REST

כדי להגדיר תבניות של ארגזי חול, שולחים בקשת PATCH ל-Cloud Run Admin API:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X PATCH \
"https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB" \
-d '{
  "launchStage": "BETA",
  "template": {
    "template": {
      "containers": [
        {
          "image": "IMAGE_URL",
          "sandboxLauncher": true,
          "volumeMounts": [
            {
              "name": "VOLUME_NAME",
              "mountPath": "CONTAINER_MOUNT_PATH"
            }
          ]
        }
      ],
      "sandboxes": {
        "templates": [
          {
            "name": "TEMPLATE_NAME",
            "image": "TEMPLATE_IMAGE_URL",
            "volumeMounts": [
              {
                "name": "VOLUME_NAME",
                "mountPath": "SANDBOX_MOUNT_PATH",
                "subPath": "SUBPATH"
              }
            ]
          }
        ]
      },
      "volumes": [
        {
          "name": "VOLUME_NAME",
          "emptyDir": {
            "medium": "MEMORY"
          }
        }
      ]
    }
  }
}'

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

  • ‫JOB: השם של המשימה ב-Cloud Run.

  • ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud .
  • ‫REGION: האזור שבו נפרס המשאב של Cloud Run.
  • ‫IMAGE_URL: כתובת ה-URL של קובץ האימג' של הקונטיינר שבו משתמשים בקונטיינר הראשי.
  • ‫TEMPLATE_NAME: שם התבנית.
  • ‫TEMPLATE_IMAGE_URL: כתובת ה-URL של קובץ האימג' של הקונטיינר שמשמשת לתבנית של ארגז החול.
  • אופציונלי: VOLUME_NAME: שם אמצעי האחסון לטעינה.
  • אופציונלי: CONTAINER_MOUNT_PATH: הנתיב שבו מותקן אמצעי האחסון בתוך מאגר התגים הראשי.
  • אופציונלי: SANDBOX_MOUNT_PATH: הנתיב שבו מאוחסן אמצעי האחסון בתוך מאגר ארגז החול.
  • אופציונלי: SUBPATH: נתיב יחסי של תת-ספרייה בתוך הנפח לטעינה בקונטיינר של ארגז החול, כמו my-subdir. כדי להגדיר תת-ספרייה שונה לכל ארגז חול בזמן הריצה, משתמשים בפלייסהולדר $(VARIABLE_NAME), למשל $(SANDBOX_DIR):
    • השדה VARIABLE_NAME יכול להכיל רק אותיות ASCII וקווים תחתונים. אין תמיכה בספרות ובמקפים.
    • כדי לפתור את הפלייסהולדר בזמן הריצה, מעבירים את הדגל --template-var=VARIABLE_NAME=VALUE יחד עם --template.
    • ‫subPath לא יוצר ספריות באופן אוטומטי. לפני שמריצים את sandbox do או את sandbox run, יוצרים את הספרייה SUBPATH שפוענחה בנפח מהמאגר הראשי, למשל באמצעות mkdir -p.

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