Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

הגדרת התראות HTTP

Cloud Build יכול לשלוח לכם התראות על עדכונים ב-build לערוצים שבחרתם, כמו Slack או שרת SMTP. בדף הזה מוסבר איך להגדיר התראות באמצעות הכלי לשליחת התראות HTTP.

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

מפעילים את Cloud Build,‏ Cloud Run ו-Pub/Sub APIs.
תפקידים שנדרשים להפעלת ממשקי API
כדי להפעיל ממשקי API, צריך את תפקיד ה-IAM 'אדמין של Service Usage' (roles/serviceusage.serviceUsageAdmin), שכולל את ההרשאה serviceusage.services.enable. איך מקצים תפקידים
הפעלת ממשקי ה-API

מתקינים את Google Cloud CLI.

הגדרת התראות HTTP

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

כדי להגדיר התראות HTTP:

כדי להשתמש בכלי ההתראות של HTTP לשליחת בקשות POST לכתובת URL של נמען מסוים:

נותנים לחשבון השירות של Cloud Run הרשאה לקרוא מקטגוריות של Cloud Storage:
1. נכנסים לדף IAM במסוף Google Cloud :
  
  פתיחת הדף IAM
2. מאתרים את חשבון השירות של Compute Engine שמוגדר כברירת מחדל שמשויך לפרויקט:
  
  חשבון השירות של Compute Engine שמוגדר כברירת מחדל ייראה בערך כך:
```
project-number-compute@developer.gserviceaccount.com
```
3. לוחצים על סמל העיפרון בשורה שמכילה את חשבון השירות של Compute Engine שמוגדר כברירת מחדל. תוצג הכרטיסייה גישת עריכה.
4. לוחצים על הוספת תפקיד נוסף.
5. מוסיפים את התפקיד הבא:
  - צפייה באובייקט אחסון
  הערה: אם רוצים להעניק הרשאות ברמת הקטגוריה ולא ברמת הפרויקט, צריך להוסיף את התפקיד Storage Legacy Object Owner לקטגוריה כשיוצרים אותה. מידע נוסף זמין במאמר תפקידים ברמת הפרויקט לעומת תפקידים ברמת הקטגוריה.
6. לוחצים על Save.
כותבים קובץ הגדרות של כלי להודעות כדי להגדיר את הכלי להודעות HTTP ולסנן אירועים של בנייה:

בדוגמה הבאה של קובץ הגדרות של הודעות, השדה filter משתמש בCommon Expression Language עם המשתנה הזמין build כדי לסנן אירועי build עם סטטוס SUCCESS:
```
apiVersion: cloud-build-notifiers/v1
kind: HTTPNotifier
metadata:
  name: example-http-notifier
spec:
  notification:
    filter: build.status == Build.Status.SUCCESS
    params:
      buildStatus: $(build.status)
    delivery:
      # The `http(s)://` protocol prefix is required.
      url: url
    template:
      type: golang
      uri: gs://bucket_name/http.json
```
כאשר:
- ‫buildStatus הוא פרמטר מותאם אישית. הפרמטר הזה מקבל את הערך של $(build.status), הסטטוס של ה-build.
- ‫url הוא משתנה ההגדרה שמשמש בדוגמה הזו כדי לציין את כתובת ה-URL של הבקשה.
- ‫bucket-name הוא שם הקטגוריה.
- ‫url היא כתובת ה-URL שרוצים לציין כשרת הנמען.
- השדה uri מפנה לקובץ http.json. הקובץ הזה מתייחס לתבנית JSON שמתארחת ב-Cloud Storage ומייצג את מטען ה-JSON לנקודת הקצה של ה-webhook.
  
  ניסיוני — התאמה אישית של התראות באמצעות תבניות
  
  השימוש בתכונה הזו כפוף לתנאי השימוש במוצרים בגרסת טרום-GA, שמפורטים בחלק "תנאי שירות הכלליים" בתנאים הספציפיים של השירות. השימוש בתכונות בגרסת טרום-GA הוא "כפי שהן" (As is), ויכול להיות שהתמיכה בהן תהיה מוגבלת. מידע נוסף זמין בקטע תיאור שלבי ההשקה.
  
  דוגמה לקובץ תבנית מופיעה בקובץ http.json במאגר cloud-build-notifiers.
כדי לראות את הדוגמה, אפשר לעיין בקובץ ההגדרות של כלי ההתראות עבור כלי ההתראות של HTTP.

במאמר בנושא משאבי Build מפורטים שדות נוספים שאפשר לסנן לפיהם. דוגמאות נוספות לסינון זמינות במאמר שימוש ב-CEL לסינון אירועי בנייה.
מעלים את קובץ התצורה של כלי ההתראות לקטגוריה של Cloud Storage:
1. אם אין לכם קטגוריה של Cloud Storage, מריצים את הפקודה הבאה כדי ליצור קטגוריה, כאשר bucket-name הוא השם שרוצים לתת לקטגוריה, בכפוף לדרישות למתן שמות.
```
gcloud storage buckets create gs://bucket-name/
```
2. מעלים את קובץ ההגדרות של כלי ההתראות לקטגוריה:
```
gcloud storage cp config-file-name gs://bucket-name/config-file-name
```
  כאשר:
  - ‫bucket-name הוא שם הקטגוריה.
  - ‫config-file-name הוא השם של קובץ ההגדרות של כלי ההתראות.
פורסים את כלי ההתראה ב-Cloud Run:
```
 gcloud run deploy service-name \
   --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/http:latest \
   --no-allow-unauthenticated \
   --update-env-vars=CONFIG_PATH=config-path,PROJECT_ID=project-id
```
כאשר:
- ‫service-name הוא השם של שירות Cloud Run שבו פורסים את האימג'.
- ‫config-path הוא הנתיב לקובץ ההגדרות של כלי ההתראה של HTTP, ‏ gs://bucket-name/config-file-name.
- ‫project-id הוא מזהה הפרויקט. Google Cloud
הפקודה gcloud run deploy שולפת את הגרסה העדכנית של התמונה המתארחת מ-Artifact Registry שבבעלות Cloud Build. ‫Cloud Build תומך בתמונות של כלי התראה למשך תשעה חודשים. אחרי תשעה חודשים, Cloud Build מוחק את גרסת התמונה. אם רוצים להשתמש בגרסה קודמת של תמונה, צריך לציין את הגרסה הסמנטית המלאה של תג התמונה במאפיין image של הפקודה gcloud run deploy. גרסאות קודמות של תמונות ותגים אפשר למצוא ב-Artifact Registry.

הערה: במהלך הפעלת הפקודה הזו, יכול להיות שתתבקשו לציין ארגומנטים נוספים כמו --region או --platform. מידע נוסף על הפרמטרים שאפשר להעביר לפקודה gcloud run deploy זמין במאמר פריסה ב-Cloud Run. אם לא הצלחתם לפרוס את כלי ההתראה באמצעות הפקודה הזו, תוכלו לעיין במדריך לפתרון בעיות ב-Cloud Run כדי למצוא פתרונות לשגיאות פריסה.
נותנים הרשאות Pub/Sub ליצירת טוקנים לאימות ב Google Cloud פרויקט:
```
 gcloud projects add-iam-policy-binding project-id \
   --member=serviceAccount:service-project-number@gcp-sa-pubsub.iam.gserviceaccount.com \
   --role=roles/iam.serviceAccountTokenCreator
```
כאשר:
- ‫project-id הוא מזהה הפרויקט. Google Cloud
- ‫project-number הוא מספר הפרויקט שלכם ב- Google Cloud .
הערה: אם חשבון השירות של Pub/Sub לא קיים בפרויקט שלכם, אפשר לעיין במאמר בנושא יצירה ושימוש במינויים.
יוצרים חשבון שירות שייצג את הזהות של המינוי ל-Pub/Sub:
```
gcloud iam service-accounts create cloud-run-pubsub-invoker \
  --display-name "Cloud Run Pub/Sub Invoker"
```
אפשר להשתמש ב-cloud-run-pubsub-invoker או בשם ייחודי בתוך הפרויקט Google Cloud .
נותנים לחשבון השירות cloud-run-pubsub-invoker את ההרשאה Invoker של Cloud Run:
```
gcloud run services add-iam-policy-binding service-name \
   --member=serviceAccount:cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com \
   --role=roles/run.invoker
```
כאשר:
- ‫service-name הוא השם של שירות Cloud Run שבו פורסים את האימג'.
- ‫project-id הוא מזהה הפרויקט. Google Cloud
יוצרים את הנושא cloud-builds כדי לקבל הודעות עדכון לגבי הגרסה של כלי ההתראות:
```
gcloud pubsub topics create cloud-builds
```
אפשר גם להגדיר שם נושא מותאם אישית בקובץ תצורת ה-build כדי שההודעות יישלחו לנושא המותאם אישית במקום זאת. במקרה כזה, יוצרים נושא עם אותו שם נושא מותאם אישית:
```
gcloud pubsub topics create topic-name
```
מידע נוסף זמין במאמר בנושא נושאי Pub/Sub להתראות על בנייה.
יוצרים מנוי Pub/Sub מסוג push עבור כלי ההתראה:
```
 gcloud pubsub subscriptions create subscriber-id \
   --topic=cloud-builds \
   --push-endpoint=service-url \
   --push-auth-service-account=cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com
```
כאשר:
- ‫subscriber-id הוא השם שרוצים לתת למינוי.
- ‫service-url היא כתובת ה-URL שנוצרה על ידי Cloud Run לשירות החדש.
- ‫project-id הוא מזהה הפרויקט. Google Cloud
הערה: כברירת מחדל, התוקף של מינויים פג אחרי 31 ימים של חוסר פעילות. אפשר לשנות את תקופת התפוגה או להשבית אותה באמצעות הוספת הדגל --expiration-period כשיוצרים את המינוי.

ההתראות על הפרויקט שלכם ב-Cloud Build מוגדרות עכשיו. בפעם הבאה שתפעילו בנייה, שרת ה-HTTP של הנמען בכתובת ה-URL שצוינה יקבל מטען ייעודי (payload) של JSON שתואם למשאב Build אם הבנייה תואמת למסנן שהגדרתם.

שימוש ב-CEL לסינון אירועים של בנייה

‫Cloud Build משתמש ב-CEL עם המשתנה build בשדות שמופיעים במשאב Build כדי לגשת לשדות שמשויכים לאירוע הבנייה, כמו מזהה הטריגר, רשימת התמונות או ערכי ההחלפה. אפשר להשתמש במחרוזת filter כדי לסנן אירועי בנייה בקובץ ההגדרות של הבנייה באמצעות כל שדה שמופיע במשאב Build. כדי למצוא את התחביר המדויק שמשויך לשדה, אפשר לעיין בקובץ cloudbuild.proto.

סינון לפי מזהה טריגר

כדי לסנן לפי מזהה טריגר, מציינים את ערך מזהה הטריגר בשדה filter באמצעות build.build_trigger_id, כאשר trigger-id הוא מזהה הטריגר כמחרוזת:

filter: build.build_trigger_id == trigger-id

סינון לפי סטטוס

כדי לסנן לפי סטטוס, מציינים את סטטוס הבנייה שרוצים לסנן לפיו בשדה filter באמצעות build.status.

בדוגמה הבאה אפשר לראות איך מסננים אירועי בנייה עם סטטוס SUCCESS באמצעות השדה filter:

filter: build.status == Build.Status.SUCCESS

אפשר גם לסנן את הגרסאות עם סטטוסים שונים. בדוגמה הבאה מוצג סינון של אירועי בנייה עם הסטטוס SUCCESS, FAILURE או TIMEOUT באמצעות השדה filter:

filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]

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

סינון לפי תג

כדי לסנן לפי תג, מציינים את הערך של התג בשדה filter באמצעות build.tags, כאשר tag-name הוא השם של התג:

filter: tag-name in build.tags

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

filter: size(build.tags) == 2 && "v1" in build.tags

סינון לפי תמונות

כדי לסנן לפי תמונות, מציינים את הערך של התמונה בשדה filter באמצעות build.images, כאשר image-name הוא השם המלא של התמונה כפי שמופיע ב-Artifact Registry, למשל us-east1-docker.pkg.dev/my-project/docker-repo/image-one:

filter: image-name in build.images

בדוגמה הבאה, המסנן filter פועל על אירועי בנייה שבהם us-east1-docker.pkg.dev/my-project/docker-repo/image-one או us-east1-docker.pkg.dev/my-project/docker-repo/image-two מצוינים כשמות תמונות:

filter: "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images || "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images

סינון לפי שעה

אפשר לסנן אירועים של בנייה לפי זמן היצירה, זמן ההתחלה או זמן הסיום של הבנייה. כדי לעשות זאת, צריך לציין אחת מהאפשרויות הבאות בשדה filter: build.create_time,‏ build.start_time או build.finish_time.

בדוגמה הבאה, השדה filter משתמש ב-timestamp כדי לסנן אירועי בנייה עם זמן בקשה ליצירת הבנייה ב-20 ביולי 2020 בשעה 6:00 בבוקר:

filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")

אפשר גם לסנן אירועי בנייה לפי השוואות של טווחי זמן. בדוגמה הבאה, השדה filter משתמש ב-timestamp כדי לסנן אירועי בנייה עם שעת התחלה בין 20 ביולי 2020 בשעה 6:00 לבין 30 ביולי 2020 בשעה 6:00.

filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")

מידע נוסף על האופן שבו אזורי זמן מבוטאים ב-CEL זמין בהגדרת השפה של אזורי זמן.

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

‫

filter: build.finish_time - build.start_time >= duration("5m")

סינון לפי החלפה

כדי לסנן לפי החלפה, מציינים את משתנה ההחלפה בשדה filter באמצעות build.substitutions. בדוגמה הבאה, השדה filter מפרט את הגרסאות שמכילות את משתנה ההחלפה substitution-variable, ובודק אם substitution-variable תואם ל-substitution-value שצוין:

filter: build.substitutions[substitution-variable] == substitution-value

כאשר:

‫substitution-variable הוא השם של משתנה ההחלפה.
‫substitution-value הוא השם של ערך ההחלפה.

אפשר גם לסנן לפי ערכי ברירת מחדל של משתני החלפה. בדוגמה הבאה, בשדה filter מופיעים build-ים עם שם הענף master ו-build-ים עם שם המאגר github.com/user/my-example-repo. משתני ההחלפה שמוגדרים כברירת מחדל, BRANCH_NAME ו-REPO_NAME, מועברים כמפתחות אל build.substitutions:

filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"

אם רוצים לסנן מחרוזות באמצעות ביטויים רגולריים, אפשר להשתמש בפונקציה המובנית matches. בדוגמה שלמטה, השדה filter מסנן גרסאות build עם סטטוס FAILURE או TIMEOUT, וגם גרסאות build עם משתנה החלפה TAG_NAME עם ערך שתואם לביטוי הרגולרי v{DIGIT}.{DIGIT}.{3 DIGITS}).

filter: build.status in [Build.Status.FAILURE, Build.Status.TIMEOUT] && build.substitutions["TAG_NAME"].matches("^v\\d{1}\\.\\d{1}\\.\\d{3}$")

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

הגדרת התראות HTTP קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

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

הגדרת התראות HTTP

שימוש ב-CEL לסינון אירועים של בנייה

סינון לפי מזהה טריגר

סינון לפי סטטוס

סינון לפי תג

סינון לפי תמונות

סינון לפי שעה

סינון לפי החלפה

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

הגדרת התראות HTTP