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

בדף הזה מוסבר איך להגדיר משתני סביבה לעבודת Cloud Run.

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

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

שמות שמורים

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

מספר מקסימלי של משתני סביבה

שימו לב: אפשר להגדיר עד 1,000 משתני סביבה לכל קונטיינר בכל משימת Cloud Run.

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

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

• Cloud Run Developer (roles/run.developer) – המשימה ב-Cloud Run
• משתמש בחשבון שירות (roles/iam.serviceAccountUser) – זהות השירות

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

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

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

אפשר להגדיר משתני סביבה למשימות חדשות וקיימות. שימו לב שהדגל --set-env-vars הוא פעולה הרסנית שמוחקת משתני סביבה שהוגדרו בעבר ולא נכללים ברשימה החדשה של משתני הסביבה.

אפשר להגדיר משתני סביבה באמצעות מסוף Google Cloud , ה-CLI של gcloud או קובץ YAML:

המסוף

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

   כניסה ל-Cloud Run

2. לוחצים על Deploy container (פריסת מאגר תגים) כדי למלא את דף ההגדרות הראשוניות של המשימה. אם מגדירים משימה קיימת, בוחרים את המשימה ולוחצים על View and edit job configuration (הצגה ועריכה של הגדרת המשימה).

3. לוחצים על Container(s), Volumes, Connections, Security (מאגרי נתונים, אמצעי אחסון, חיבורים, אבטחה) כדי להרחיב את דף מאפייני העבודה.

4. לוחצים על הכרטיסייה משתנים.

   

   • בכרטיסייה Variables & Secrets (משתנים וסודות), לוחצים על Add Variable (הוספת משתנה) ומציינים את השם והערך שרוצים להגדיר למשתנה בשדות Name (שם) ו-Value (ערך). מידע נוסף על הגדרת כמה משתני סביבה או על שימוש בתווי escape לתווים מיוחדים זמין במאמר הגדרת כמה משתני סביבה.

5. לוחצים על יצירה או על עדכון.

gcloud

כדי לציין משתני סביבה כשיוצרים משימה, משתמשים בדגל --set-env-vars:

gcloud run jobs create JOB_NAME --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2

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

• ‫JOB_NAME: שם המשימה.
• ‫KEY1=VALUE1,KEY2=VALUE2: רשימה מופרדת בפסיקים של שמות משתנים והערכים שלהם.
• ‫IMAGE_URL: הפניה לקובץ אימג' של קונטיינר, לדוגמה us-docker.pkg.dev/cloudrun/container/job:latest.

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

YAML

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

   gcloud run jobs describe JOB_NAME --format export > job.yaml

2. 1. מעדכנים את המאפיינים name ו-value בקטע env כמו שמוצג בקטע containers::

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: JOB
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: IMAGE
               env:
               - name: KEY-1
                 value: VALUE-1
               - name: KEY-N
                 value: VALUE-N

   מחליפים את KEY-1 ואת VALUE-1 במשתנה הסביבה ובערך. אפשר להוסיף עוד משתנים וערכים לפי הצורך.

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

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

   gcloud run jobs replace job.yaml

Terraform

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

מוסיפים את השורות הבאות למשאב google_cloud_run_v2_job בקובץ התצורה של Terraform:

resource "google_cloud_run_v2_job" "default" {
  name     = "JOB_NAME"
  location = "REGION"

  template {
    template {
      containers {
        image = "us-docker.pkg.dev/cloudrun/container/job"
        env {
          name = "KEY-1"
          value = "VALUE-1"
        }
        env {
          name = "KEY-N"
          value = "VALUE-N"
        }
      }
    }
  }
}

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

• ‫JOB_NAME: השם של המשימה ב-Cloud Run.
• ‫REGION: Google Cloud האזור. לדוגמה: europe-west1.
• ‫KEY-1: משתנה הסביבה.
• ‫VALUE-1: הערך שמשויך למפתח.

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

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

אפשר להשתמש בהצהרה ENV בקובץ Dockerfile כדי להגדיר ערכי ברירת מחדל למשתני סביבה:

ENV KEY1=VALUE1,KEY2=VALUE2

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

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

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

אפשר להגדיר כמה משתני סביבה באמצעות הקובץ .env או הדגל --set-env-vars.

הגדרת כמה משתני סביבה באמצעות הקובץ .env

המסוף

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

   כניסה ל-Cloud Run

2. לוחצים על Deploy container (פריסת מאגר תגים) כדי למלא את דף ההגדרות הראשוניות של המשימה. אם מגדירים משימה קיימת, בוחרים את המשימה ולוחצים על View and edit job configuration (הצגה ועריכה של הגדרת המשימה).

3. לוחצים על Container(s), Volumes, Connections, Security (מאגרי נתונים, אמצעי אחסון, חיבורים, אבטחה) כדי להרחיב את דף מאפייני העבודה.

4. לוחצים על הכרטיסייה מאגר תגים.

   

   • בכרטיסייה Variables & Secrets (משתנים וסודות), לוחצים על Add Variable (הוספת משתנה) ומדביקים את התוכן של קובץ .env בשדה Name (שם). ‫Cloud Run מאכלס אוטומטית את השדה Value ויוצר משתנים חדשים לכל צמד מפתח/ערך שמוגדר בקובץ .env.

5. לוחצים על יצירה או על עדכון.

gcloud

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

gcloud run jobs create JOB_NAME --image=IMAGE_URL --env-vars-file=ENV_FILE_PATH

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

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

הגדרת כמה משתני סביבה באמצעות הדגל --set-env-vars

אם יש לכם כמה משתני סביבה שלא ניתן לפרט בפורמט KEY1=VALUE1,KEY2=VALUE2, אפשר לחזור על האפשרות --set-env-vars כמה פעמים:

   [...]
   --set-env-vars "KEY1=VALUE1" \
   --set-env-vars "KEY2=VALUE2" \
   --set-env-vars "KEY3=VALUE3"

תו בריחה (escape) לתווים של פסיקים

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

--set-env-vars "^@^KEY1=value1,value2,value3@KEY2=..."

עדכון משתני סביבה

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

המסוף

כדי לעדכן משתני סביבה באמצעות מסוף Google Cloud :

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

   כניסה ל-Cloud Run

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

3. לוחצים על הכרטיסייה מאגר תגים.

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

5. לוחצים על פריסה.

gcloud

כדי לעדכן משתני סביבה של משימה קיימת, משתמשים בדגל --update-env-vars:

gcloud run jobs update JOB_NAME --update-env-vars KEY1=VALUE1,KEY2=VALUE2

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

• ‫JOB_NAME: שם המשימה.
• ‫KEY1=VALUE1,KEY2=VALUE2: רשימה מופרדת בפסיקים של שמות משתנים וערכים.

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

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

המסוף

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

   כניסה לדף Cloud Run jobs

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

3. לוחצים על View and Edit job configuration (הצגה ועריכה של הגדרות העבודה).

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

gcloud

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

   gcloud run jobs describe JOB_NAME

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

מחיקת משתני סביבה

אפשר למחוק משתני סביבה למשימות קיימות.

המסוף

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

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

   כניסה ל-Cloud Run

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

3. לוחצים על הכרטיסייה מאגר תגים.

4. בכרטיסייה Variables and secrets (משתנים וסודות), מעבירים את הסמן שמאלה מהשדה Value (ערך) של משתנה הסביבה שרוצים להסיר, כדי להציג את סמל Delete (מחיקה), ולוחצים עליו.

5. לוחצים על סיום.

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

gcloud

כדי להסיר באופן סלקטיבי משתני סביבה של משימה קיימת, משתמשים בדגל --remove-env-vars:

gcloud run jobs update JOB_NAME --remove-env-vars KEY1,KEY2

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

• ‫JOB_NAME: שם המשימה.
• ‫KEY1,KEY2: רשימה מופרדת בפסיקים של שמות משתנים.

אפשרות אחרת היא למחוק את כל משתני הסביבה שהוגדרו קודם באמצעות הדגל --clear-env-vars:

gcloud run jobs update JOB_NAME --clear-env-vars