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

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

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

  1. אם עוד לא השתמשתם ב-Batch, כדאי לעיין במאמר תחילת העבודה עם Batch ולהפעיל את Batch על ידי השלמת הדרישות המוקדמות לפרויקטים ולמשתמשים.
  2. כדי לקבל את ההרשאות שדרושות ליצירת משימה, אתם צריכים לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים:

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

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

  3. בכל פעם שיוצרים משימה, חשוב לוודא שיש למשימה הגדרת רשת תקינה.
    • אם אין לכם דרישות ספציפיות לגבי רשתות עבור עומס העבודה או הפרויקט, ולא שיניתם את רשת ברירת המחדל של הפרויקט, לא נדרשת פעולה.
    • אחרת, תצטרכו להגדיר את הרשת כשתיצרו את העבודה. לפני שיוצרים משימה בסיסית, כדאי ללמוד איך להגדיר רשת למשימה, כדי שתוכלו לשנות את הדוגמאות שבהמשך בהתאם לדרישות הרשת שלכם.
    מידע נוסף על הגדרת הרשת של משימה זמין במאמר סקירה כללית על רשתות Batch.
  4. בכל פעם שיוצרים משימה, צריך לוודא שלמשימה יש סביבת מערכת הפעלה (OS) של מכונה וירטואלית (VM) תקינה.
    • אם אין לכם דרישות ספציפיות לגבי תמונת מערכת ההפעלה של מכונת ה-VM או דיסק אתחול של עומס העבודה או הפרויקט, לא נדרשת פעולה.
    • אחרת, צריך להכין אפשרות תקינה של סביבת מערכת הפעלה של מכונה וירטואלית. לפני שיוצרים משימה בסיסית, צריך לאשר את הגדרת ברירת המחדל של סביבת מערכת ההפעלה של מכונת ה-VM, או ללמוד איך להתאים אישית את סביבת מערכת ההפעלה של מכונת ה-VM כדי שתוכלו לשנות את הדוגמאות שבהמשך בהתאם לדרישות שלכם.
    מידע נוסף על סביבת מערכת ההפעלה של המכונה הווירטואלית עבור משימה זמין במאמר סקירה כללית על סביבת מערכת ההפעלה של המכונה הווירטואלית.

יצירת משרה בסיסית

מידע על כל השדות שאפשר לציין עבור משימה מופיע במאמרי העזרה של projects.locations.jobs REST resource. לסיכום, משימה מורכבת ממערך של משימה אחת או יותר שכולן מפעילות רכיבים להפעלה אחד או יותר, שהם הסקריפטים ו/או המאגרים שניתנים להפעלה של המשימה. כדי להסביר את הבסיס, בקטע הזה מוסבר איך ליצור עבודה לדוגמה עם רכיב אחד בלבד שאפשר להפעיל, בין אם זה סקריפט או קובץ אימג' של קונטיינר:

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

הדוגמה של משימה משני הסוגים מכילה קבוצת משימות עם מערך של 4 משימות. כל משימה מדפיסה הודעה ואת האינדקס שלה לפלט הרגיל ול-Cloud Logging. ההגדרה של הג'וב הזה מציינת רמת מקביליות של 2, כלומר הג'וב צריך לפעול על 2 מכונות וירטואליות כדי לאפשר ל-2 משימות לפעול בו-זמנית.

יצירת עבודת קונטיינר בסיסית

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

אפשר ליצור עבודת קונטיינר בסיסית באמצעות Google Cloud המסוף, ה-CLI של gcloud,‏ Batch API,‏ Go,‏ Java,‏ Node.js,‏ Python או C++.

המסוף

כדי ליצור עבודת קונטיינר בסיסית באמצעות Google Cloud המסוף:

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

    מעבר לרשימת המשימות

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

  3. מגדירים את הדף Job details:

    1. אופציונלי: בשדה שם המשרה, אפשר להתאים אישית את שם המשרה.

      לדוגמה, מזינים example-basic-job.

    2. מגדירים את הקטע פרטי המשימה:

      1. בחלון New runnable, מוסיפים לפחות סקריפט אחד או מאגר אחד להרצה של העבודה הזו.

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

        1. בוחרים באפשרות כתובת ה-URL של קובץ אימג' של קונטיינר (ברירת מחדל).

        2. בשדה כתובת ה-URL של קובץ אימג' של קונטיינר מזינים את כתובת ה-URL של קובץ אימג' של קונטיינר שרוצים להפעיל לכל משימה בעבודה הזו.

          לדוגמה, כדי להשתמש בbusybox Docker container image, מזינים את כתובת ה-URL הבאה:

          gcr.io/google-containers/busybox
          
        3. אופציונלי: כדי לבטל את הפקודה ENTRYPOINT של קובץ האימג' בקונטיינר, מזינים פקודה בשדה Entry point.

          לדוגמה, אפשר להזין את הפרטים הבאים:

          /bin/sh
          
        4. אופציונלי: כדי לבטל את הפקודה CMD בקובץ האימג' בקונטיינר, מבצעים את הפעולות הבאות:

          1. מסמנים את התיבה Override container image's CMD command (שינוי של פקודת ה-CMD של קובץ האימג' בקונטיינר). יופיע שדה.

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

            לדוגמה, מזינים את הפקודות הבאות:

            -c
            echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
            
          3. לוחצים על סיום.

      2. בשדה Task count (מספר המשימות), מזינים את מספר המשימות של העבודה הזו. הערך צריך להיות מספר שלם בין 1 לבין המגבלה על מספר המשימות בכל קבוצת משימות.

        לדוגמה, מזינים 4.

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

        לדוגמה, מזינים 2.

  4. מגדירים את הדף Resource specifications:

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

    2. בקטע VM provisioning model, בוחרים באחת מהאפשרויות הבאות של מודל הקצאת המשאבים למכונות הווירטואליות של המשימה הזו:

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

      • אחרת, בוחרים באפשרות רגילה.

      לדוגמה, בוחרים באפשרות רגילה (ברירת מחדל).

    3. בוחרים את המיקום של המשרה:

      1. בשדה אזור, בוחרים אזור.

        לדוגמה, בוחרים באפשרות us-central1 (Iowa) (ברירת מחדל).

      2. בשדה Zone (אזור), מבצעים אחת מהפעולות הבאות:

        • אם רוצים להגביל את ההרצה של המשימה לאזור ספציפי בלבד, בוחרים אזור.

        • אחרת, בוחרים באפשרות כל.

        לדוגמה, בוחרים באפשרות כל (ברירת מחדל).

    4. בוחרים אחת ממשפחות המכונות הבאות:

      • לעומסי עבודה נפוצים, לוחצים על General purpose (שימוש כללי).

      • לעומסי עבודה אינטנסיביים מבחינת ביצועים, לוחצים על אופטימיזציה לחישוב.

      • לעומסי עבודה שדורשים הרבה זיכרון, לוחצים על Memory optimized (אופטימיזציה של הזיכרון).

      • לעומסי עבודה שעברו אופטימיזציה למאיצים, לוחצים על GPUs. מידע נוסף מופיע במאמר יצירה והפעלה של משימה שמשתמשת ביחידות GPU.

      לדוגמה, לוחצים על General purpose (ברירת מחדל).

    5. בשדה Series (סדרה), בוחרים סדרת מכונות למכונות הווירטואליות של העבודה הזו.

      לדוגמה, אם בחרתם באפשרות General purpose (למטרות כלליות) עבור משפחת המכונות, בוחרים באפשרות E2 (ברירת מחדל).

    6. בשדה Machine type, בוחרים את סוג המכונה עבור המכונות הווירטואליות של העבודה הזו.

      לדוגמה, אם בחרתם באפשרות E2 בשדה של סדרת המכונות, בוחרים באפשרות e2-medium (2 vCPU, 4 GB memory) (ברירת מחדל).

    7. מגדירים את כמות משאבי המכונה הווירטואלית שנדרשת לכל משימה:

      1. בשדה Cores, מזינים את מספר vCPUs לכל משימה.

        לדוגמה, מזינים 1 (ברירת מחדל).

      2. בשדה Memory (זיכרון), מזינים את כמות ה-RAM ב-GB לכל משימה.

        לדוגמה, מזינים 0.5 (ברירת מחדל).

  5. אופציונלי: כדי לבדוק את הגדרות העבודה, בחלונית הימנית לוחצים על תצוגה מקדימה.

  6. לוחצים על יצירה.

בדף פרטי המשרה מוצגת המשרה שיצרתם.

gcloud

כדי ליצור משימת קונטיינר בסיסית באמצעות ה-CLI של gcloud:

  1. יוצרים קובץ JSON שמציין את פרטי ההגדרה של העבודה. לדוגמה, כדי ליצור עבודת קונטיינר בסיסית, יוצרים קובץ JSON עם התוכן הבא. מידע נוסף על כל השדות שאפשר לציין עבור משימה מופיע במאמרי העזרה של projects.locations.jobs REST resource.

    {
        "taskGroups": [
            {
                "taskSpec": {
                    "runnables": [
                        {
                            "container": {
                                CONTAINER
                            }
                        }
                    ],
                    "computeResource": {
                        "cpuMilli": CORES,
                        "memoryMib": MEMORY
                    },
                    "maxRetryCount": MAX_RETRY_COUNT,
                    "maxRunDuration": "MAX_RUN_DURATION"
                },
                "taskCount": TASK_COUNT,
                "parallelism": PARALLELISM
            }
        ]
    }
    

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

    • CONTAINER: הקונטיינר שבו כל משימה מורצת. לפחות תמונה אחת צריכה להיות מוגדרת בשדה המשנה imageUri של מאפיין המאגר, אבל יכול להיות שיהיה צורך בשדות משנה נוספים. מידע נוסף זמין בקטע הזה, במאמר בנושא container שדות משנה ובדוגמה של עבודת מאגר.
    • CORES: אופציונלי. כמות הליבות – במיוחד vCPUs, שבדרך כלל מייצגים חצי ליבה פיזית – שיוקצו לכל משימה ביחידות של אלפיות מעבד. אם לא מציינים את השדה cpuMilli, הערך שמוגדר הוא 2000 (2 vCPUs).
    • MEMORY: אופציונלי. נפח הזיכרון שיוקצה לכל משימה (ב-MB). אם לא מציינים את השדה memoryMib, הערך שמוגדר הוא 2000 (2 GB).
    • MAX_RETRY_COUNT: אופציונלי. המספר המקסימלי של ניסיונות חוזרים למשימה. הערך צריך להיות מספר שלם בין 0 ל-10. אם לא מציינים את השדה maxRetryCount, הערך מוגדר כ-0, כלומר לא יתבצע ניסיון חוזר להפעלת המשימה. מידע נוסף על השדה maxRetryCount זמין במאמר הגדרה של ניסיונות חוזרים אוטומטיים לביצוע משימות.
    • MAX_RUN_DURATION: אופציונלי. הזמן המקסימלי שמוקצב למשימה לפעול לפני שהיא מנסה שוב או נכשלת, בפורמט של ערך בשניות ואחריו s – לדוגמה, 3600s לשעה אחת. אם לא מציינים את השדה maxRunDuration, הערך שמוגדר הוא זמן הריצה המקסימלי של העבודה. מידע נוסף על השדה maxRunDuration זמין במאמר הגבלת זמני הריצה של משימות ושל קבצים להרצה באמצעות פסק זמן.
    • TASK_COUNT: אופציונלי. מספר המשימות בעבודה. הערך צריך להיות מספר שלם בין 1 לבין המגבלה על מספר המשימות בכל קבוצת משימות. אם לא מציינים את השדה taskCount, הערך מוגדר כ-1.
    • PARALLELISM: אופציונלי. מספר המשימות שהעבודה מריצה בו-זמנית. המספר לא יכול להיות גדול ממספר המשימות, והוא חייב להיות מספר שלם בין 1 לבין מגבלת המשימות המקבילות לכל עבודה. אם לא מציינים את השדה parallelism, הערך שלו מוגדר כ-1.
  2. יוצרים משימה באמצעות הפקודה gcloud batch jobs submit.

    gcloud batch jobs submit JOB_NAME \
      --location LOCATION \
      --config JSON_CONFIGURATION_FILE
    

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

    • JOB_NAME: שם המשימה.
    • LOCATION: המיקום של המשרה.
    • JSON_CONFIGURATION_FILE: הנתיב לקובץ JSON עם פרטי ההגדרות של העבודה.

לדוגמה, כדי ליצור משימה שמריצה משימות באמצעות קובץ האימג' של קונטיינר Docker‏ busybox:

  1. יוצרים קובץ JSON בספרייה הנוכחית בשם hello-world-container.json עם התוכן הבא:

    {
        "taskGroups": [
            {
                "taskSpec": {
                    "runnables": [
                        {
                            "container": {
                                "imageUri": "gcr.io/google-containers/busybox",
                                "entrypoint": "/bin/sh",
                                "commands": [
                                    "-c",
                                    "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                                ]
                            }
                        }
                    ],
                    "computeResource": {
                        "cpuMilli": 2000,
                        "memoryMib": 16
                    },
                    "maxRetryCount": 2,
                    "maxRunDuration": "3600s"
                },
                "taskCount": 4,
                "parallelism": 2
            }
        ],
        "allocationPolicy": {
            "instances": [
                {
                    "policy": { "machineType": "e2-standard-4" }
                }
            ]
        },
        "labels": {
            "department": "finance",
            "env": "testing"
        },
        "logsPolicy": {
            "destination": "CLOUD_LOGGING"
        }
    }
    
  2. מריצים את הפקודה הבאה:

    gcloud batch jobs submit example-container-job \
      --location us-central1 \
      --config hello-world-container.json
    

API

כדי ליצור משימת קונטיינר בסיסית באמצעות Batch API, משתמשים ב-method ‏jobs.create. מידע נוסף על כל השדות שאפשר לציין עבור משימה מופיע במאמר העזרה בנושא projects.locations.jobsמשאב REST.

POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs?job_id=JOB_NAME

{
    "taskGroups": [
        {
            "taskSpec": {
                "runnables": [
                    {
                        "container": {
                            CONTAINER
                        }
                    }
                ],
                "computeResource": {
                    "cpuMilli": CORES,
                    "memoryMib": MEMORY
                },
                "maxRetryCount": MAX_RETRY_COUNT,
                "maxRunDuration": "MAX_RUN_DURATION"
            },
            "taskCount": TASK_COUNT,
            "parallelism": PARALLELISM
        }
    ]
}

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

  • PROJECT_ID: מזהה הפרויקט שלכם.
  • LOCATION: המיקום של המשרה.
  • JOB_NAME: שם המשימה.
  • CONTAINER: הקונטיינר שבו כל משימה מורצת. לפחות תמונה אחת צריכה להיות מוגדרת בשדה המשנה imageUri של מאפיין המאגר, אבל יכול להיות שיהיה צורך בשדות משנה נוספים. מידע נוסף זמין בקטע הזה, במאמר בנושא container שדות משנה ובדוגמה של עבודת מאגר.
  • CORES: אופציונלי. כמות הליבות – במיוחד vCPUs, שבדרך כלל מייצגים חצי ליבה פיזית – שיוקצו לכל משימה ביחידות של אלפית מעבד. אם לא מציינים את השדה cpuMilli, הערך מוגדר ל-2000 (2 vCPU).
  • MEMORY: אופציונלי. נפח הזיכרון שיוקצה לכל משימה (ב-MB). אם לא מציינים את השדה memoryMib, הערך שמוגדר הוא 2000 (2 GB).
  • MAX_RETRY_COUNT: אופציונלי. המספר המקסימלי של ניסיונות חוזרים למשימה. הערך צריך להיות מספר שלם בין 0 ל-10. אם לא מציינים את השדה maxRetryCount, הערך מוגדר כ-0, כלומר לא יתבצע ניסיון חוזר להפעלת המשימה. מידע נוסף על השדה maxRetryCount זמין במאמר הגדרה של ניסיונות חוזרים אוטומטיים לביצוע משימות.
  • MAX_RUN_DURATION: אופציונלי. הזמן המקסימלי שמוקצב למשימה לפעול לפני שהיא מנסה שוב או נכשלת, בפורמט של ערך בשניות ואחריו s – לדוגמה, 3600s לשעה אחת. אם לא מציינים את השדה maxRunDuration, הערך שמוגדר הוא זמן הריצה המקסימלי של משימה. מידע נוסף על השדה maxRunDuration זמין במאמר הגבלת זמני הריצה של משימות ושל קבצים להרצה באמצעות פסק זמן.
  • TASK_COUNT: אופציונלי. מספר המשימות בעבודה, שחייב להיות מספר שלם בין 1 לבין המגבלה על מספר המשימות לכל קבוצת משימות. אם לא מציינים את השדה taskCount, הערך שלו מוגדר כ-1.
  • PARALLELISM: אופציונלי. מספר המשימות שהעבודה מריצה בו-זמנית. המספר לא יכול להיות גדול ממספר המשימות, והוא חייב להיות מספר שלם בין 1 לבין המגבלה של משימות מקבילות לכל משימה. אם לא מציינים את השדה parallelism, הערך שלו מוגדר כ-1.

לדוגמה, כדי ליצור משימה שמריצה משימות באמצעות קובץ אימג' של קונטיינר Docker‏ busybox, משתמשים בבקשה הבאה:

POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/jobs?job_id=example-container-job

{
    "taskGroups": [
        {
            "taskSpec": {
                "runnables": [
                    {
                        "container": {
                            "imageUri": "gcr.io/google-containers/busybox",
                            "entrypoint": "/bin/sh",
                            "commands": [
                                "-c",
                                "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                            ]
                        }
                    }
                ],
                "computeResource": {
                    "cpuMilli": 2000,
                    "memoryMib": 16
                },
                "maxRetryCount": 2,
                "maxRunDuration": "3600s"
            },
            "taskCount": 4,
            "parallelism": 2
        }
    ],
    "allocationPolicy": {
        "instances": [
            {
                "policy": { "machineType": "e2-standard-4" }
            }
        ]
    },
    "labels": {
        "department": "finance",
        "env": "testing"
    },
    "logsPolicy": {
        "destination": "CLOUD_LOGGING"
    }
}

כאשר PROJECT_ID הוא מזהה הפרויקט של הפרויקט.

המשך

Go

מידע נוסף מופיע במאמרי העזרה של Batch Go API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	durationpb "google.golang.org/protobuf/types/known/durationpb"
)

// Creates and runs a job that runs the specified container
func createContainerJob(w io.Writer, projectID, region, jobName string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	container := &batchpb.Runnable_Container{
		ImageUri:   "gcr.io/google-containers/busybox",
		Commands:   []string{"-c", "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."},
		Entrypoint: "/bin/sh",
	}

	// We can specify what resources are requested by each task.
	resources := &batchpb.ComputeResource{
		// CpuMilli is milliseconds per cpu-second. This means the task requires 2 whole CPUs.
		CpuMilli:  2000,
		MemoryMib: 16,
	}

	taskSpec := &batchpb.TaskSpec{
		Runnables: []*batchpb.Runnable{{
			Executable: &batchpb.Runnable_Container_{Container: container},
		}},
		ComputeResource: resources,
		MaxRunDuration: &durationpb.Duration{
			Seconds: 3600,
		},
		MaxRetryCount: 2,
	}

	// Tasks are grouped inside a job using TaskGroups.
	taskGroups := []*batchpb.TaskGroup{
		{
			TaskCount: 4,
			TaskSpec:  taskSpec,
		},
	}

	// Policies are used to define on what kind of virtual machines the tasks will run on.
	// In this case, we tell the system to use "e2-standard-4" machine type.
	// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
	allocationPolicy := &batchpb.AllocationPolicy{
		Instances: []*batchpb.AllocationPolicy_InstancePolicyOrTemplate{{
			PolicyTemplate: &batchpb.AllocationPolicy_InstancePolicyOrTemplate_Policy{
				Policy: &batchpb.AllocationPolicy_InstancePolicy{
					MachineType: "e2-standard-4",
				},
			},
		}},
	}

	// We use Cloud Logging as it's an out of the box available option
	logsPolicy := &batchpb.LogsPolicy{
		Destination: batchpb.LogsPolicy_CLOUD_LOGGING,
	}

	jobLabels := map[string]string{"env": "testing", "type": "container"}

	// The job's parent is the region in which the job will run
	parent := fmt.Sprintf("projects/%s/locations/%s", projectID, region)

	job := batchpb.Job{
		TaskGroups:       taskGroups,
		AllocationPolicy: allocationPolicy,
		Labels:           jobLabels,
		LogsPolicy:       logsPolicy,
	}

	req := &batchpb.CreateJobRequest{
		Parent: parent,
		JobId:  jobName,
		Job:    &job,
	}

	created_job, err := batchClient.CreateJob(ctx, req)
	if err != nil {
		return fmt.Errorf("unable to create job: %w", err)
	}

	fmt.Fprintf(w, "Job created: %v\n", created_job)

	return nil
}

Java

Java

מידע נוסף מופיע במאמרי העזרה של Batch Java API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.batch.v1.AllocationPolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate;
import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.ComputeResource;
import com.google.cloud.batch.v1.CreateJobRequest;
import com.google.cloud.batch.v1.Job;
import com.google.cloud.batch.v1.LogsPolicy;
import com.google.cloud.batch.v1.LogsPolicy.Destination;
import com.google.cloud.batch.v1.Runnable;
import com.google.cloud.batch.v1.Runnable.Container;
import com.google.cloud.batch.v1.TaskGroup;
import com.google.cloud.batch.v1.TaskSpec;
import com.google.protobuf.Duration;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class CreateWithContainerNoMounting {

  public static void main(String[] args)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region you want to use to run the job. Regions that are
    // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
    String region = "europe-central2";

    // The name of the job that will be created.
    // It needs to be unique for each project and region pair.
    String jobName = "JOB_NAME";

    createContainerJob(projectId, region, jobName);
  }

  // This method shows how to create a sample Batch Job that will run a simple command inside a
  // container on Cloud Compute instances.
  public static void createContainerJob(String projectId, String region, String jobName)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      // Define what will be done as part of the job.
      Runnable runnable =
          Runnable.newBuilder()
              .setContainer(
                  Container.newBuilder()
                      .setImageUri("gcr.io/google-containers/busybox")
                      .setEntrypoint("/bin/sh")
                      .addCommands("-c")
                      .addCommands(
                          "echo Hello world! This is task ${BATCH_TASK_INDEX}. "
                              + "This job has a total of ${BATCH_TASK_COUNT} tasks.")
                      .build())
              .build();

      // We can specify what resources are requested by each task.
      ComputeResource computeResource =
          ComputeResource.newBuilder()
              // In milliseconds per cpu-second. This means the task requires 2 whole CPUs.
              .setCpuMilli(2000)
              // In MiB.
              .setMemoryMib(16)
              .build();

      TaskSpec task =
          TaskSpec.newBuilder()
              // Jobs can be divided into tasks. In this case, we have only one task.
              .addRunnables(runnable)
              .setComputeResource(computeResource)
              .setMaxRetryCount(2)
              .setMaxRunDuration(Duration.newBuilder().setSeconds(3600).build())
              .build();

      // Tasks are grouped inside a job using TaskGroups.
      // Currently, it's possible to have only one task group.
      TaskGroup taskGroup = TaskGroup.newBuilder().setTaskCount(4).setTaskSpec(task).build();

      // Policies are used to define on what kind of virtual machines the tasks will run on.
      // In this case, we tell the system to use "e2-standard-4" machine type.
      // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
      InstancePolicy instancePolicy =
          InstancePolicy.newBuilder().setMachineType("e2-standard-4").build();

      AllocationPolicy allocationPolicy =
          AllocationPolicy.newBuilder()
              .addInstances(InstancePolicyOrTemplate.newBuilder().setPolicy(instancePolicy).build())
              .build();

      Job job =
          Job.newBuilder()
              .addTaskGroups(taskGroup)
              .setAllocationPolicy(allocationPolicy)
              .putLabels("env", "testing")
              .putLabels("type", "container")
              // We use Cloud Logging as it's an out of the box available option.
              .setLogsPolicy(
                  LogsPolicy.newBuilder().setDestination(Destination.CLOUD_LOGGING).build())
              .build();

      CreateJobRequest createJobRequest =
          CreateJobRequest.newBuilder()
              // The job's parent is the region in which the job will run.
              .setParent(String.format("projects/%s/locations/%s", projectId, region))
              .setJob(job)
              .setJobId(jobName)
              .build();

      Job result =
          batchServiceClient
              .createJobCallable()
              .futureCall(createJobRequest)
              .get(5, TimeUnit.MINUTES);

      System.out.printf("Successfully created the job: %s", result.getName());
    }
  }
}

Node.js

Node.js

מידע נוסף מופיע במאמרי העזרה של Batch Node.js API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region you want to the job to run in. The regions that support Batch are listed here:
 * https://cloud.google.com/batch/docs/get-started#locations
 */
// const region = 'us-central-1';
/**
 * The name of the job that will be created.
 * It needs to be unique for each project and region pair.
 */
// const jobName = 'YOUR_JOB_NAME';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');
const batch = batchLib.protos.google.cloud.batch.v1;

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

// Define what will be done as part of the job.
const task = new batch.TaskSpec();
const runnable = new batch.Runnable();
runnable.container = new batch.Runnable.Container();
runnable.container.imageUri = 'gcr.io/google-containers/busybox';
runnable.container.entrypoint = '/bin/sh';
runnable.container.commands = [
  '-c',
  'echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.',
];
task.runnables = [runnable];

// We can specify what resources are requested by each task.
const resources = new batch.ComputeResource();
resources.cpuMilli = 2000; // in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
resources.memoryMib = 16;
task.computeResource = resources;

task.maxRetryCount = 2;
task.maxRunDuration = {seconds: 3600};

// Tasks are grouped inside a job using TaskGroups.
const group = new batch.TaskGroup();
group.taskCount = 4;
group.taskSpec = task;

// Policies are used to define on what kind of virtual machines the tasks will run on.
// In this case, we tell the system to use "e2-standard-4" machine type.
// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
const allocationPolicy = new batch.AllocationPolicy();
const policy = new batch.AllocationPolicy.InstancePolicy();
policy.machineType = 'e2-standard-4';
const instances = new batch.AllocationPolicy.InstancePolicyOrTemplate();
instances.policy = policy;
allocationPolicy.instances = [instances];

const job = new batch.Job();
job.name = jobName;
job.taskGroups = [group];
job.allocationPolicy = allocationPolicy;
job.labels = {env: 'testing', type: 'container'};
// We use Cloud Logging as it's an option available out of the box
job.logsPolicy = new batch.LogsPolicy();
job.logsPolicy.destination = batch.LogsPolicy.Destination.CLOUD_LOGGING;

// The job's parent is the project and region in which the job will run
const parent = `projects/${projectId}/locations/${region}`;

async function callCreateJob() {
  // Construct request
  const request = {
    parent,
    jobId: jobName,
    job,
  };

  // Run request
  const response = await batchClient.createJob(request);
  console.log(response);
}

await callCreateJob();

Python

Python

מידע נוסף מופיע במאמרי העזרה של Batch Python API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

from google.cloud import batch_v1


def create_container_job(project_id: str, region: str, job_name: str) -> batch_v1.Job:
    """
    This method shows how to create a sample Batch Job that will run
    a simple command inside a container on Cloud Compute instances.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region you want to use to run the job. Regions that are
            available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
        job_name: the name of the job that will be created.
            It needs to be unique for each project and region pair.

    Returns:
        A job object representing the job created.
    """
    client = batch_v1.BatchServiceClient()

    # Define what will be done as part of the job.
    runnable = batch_v1.Runnable()
    runnable.container = batch_v1.Runnable.Container()
    runnable.container.image_uri = "gcr.io/google-containers/busybox"
    runnable.container.entrypoint = "/bin/sh"
    runnable.container.commands = [
        "-c",
        "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.",
    ]

    # Jobs can be divided into tasks. In this case, we have only one task.
    task = batch_v1.TaskSpec()
    task.runnables = [runnable]

    # We can specify what resources are requested by each task.
    resources = batch_v1.ComputeResource()
    resources.cpu_milli = 2000  # in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
    resources.memory_mib = 16  # in MiB
    task.compute_resource = resources

    task.max_retry_count = 2
    task.max_run_duration = "3600s"

    # Tasks are grouped inside a job using TaskGroups.
    # Currently, it's possible to have only one task group.
    group = batch_v1.TaskGroup()
    group.task_count = 4
    group.task_spec = task

    # Policies are used to define on what kind of virtual machines the tasks will run on.
    # In this case, we tell the system to use "e2-standard-4" machine type.
    # Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
    policy = batch_v1.AllocationPolicy.InstancePolicy()
    policy.machine_type = "e2-standard-4"
    instances = batch_v1.AllocationPolicy.InstancePolicyOrTemplate()
    instances.policy = policy
    allocation_policy = batch_v1.AllocationPolicy()
    allocation_policy.instances = [instances]

    job = batch_v1.Job()
    job.task_groups = [group]
    job.allocation_policy = allocation_policy
    job.labels = {"env": "testing", "type": "container"}
    # We use Cloud Logging as it's an out of the box available option
    job.logs_policy = batch_v1.LogsPolicy()
    job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING

    create_request = batch_v1.CreateJobRequest()
    create_request.job = job
    create_request.job_id = job_name
    # The job's parent is the region in which the job will run
    create_request.parent = f"projects/{project_id}/locations/{region}"

    return client.create_job(create_request)

C++‎

C++

מידע נוסף מופיע במאמרי העזרה של Batch C++ API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    // Initialize the request; start with the fields that depend on the sample
    // input.
    google::cloud::batch::v1::CreateJobRequest request;
    request.set_parent("projects/" + project_id + "/locations/" + location_id);
    request.set_job_id(job_id);
    // Most of the job description is fixed in this example; use a string to
    // initialize it.
    auto constexpr kText = R"pb(
      task_groups {
        task_count: 4
        task_spec {
          compute_resource { cpu_milli: 500 memory_mib: 16 }
          max_retry_count: 2
          max_run_duration { seconds: 3600 }
          runnables {
            container {
              image_uri: "gcr.io/google-containers/busybox"
              entrypoint: "/bin/sh"
              commands: "-c"
              commands: "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
            }
          }
        }
      }
      allocation_policy {
        instances {
          policy { machine_type: "e2-standard-4" provisioning_model: STANDARD }
        }
      }
      labels { key: "env" value: "testing" }
      labels { key: "type" value: "container" }
      logs_policy { destination: CLOUD_LOGGING }
    )pb";
    auto* job = request.mutable_job();
    if (!google::protobuf::TextFormat::ParseFromString(kText, job)) {
      throw std::runtime_error("Error parsing Job description");
    }
    // Create a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.CreateJob(request);
    if (!response) throw std::move(response).status();
    std::cout << "Job : " << response->DebugString() << "\n";
  }

יצירת עבודת סקריפט בסיסית

אפשר ליצור עבודת סקריפט בסיסית באמצעות Google Cloud המסוף, ה-CLI של gcloud,‏ Batch API,‏ Go,‏ Java,‏ Node.js,‏ Python או C++.

המסוף

כדי ליצור משימת סקריפט בסיסית באמצעות Google Cloud המסוף, מבצעים את הפעולות הבאות:

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

    מעבר לרשימת המשימות

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

  3. מגדירים את הדף Job details:

    1. אופציונלי: בשדה שם המשרה, אפשר להתאים אישית את שם המשרה.

      לדוגמה, מזינים example-basic-job.

    2. מגדירים את הקטע פרטי המשימה:

      1. בחלון New runnable, מוסיפים לפחות סקריפט אחד או מאגר אחד להרצה של העבודה הזו.

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

        1. בוחרים באפשרות תסריט. יופיע שדה.

        2. בשדה, מזינים סקריפט שרוצים להריץ לכל משימה בעבודה הזו.

          לדוגמה, מזינים את הסקריפט הבא:

          echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
          
        3. לוחצים על סיום.

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

        לדוגמה, מזינים 4.

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

        לדוגמה, מזינים 2.

  4. מגדירים את הדף Resource specifications:

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

    2. בקטע VM provisioning model, בוחרים באחת מהאפשרויות הבאות של מודל הקצאת המשאבים למכונות הווירטואליות של המשימה הזו:

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

      • אחרת, בוחרים באפשרות רגילה.

      לדוגמה, בוחרים באפשרות רגילה (ברירת מחדל).

    3. בוחרים את המיקום של המשרה:

      1. בשדה אזור, בוחרים אזור.

        לדוגמה, בוחרים באפשרות us-central1 (Iowa) (ברירת מחדל).

      2. בשדה Zone (אזור), מבצעים אחת מהפעולות הבאות:

        • אם רוצים להגביל את ההרצה של המשימה הזו לאזור ספציפי בלבד, בוחרים אזור.

        • אחרת, בוחרים באפשרות כל.

        לדוגמה, בוחרים באפשרות כל (ברירת מחדל).

    4. בוחרים אחת ממשפחות המכונות הבאות:

      • לפרויקטים נפוצים של workload, לוחצים על General purpose (לשימוש כללי).

      • לעומסי עבודה אינטנסיביים מבחינת ביצועים, לוחצים על אופטימיזציה לחישוב.

      • לעומסי עבודה שדורשים הרבה זיכרון, לוחצים על Memory optimized (אופטימיזציה של הזיכרון).

      • לעומסי עבודה שעברו אופטימיזציה למאיצים, לוחצים על GPUs. מידע נוסף מופיע במאמר יצירה והפעלה של משימה שמשתמשת ביחידות GPU.

      לדוגמה, לוחצים על General purpose (ברירת מחדל).

    5. בשדה Series (סדרה), בוחרים סדרת מכונות למכונות הווירטואליות של העבודה הזו.

      לדוגמה, אם בחרתם באפשרות General purpose (למטרות כלליות) עבור משפחת המכונות, בוחרים באפשרות E2 (ברירת מחדל).

    6. בשדה Machine type, בוחרים את סוג המכונה עבור המכונות הווירטואליות של העבודה הזו.

      לדוגמה, אם בחרתם באפשרות E2 בשדה של סדרת המכונות, בוחרים באפשרות e2-medium (2 vCPU, 4 GB memory) (ברירת מחדל).

    7. מגדירים את כמות משאבי המכונה הווירטואלית שנדרשת לכל משימה:

      1. בשדה Cores, מזינים את מספר vCPUs לכל משימה.

        לדוגמה, מזינים 1 (ברירת מחדל).

      2. בשדה Memory (זיכרון), מזינים את כמות ה-RAM ב-GB לכל משימה.

        לדוגמה, מזינים 0.5 (ברירת מחדל).

  5. אופציונלי: כדי לבדוק את הגדרות העבודה, בחלונית הימנית לוחצים על תצוגה מקדימה.

  6. לוחצים על יצירה.

    בדף פרטי המשרה מוצגת המשרה שיצרתם.

gcloud

כדי ליצור עבודת סקריפט בסיסית באמצעות ה-CLI של gcloud:

  1. יוצרים קובץ JSON שמציין את פרטי ההגדרה של העבודה. לדוגמה, כדי ליצור משימת סקריפט בסיסית, יוצרים קובץ JSON עם התוכן הבא. מידע נוסף על כל השדות שאפשר לציין עבור משימה מופיע במאמרי העזרה של projects.locations.jobs REST resource.

    {
        "taskGroups": [
            {
                "taskSpec": {
                    "runnables": [
                        {
                            "script": {
                                SCRIPT
                            }
                        }
                    ],
                    "computeResource": {
                        "cpuMilli": CORES,
                        "memoryMib": MEMORY
                    },
                    "maxRetryCount": MAX_RETRY_COUNT,
                    "maxRunDuration": "MAX_RUN_DURATION"
                },
                "taskCount": TASK_COUNT,
                "parallelism": PARALLELISM
            }
        ]
    }
    

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

    • SCRIPT: הסקריפט שכל משימה מריצה. צריך להגדיר סקריפט כטקסט באמצעות שדה המשנה text או כנתיב לקובץ נגיש באמצעות שדה המשנה path. מידע נוסף זמין בקטע script שדות משנה ובדוגמה של סקריפט העבודה בסעיף הזה.
    • CORES: אופציונלי. כמות הליבות – במיוחד vCPUs, שבדרך כלל מייצגים חצי ליבה פיזית – שיוקצו לכל משימה ביחידות של אלפיות מעבד. אם לא מציינים את השדה cpuMilli, הערך שמוגדר הוא 2000 (2 vCPUs).
    • MEMORY: אופציונלי. נפח הזיכרון שיוקצה לכל משימה (ב-MB). אם לא מציינים את השדה memoryMib, הערך שמוגדר הוא 2000 (2 GB).
    • MAX_RETRY_COUNT: אופציונלי. המספר המקסימלי של ניסיונות חוזרים למשימה. הערך צריך להיות מספר שלם בין 0 ל-10. אם לא מציינים את השדה maxRetryCount, הערך מוגדר כ-0, כלומר לא יתבצע ניסיון חוזר להפעלת המשימה. מידע נוסף על השדה maxRetryCount זמין במאמר הגדרה של ניסיונות חוזרים אוטומטיים לביצוע משימות.
    • MAX_RUN_DURATION: אופציונלי. הזמן המקסימלי שמוקצב למשימה לפעול לפני שהיא מנסה שוב או נכשלת, בפורמט של ערך בשניות ואחריו s – לדוגמה, 3600s לשעה אחת. אם לא מציינים את השדה maxRunDuration, הערך שמוגדר הוא זמן הריצה המקסימלי של העבודה. מידע נוסף על השדה maxRunDuration זמין במאמר הגבלת זמני הריצה של משימות ושל קבצים להרצה באמצעות פסק זמן.
    • TASK_COUNT: אופציונלי. מספר המשימות בעבודה. הערך צריך להיות מספר שלם בין 1 לבין המגבלה על מספר המשימות בכל קבוצת משימות. אם לא מציינים את השדה taskCount, הערך מוגדר כ-1.
    • PARALLELISM: אופציונלי. מספר המשימות שהעבודה מריצה בו-זמנית. המספר לא יכול להיות גדול ממספר המשימות, והוא חייב להיות מספר שלם בין 1 לבין מגבלת המשימות המקבילות לכל עבודה. אם לא מציינים את השדה parallelism, הערך שלו מוגדר כ-1.
  2. יוצרים משימה באמצעות הפקודה gcloud batch jobs submit.

    gcloud batch jobs submit JOB_NAME \
      --location LOCATION \
      --config JSON_CONFIGURATION_FILE
    

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

    • JOB_NAME: שם המשימה.
    • LOCATION: המיקום של המשרה.
    • JSON_CONFIGURATION_FILE: הנתיב לקובץ JSON עם פרטי ההגדרות של העבודה.

לדוגמה, כדי ליצור משימה שמריצה משימות באמצעות סקריפט:

  1. יוצרים קובץ JSON בספרייה הנוכחית בשם hello-world-script.json עם התוכן הבא:

    {
        "taskGroups": [
            {
                "taskSpec": {
                    "runnables": [
                        {
                            "script": {
                                "text": "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                            }
                        }
                    ],
                    "computeResource": {
                        "cpuMilli": 2000,
                        "memoryMib": 16
                    },
                    "maxRetryCount": 2,
                    "maxRunDuration": "3600s"
                },
                "taskCount": 4,
                "parallelism": 2
            }
        ],
        "allocationPolicy": {
            "instances": [
                {
                    "policy": { "machineType": "e2-standard-4" }
                }
            ]
        },
        "labels": {
            "department": "finance",
            "env": "testing"
        },
        "logsPolicy": {
            "destination": "CLOUD_LOGGING"
        }
    }
    
  2. מריצים את הפקודה הבאה:

    gcloud batch jobs submit example-script-job \
      --location us-central1 \
      --config hello-world-script.json
    

API

כדי ליצור עבודת סקריפט בסיסית באמצעות Batch API, משתמשים ב-method ‏jobs.create. מידע נוסף על כל השדות שאפשר לציין עבור משימה מופיע במאמר העזרה בנושא projects.locations.jobsמשאב REST.

POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs?job_id=JOB_NAME

{
    "taskGroups": [
        {
            "taskSpec": {
                "runnables": [
                    {
                        "script": {
                            SCRIPT
                        }
                    }
                ],
                "computeResource": {
                    "cpuMilli": CORES,
                    "memoryMib": MEMORY
                },
                "maxRetryCount": MAX_RETRY_COUNT,
                "maxRunDuration": "MAX_RUN_DURATION"
            },
            "taskCount": TASK_COUNT,
            "parallelism": PARALLELISM
        }
    ]
}

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

  • PROJECT_ID: מזהה הפרויקט שלכם.
  • LOCATION: המיקום של המשרה.
  • JOB_NAME: שם המשימה.
  • SCRIPT: הסקריפט שכל משימה מריצה. צריך להגדיר סקריפט כטקסט באמצעות שדה המשנה text או כנתיב לקובץ נגיש באמצעות שדה המשנה path. מידע נוסף זמין בקטע script שדות משנה ובדוגמה של סקריפט העבודה בסעיף הזה.
  • CORES: אופציונלי. כמות הליבות – במיוחד vCPUs, שבדרך כלל מייצגים חצי ליבה פיזית – שיוקצו לכל משימה ביחידות של אלפית מעבד. אם לא מציינים את השדה cpuMilli, הערך מוגדר ל-2000 (2 vCPU).
  • MEMORY: אופציונלי. נפח הזיכרון שיוקצה לכל משימה (ב-MB). אם לא מציינים את השדה memoryMib, הערך שמוגדר הוא 2000 (2 GB).
  • MAX_RETRY_COUNT: אופציונלי. המספר המקסימלי של ניסיונות חוזרים למשימה. הערך צריך להיות מספר שלם בין 0 ל-10. אם לא מציינים את השדה maxRetryCount, הערך מוגדר כ-0, כלומר לא יתבצע ניסיון חוזר להפעלת המשימה. מידע נוסף על השדה maxRetryCount זמין במאמר הגדרה של ניסיונות חוזרים אוטומטיים לביצוע משימות.
  • MAX_RUN_DURATION: אופציונלי. הזמן המקסימלי שמוקצב למשימה לפעול לפני שהיא מנסה שוב או נכשלת, בפורמט של ערך בשניות ואחריו s – לדוגמה, 3600s לשעה אחת. אם לא מציינים את השדה maxRunDuration, הערך שמוגדר הוא זמן הריצה המקסימלי של משימה. מידע נוסף על השדה maxRunDuration זמין במאמר הגבלת זמני הריצה של משימות ושל קבצים להרצה באמצעות פסק זמן.
  • TASK_COUNT: אופציונלי. מספר המשימות בעבודה. הערך צריך להיות מספר שלם בין 1 לבין המגבלה על מספר המשימות בכל קבוצת משימות. אם לא מציינים את השדה taskCount, הערך שלו מוגדר כ-1.
  • PARALLELISM: אופציונלי. מספר המשימות שהעבודה מריצה בו-זמנית. המספר לא יכול להיות גדול ממספר המשימות, והוא חייב להיות מספר שלם בין 1 לבין המגבלה של משימות מקבילות לכל משימה. אם לא מציינים את השדה parallelism, הערך שלו מוגדר כ-1.

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

POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/jobs?job_id=example-script-job

{
    "taskGroups": [
        {
            "taskSpec": {
                "runnables": [
                    {
                        "script": {
                            "text": "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                        }
                    }
                ],
                "computeResource": {
                    "cpuMilli": 2000,
                    "memoryMib": 16
                },
                "maxRetryCount": 2,
                "maxRunDuration": "3600s"
            },
            "taskCount": 4,
            "parallelism": 2
        }
    ],
    "allocationPolicy": {
        "instances": [
            {
                "policy": { "machineType": "e2-standard-4" }
            }
        ]
    },
    "labels": {
        "department": "finance",
        "env": "testing"
    },
    "logsPolicy": {
        "destination": "CLOUD_LOGGING"
    }
}

כאשר PROJECT_ID הוא מזהה הפרויקט של הפרויקט.

המשך

Go

מידע נוסף מופיע במאמרי העזרה של Batch Go API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	durationpb "google.golang.org/protobuf/types/known/durationpb"
)

// Creates and runs a job that executes the specified script
func createScriptJob(w io.Writer, projectID, region, jobName string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	// Define what will be done as part of the job.
	command := &batchpb.Runnable_Script_Text{
		Text: "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.",
	}
	// You can also run a script from a file. Just remember, that needs to be a script that's
	// already on the VM that will be running the job.
	// Using runnable.script.text and runnable.script.path is mutually exclusive.
	// command := &batchpb.Runnable_Script_Path{
	// 	Path: "/tmp/test.sh",
	// }

	// We can specify what resources are requested by each task.
	resources := &batchpb.ComputeResource{
		// CpuMilli is milliseconds per cpu-second. This means the task requires 2 whole CPUs.
		CpuMilli:  2000,
		MemoryMib: 16,
	}

	taskSpec := &batchpb.TaskSpec{
		Runnables: []*batchpb.Runnable{{
			Executable: &batchpb.Runnable_Script_{
				Script: &batchpb.Runnable_Script{Command: command},
			},
		}},
		ComputeResource: resources,
		MaxRunDuration: &durationpb.Duration{
			Seconds: 3600,
		},
		MaxRetryCount: 2,
	}

	// Tasks are grouped inside a job using TaskGroups.
	taskGroups := []*batchpb.TaskGroup{
		{
			TaskCount: 4,
			TaskSpec:  taskSpec,
		},
	}

	// Policies are used to define on what kind of virtual machines the tasks will run on.
	// In this case, we tell the system to use "e2-standard-4" machine type.
	// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
	allocationPolicy := &batchpb.AllocationPolicy{
		Instances: []*batchpb.AllocationPolicy_InstancePolicyOrTemplate{{
			PolicyTemplate: &batchpb.AllocationPolicy_InstancePolicyOrTemplate_Policy{
				Policy: &batchpb.AllocationPolicy_InstancePolicy{
					MachineType: "e2-standard-4",
				},
			},
		}},
	}

	// We use Cloud Logging as it's an out of the box available option
	logsPolicy := &batchpb.LogsPolicy{
		Destination: batchpb.LogsPolicy_CLOUD_LOGGING,
	}

	jobLabels := map[string]string{"env": "testing", "type": "script"}

	// The job's parent is the region in which the job will run
	parent := fmt.Sprintf("projects/%s/locations/%s", projectID, region)

	job := batchpb.Job{
		TaskGroups:       taskGroups,
		AllocationPolicy: allocationPolicy,
		Labels:           jobLabels,
		LogsPolicy:       logsPolicy,
	}

	req := &batchpb.CreateJobRequest{
		Parent: parent,
		JobId:  jobName,
		Job:    &job,
	}

	created_job, err := batchClient.CreateJob(ctx, req)
	if err != nil {
		return fmt.Errorf("unable to create job: %w", err)
	}

	fmt.Fprintf(w, "Job created: %v\n", created_job)

	return nil
}

Java

Java

מידע נוסף מופיע במאמרי העזרה של Batch Java API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

import com.google.cloud.batch.v1.AllocationPolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate;
import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.ComputeResource;
import com.google.cloud.batch.v1.CreateJobRequest;
import com.google.cloud.batch.v1.Job;
import com.google.cloud.batch.v1.LogsPolicy;
import com.google.cloud.batch.v1.LogsPolicy.Destination;
import com.google.cloud.batch.v1.Runnable;
import com.google.cloud.batch.v1.Runnable.Script;
import com.google.cloud.batch.v1.TaskGroup;
import com.google.cloud.batch.v1.TaskSpec;
import com.google.protobuf.Duration;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class CreateWithScriptNoMounting {

  public static void main(String[] args)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region you want to use to run the job. Regions that are
    // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
    String region = "europe-central2";

    // The name of the job that will be created.
    // It needs to be unique for each project and region pair.
    String jobName = "JOB_NAME";

    createScriptJob(projectId, region, jobName);
  }

  // This method shows how to create a sample Batch Job that will run
  // a simple command on Cloud Compute instances.
  public static void createScriptJob(String projectId, String region, String jobName)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      // Define what will be done as part of the job.
      Runnable runnable =
          Runnable.newBuilder()
              .setScript(
                  Script.newBuilder()
                      .setText(
                          "echo Hello world! This is task ${BATCH_TASK_INDEX}. "
                              + "This job has a total of ${BATCH_TASK_COUNT} tasks.")
                      // You can also run a script from a file. Just remember, that needs to be a
                      // script that's already on the VM that will be running the job.
                      // Using setText() and setPath() is mutually exclusive.
                      // .setPath("/tmp/test.sh")
                      .build())
              .build();

      // We can specify what resources are requested by each task.
      ComputeResource computeResource =
          ComputeResource.newBuilder()
              // In milliseconds per cpu-second. This means the task requires 2 whole CPUs.
              .setCpuMilli(2000)
              // In MiB.
              .setMemoryMib(16)
              .build();

      TaskSpec task =
          TaskSpec.newBuilder()
              // Jobs can be divided into tasks. In this case, we have only one task.
              .addRunnables(runnable)
              .setComputeResource(computeResource)
              .setMaxRetryCount(2)
              .setMaxRunDuration(Duration.newBuilder().setSeconds(3600).build())
              .build();

      // Tasks are grouped inside a job using TaskGroups.
      // Currently, it's possible to have only one task group.
      TaskGroup taskGroup = TaskGroup.newBuilder().setTaskCount(4).setTaskSpec(task).build();

      // Policies are used to define on what kind of virtual machines the tasks will run on.
      // In this case, we tell the system to use "e2-standard-4" machine type.
      // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
      InstancePolicy instancePolicy =
          InstancePolicy.newBuilder().setMachineType("e2-standard-4").build();

      AllocationPolicy allocationPolicy =
          AllocationPolicy.newBuilder()
              .addInstances(InstancePolicyOrTemplate.newBuilder().setPolicy(instancePolicy).build())
              .build();

      Job job =
          Job.newBuilder()
              .addTaskGroups(taskGroup)
              .setAllocationPolicy(allocationPolicy)
              .putLabels("env", "testing")
              .putLabels("type", "script")
              // We use Cloud Logging as it's an out of the box available option.
              .setLogsPolicy(
                  LogsPolicy.newBuilder().setDestination(Destination.CLOUD_LOGGING).build())
              .build();

      CreateJobRequest createJobRequest =
          CreateJobRequest.newBuilder()
              // The job's parent is the region in which the job will run.
              .setParent(String.format("projects/%s/locations/%s", projectId, region))
              .setJob(job)
              .setJobId(jobName)
              .build();

      Job result =
          batchServiceClient
              .createJobCallable()
              .futureCall(createJobRequest)
              .get(5, TimeUnit.MINUTES);

      System.out.printf("Successfully created the job: %s", result.getName());
    }
  }
}

Node.js

Node.js

מידע נוסף מופיע במאמרי העזרה של Batch Node.js API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region you want to the job to run in. The regions that support Batch are listed here:
 * https://cloud.google.com/batch/docs/get-started#locations
 */
// const region = 'us-central-1';
/**
 * The name of the job that will be created.
 * It needs to be unique for each project and region pair.
 */
// const jobName = 'YOUR_JOB_NAME';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');
const batch = batchLib.protos.google.cloud.batch.v1;

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

// Define what will be done as part of the job.
const task = new batch.TaskSpec();
const runnable = new batch.Runnable();
runnable.script = new batch.Runnable.Script();
runnable.script.text =
  'echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.';
// You can also run a script from a file. Just remember, that needs to be a script that's
// already on the VM that will be running the job. Using runnable.script.text and runnable.script.path is mutually
// exclusive.
// runnable.script.path = '/tmp/test.sh'
task.runnables = [runnable];

// We can specify what resources are requested by each task.
const resources = new batch.ComputeResource();
resources.cpuMilli = 2000; // in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
resources.memoryMib = 16;
task.computeResource = resources;

task.maxRetryCount = 2;
task.maxRunDuration = {seconds: 3600};

// Tasks are grouped inside a job using TaskGroups.
const group = new batch.TaskGroup();
group.taskCount = 4;
group.taskSpec = task;

// Policies are used to define on what kind of virtual machines the tasks will run on.
// In this case, we tell the system to use "e2-standard-4" machine type.
// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
const allocationPolicy = new batch.AllocationPolicy();
const policy = new batch.AllocationPolicy.InstancePolicy();
policy.machineType = 'e2-standard-4';
const instances = new batch.AllocationPolicy.InstancePolicyOrTemplate();
instances.policy = policy;
allocationPolicy.instances = [instances];

const job = new batch.Job();
job.name = jobName;
job.taskGroups = [group];
job.allocationPolicy = allocationPolicy;
job.labels = {env: 'testing', type: 'script'};
// We use Cloud Logging as it's an option available out of the box
job.logsPolicy = new batch.LogsPolicy();
job.logsPolicy.destination = batch.LogsPolicy.Destination.CLOUD_LOGGING;

// The job's parent is the project and region in which the job will run
const parent = `projects/${projectId}/locations/${region}`;

async function callCreateJob() {
  // Construct request
  const request = {
    parent,
    jobId: jobName,
    job,
  };

  // Run request
  const response = await batchClient.createJob(request);
  console.log(response);
}

await callCreateJob();

Python

Python

מידע נוסף מופיע במאמרי העזרה של Batch Python API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

from google.cloud import batch_v1


def create_script_job(project_id: str, region: str, job_name: str) -> batch_v1.Job:
    """
    This method shows how to create a sample Batch Job that will run
    a simple command on Cloud Compute instances.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region you want to use to run the job. Regions that are
            available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
        job_name: the name of the job that will be created.
            It needs to be unique for each project and region pair.

    Returns:
        A job object representing the job created.
    """
    client = batch_v1.BatchServiceClient()

    # Define what will be done as part of the job.
    task = batch_v1.TaskSpec()
    runnable = batch_v1.Runnable()
    runnable.script = batch_v1.Runnable.Script()
    runnable.script.text = "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
    # You can also run a script from a file. Just remember, that needs to be a script that's
    # already on the VM that will be running the job. Using runnable.script.text and runnable.script.path is mutually
    # exclusive.
    # runnable.script.path = '/tmp/test.sh'
    task.runnables = [runnable]

    # We can specify what resources are requested by each task.
    resources = batch_v1.ComputeResource()
    resources.cpu_milli = 2000  # in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
    resources.memory_mib = 16
    task.compute_resource = resources

    task.max_retry_count = 2
    task.max_run_duration = "3600s"

    # Tasks are grouped inside a job using TaskGroups.
    # Currently, it's possible to have only one task group.
    group = batch_v1.TaskGroup()
    group.task_count = 4
    group.task_spec = task

    # Policies are used to define on what kind of virtual machines the tasks will run on.
    # In this case, we tell the system to use "e2-standard-4" machine type.
    # Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
    allocation_policy = batch_v1.AllocationPolicy()
    policy = batch_v1.AllocationPolicy.InstancePolicy()
    policy.machine_type = "e2-standard-4"
    instances = batch_v1.AllocationPolicy.InstancePolicyOrTemplate()
    instances.policy = policy
    allocation_policy.instances = [instances]

    job = batch_v1.Job()
    job.task_groups = [group]
    job.allocation_policy = allocation_policy
    job.labels = {"env": "testing", "type": "script"}
    # We use Cloud Logging as it's an out of the box available option
    job.logs_policy = batch_v1.LogsPolicy()
    job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING

    create_request = batch_v1.CreateJobRequest()
    create_request.job = job
    create_request.job_id = job_name
    # The job's parent is the region in which the job will run
    create_request.parent = f"projects/{project_id}/locations/{region}"

    return client.create_job(create_request)

C++‎

C++

מידע נוסף מופיע במאמרי העזרה של Batch C++ API.

כדי לבצע אימות ב-Batch, צריך להגדיר את Application Default Credentials. מידע נוסף זמין במאמר הגדרת אימות לסביבת פיתוח מקומית.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    // Initialize the request; start with the fields that depend on the sample
    // input.
    google::cloud::batch::v1::CreateJobRequest request;
    request.set_parent("projects/" + project_id + "/locations/" + location_id);
    request.set_job_id(job_id);
    // Most of the job description is fixed in this example; use a string to
    // initialize it.
    auto constexpr kText = R"pb(
      task_groups {
        task_count: 4
        task_spec {
          compute_resource { cpu_milli: 500 memory_mib: 16 }
          max_retry_count: 2
          max_run_duration { seconds: 3600 }
          runnables {
            script {
              text: "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
            }
          }
        }
      }
      allocation_policy {
        instances {
          policy { machine_type: "e2-standard-4" provisioning_model: STANDARD }
        }
      }
      labels { key: "env" value: "testing" }
      labels { key: "type" value: "script" }
      logs_policy { destination: CLOUD_LOGGING }
    )pb";
    auto* job = request.mutable_job();
    if (!google::protobuf::TextFormat::ParseFromString(kText, job)) {
      throw std::runtime_error("Error parsing Job description");
    }
    // Create a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.CreateJob(request);
    if (!response) throw std::move(response).status();
    std::cout << "Job : " << response->DebugString() << "\n";
  }

שימוש במשתני סביבה

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

שימוש במשתני סביבה שהוגדרו מראש

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

  • BATCH_TASK_COUNT: המספר הכולל של המשימות בקבוצת המשימות הזו.
  • BATCH_TASK_INDEX: מספר האינדקס של המשימה הזו בקבוצת המשימות. האינדקס של המשימה הראשונה הוא 0, והוא גדל ב-1 עבור כל משימה נוספת.
  • BATCH_HOSTS_FILE: הנתיב לקובץ שבו מפורטים כל המופעים של מכונות וירטואליות שפועלים בקבוצת המשימות הזו. כדי להשתמש במשתנה הסביבה הזה, צריך להגדיר את השדה requireHostsFile לערך true.
  • BATCH_TASK_RETRY_ATTEMPT: מספר הפעמים שכבר נעשה ניסיון לבצע את המשימה הזו. הערך הוא 0 בניסיון הראשון לבצע משימה, והוא גדל בכל ניסיון חוזר. המספר הכולל של הניסיונות החוזרים שמותרים למשימה נקבע לפי הערך של השדה maxRetryCount, שהוא 0 אם הוא לא מוגדר. מידע נוסף על ניסיונות חוזרים זמין במאמר בנושא אוטומציה של ניסיונות חוזרים של משימות.

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

הגדרה ושימוש של משתני סביבה מותאמים אישית

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

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

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

אפשר להגדיר ולהשתמש במשתני סביבה מותאמים אישית לעבודה באמצעות ה-CLI של gcloud או Batch API. בדוגמאות הבאות מוסבר איך ליצור שני ג'ובים שמגדירים ומשתמשים במשתנים רגילים. לדוגמה, למשימה הראשונה יש משתנה להפעלה ספציפית. לדוגמה השנייה יש משתנה מסוג מערך (array), שלו ערך שונה לכל משימה.

gcloud

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

הגדרה ושימוש במשתנה סביבה עבור קובץ הפעלה

כדי ליצור באמצעות ה-CLI של gcloud עבודה שמעבירה משתני סביבה לקובץ הפעלה, משתמשים בפקודה gcloud batch jobs submit ומציינים את משתני הסביבה בקובץ התצורה של העבודה.

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

  1. יוצרים קובץ JSON בספרייה הנוכחית בשם hello-world-environment-variables.json עם התוכן הבא:

    {
        "taskGroups": [
            {
                "taskSpec": {
                    "runnables": [
                        {
                            "script": {
                                "text": "echo Hello ${VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                            },
                            "environment": {
                                "variables": {
                                    "VARIABLE_NAME": "VARIABLE_VALUE"
                                }
                            }
                        }
                    ],
                    "computeResource": {
                        "cpuMilli": 2000,
                        "memoryMib": 16
                    }
                },
                "taskCount": 3,
                "parallelism": 1
            }
        ],
        "allocationPolicy": {
            "instances": [
                {
                    "policy": {
                        "machineType": "e2-standard-4"
                    }
                }
            ]
        }
    }
    

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

    • VARIABLE_NAME: השם של משתנה הסביבה שמועבר לכל משימה. לפי המוסכמה, השמות של משתני הסביבה הם באותיות רישיות.
    • VARIABLE_VALUE: אופציונלי. הערך של משתנה הסביבה שמועבר לכל משימה.
  2. מריצים את הפקודה הבאה:

    gcloud batch jobs submit example-environment-variables-job \
      --location us-central1 \
      --config hello-world-environment-variables.json
    

הגדרת משתנה סביבה לכל משימה ושימוש בו

כדי ליצור משימה שמעבירה משתני סביבה למשימה על סמך אינדקס המשימה באמצעות ה-CLI של gcloud, משתמשים בפקודה gcloud batch jobs submit ומציינים את שדה המערך taskEnvironments בקובץ ההגדרות של המשימה.

לדוגמה, כדי ליצור ג'וב שכולל מערך של 3 משתני סביבה עם שמות תואמים וערכים שונים, ולהעביר את משתני הסביבה לסקריפטים של המשימות שהאינדקסים שלהן תואמים לאינדקסים של משתני הסביבה במערך:

  1. יוצרים קובץ JSON בספרייה הנוכחית בשם hello-world-task-environment-variables.json עם התוכן הבא:

    {
        "taskGroups": [
            {
                "taskSpec": {
                    "runnables": [
                        {
                            "script": {
                                "text": "echo Hello ${TASK_VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                            },
                        }
                    ],
                    "computeResource": {
                        "cpuMilli": 2000,
                        "memoryMib": 16
                    }
                },
                "taskCount": 3,
                "taskEnvironments": [
                    {
                        "variables": {
                            "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_0"
                        }
                    },
                    {
                        "variables": {
                            "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_1"
                        }
                    },
                    {
                        "variables": {
                            "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_2"
                        }
                    }
                ]
            }
        ],
        "allocationPolicy": {
            "instances": [
                {
                    "policy": {
                        "machineType": "e2-standard-4"
                    }
                }
            ]
        }
    }
    

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

    • TASK_VARIABLE_NAME: השם של משתני הסביבה של המשימה שמועברים למשימות עם אינדקסים תואמים. לפי המוסכמה, שמות משתני הסביבה הם באותיות רישיות.
    • TASK_VARIABLE_VALUE_0: הערך של משתנה הסביבה שמועבר למשימה הראשונה, שבה BATCH_TASK_INDEX שווה ל-0.
    • TASK_VARIABLE_VALUE_1: הערך של משתנה הסביבה שמועבר למשימה השנייה, שבה BATCH_TASK_INDEX שווה ל-1.
    • TASK_VARIABLE_VALUE_2: הערך של משתנה הסביבה שמועבר למשימה השלישית, שבה BATCH_TASK_INDEX שווה ל-2.
  2. מריצים את הפקודה הבאה:

    gcloud batch jobs submit example-task-environment-variables-job \
      --location us-central1 \
      --config hello-world-task-environment-variables.json
    

API

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

הגדרה ושימוש במשתנה סביבה עבור קובץ הפעלה

כדי ליצור ג'וב שמעביר משתני סביבה לקובץ הפעלה באמצעות Batch API, משתמשים בפקודה gcloud batch jobs submit ומציינים את משתני הסביבה בשדה environment.

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

POST https://batch.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/us-central1/jobs?job_id=example-environment-variables-job

{
    "taskGroups": [
        {
            "taskSpec": {
                "runnables": [
                    {
                        "script": {
                            "text": "echo Hello ${VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                        },
                        "environment": {
                            "variables": {
                                "VARIABLE_NAME": "VARIABLE_VALUE"
                            }
                        }
                    }
                ],
                "computeResource": {
                    "cpuMilli": 2000,
                    "memoryMib": 16
                }
            },
            "taskCount": 3,
            "parallelism": 1
        }

    ],
    "allocationPolicy": {
        "instances": [
            {
                "policy": {
                    "machineType": "e2-standard-4"
                }
            }
        ]
    }
}

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

  • PROJECT_ID: מזהה הפרויקט שלכם.
  • VARIABLE_NAME: השם של משתנה הסביבה שמועבר לכל משימה. לפי המוסכמה, שמות של משתני סביבה הם באותיות רישיות.
  • VARIABLE_VALUE: הערך של משתנה הסביבה שמועבר לכל משימה.

הגדרת משתנה סביבה לכל משימה ושימוש בו

כדי ליצור משימה שמעבירה משתני סביבה למשימה על סמך אינדקס המשימה באמצעות Batch API, משתמשים בשיטה jobs.create ומציינים את משתני הסביבה בשדה המערך taskEnvironments.

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

POST https://batch.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/us-central1/jobs?job_id=example-task-environment-variables-job

{
    "taskGroups": [
        {
            "taskSpec": {
                "runnables": [
                    {
                        "script": {
                            "text": "echo Hello ${TASK_VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
                        },
                    }
                ],
                "computeResource": {
                    "cpuMilli": 2000,
                    "memoryMib": 16
                }
            },
            "taskCount": 3,
            "taskEnvironments": [
                {
                    "variables": {
                        "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_0"
                    }
                },
                {
                    "variables": {
                        "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_1"
                    }
                },
                {
                    "variables": {
                        "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_2"
                    }
                }
            ]
        }
    ],
    "allocationPolicy": {
        "instances": [
            {
                "policy": { "machineType": "e2-standard-4" }
            }
        ]
    }
}

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

  • PROJECT_ID: מזהה הפרויקט שלכם.
  • TASK_VARIABLE_NAME: השם של משתני הסביבה שמועברים למשימות עם אינדקסים תואמים. לפי המוסכמה, שמות משתני הסביבה הם באותיות רישיות.
  • TASK_VARIABLE_VALUE_0: הערך של משתנה הסביבה שמועבר למשימה הראשונה, שבה BATCH_TASK_INDEX שווה ל-0.
  • TASK_VARIABLE_VALUE_1: הערך של משתנה הסביבה שמועבר למשימה השנייה, שבה BATCH_TASK_INDEX שווה ל-1.
  • TASK_VARIABLE_VALUE_2: הערך של משתנה הסביבה שמועבר למשימה השלישית, שבה BATCH_TASK_INDEX שווה ל-2.

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