העברת אירועים של מסד נתונים בזמן אמת ב-Firebase ל-Cloud Run

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

‫Eventarc מעביר אירועים למקבל האירועים בפורמט CloudEvents באמצעות בקשת HTTP.

ההוראות האלה מסבירות איך להגדיר ניתוב אירועים לשירות Cloud Run שמופעל על ידי אירועFirebase Realtime Database ישיר. פרטים נוספים זמינים ברשימה של אירועים ישירים נתמכים.

הכנות ליצירת טריגר

לפני שיוצרים טריגר, צריך לבצע את הפעולות הבאות:

המסוף

  1. בדף לבחירת הפרויקט במסוף Google Cloud , בוחרים פרויקט ב- Google Cloud או יוצרים אותו.

    כניסה לדף לבחירת הפרויקט

  2. מפעילים את Cloud Logging API,‏ Eventarc API ו-Eventarc Publishing API.

    הפעלת ממשקי ה-API

  3. אם רלוונטי, מפעילים את ממשק ה-API שקשור לאירועים הישירים. לדוגמה, כדי להשתמש ב Firebase Realtime Database אירועים, צריך להפעיל את ה-API שלFirebase Realtime Database .

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

    1. במסוף Google Cloud , נכנסים לדף יצירת חשבון שירות.

      כניסה לדף Create service account

    2. בוחרים את הפרויקט הרצוי.

    3. כותבים שם בשדה Service account name. השדה Service account ID ימולא במסוף Google Cloud בהתאם לשם הזה.

      כותבים תיאור בשדה Service account description. לדוגמה, Service account for event trigger.

    4. לוחצים על Create and continue.

    5. כדי לספק גישה מתאימה, ברשימה Select a role בוחרים את התפקידים הנדרשים בפלטפורמה לניהול זהויות והרשאות גישה (IAM) שרוצים להקצות לחשבון השירות עבור הפעלות מאומתות או לא מאומתות. מידע נוסף זמין במאמר תפקידים והרשאות ליעדים ב-Cloud Run.

      כדי להוסיף עוד תפקידים, לוחצים על Add another role ומוסיפים אותם אחד אחרי השני.

    6. לוחצים על Continue.

    7. כדי לסיים את יצירת החשבון, לוחצים על סיום.

gcloud

  1. במסוף Google Cloud , מפעילים את Cloud Shell.

    הפעלת Cloud Shell

    בחלק התחתון של Google Cloud המסוף יתחיל סשן של Cloud Shell ותופיע הודעה של שורת הפקודה. Cloud Shell היא סביבת מעטפת שבה ה-CLI של Google Cloud מותקן ומוגדרים ערכים לפרויקט הקיים. הסשן יופעל תוך כמה שניות.

  2. מפעילים את Cloud Logging API,‏ Eventarc API ו-Eventarc Publishing API.

    gcloud services enable logging.googleapis.com \
      eventarc.googleapis.com \
      eventarcpublishing.googleapis.com

  3. אם רלוונטי, מפעילים את ממשק ה-API שקשור לאירועים הישירים. לדוגמה, כדי להפעיל את האפשרות firebasedatabase.googleapis.com לאירועים, צריך להזין את הערך Firebase Realtime Database events.

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

    1. יוצרים את חשבון השירות:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      מחליפים את SERVICE_ACCOUNT_NAME בשם של חשבון השירות. הוא צריך להכיל בין 6 ל-30 תווים, והוא יכול לכלול תווים אלפאנומריים קטנים ומקפים. אחרי שיוצרים חשבון שירות, אי אפשר לשנות את השם שלו.

    2. נותנים את התפקידים או ההרשאות הנדרשים בניהול הזהויות והרשאות הגישה (IAM) להפעלות מאומתות או לא מאומתות. מידע נוסף זמין במאמר תפקידים והרשאות ליעדים ב-Cloud Run.

יצירת טריגר

אפשר ליצור טריגר Eventarc באמצעות Google Cloud CLI או דרך מסוף Google Cloud .

המסוף

  1. נכנסים לדף Triggers ב-Eventarc במסוף Google Cloud .

    כניסה לדף Triggers

  2. לוחצים על Create trigger (יצירת ביטוי להפעלה).
  3. מקלידים Trigger name.

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

  4. בשדה Trigger type, בוחרים באפשרות Google sources.
  5. ברשימה Event provider בוחרים באפשרות Firebase Realtime Database.

    שימו לב: יכול להיות שבשם ספק האירועים שמופיע בGoogle Cloud מסמכי התיעוד המשויכים לא מופיעה הקידומת Cloud או Google Cloud. לדוגמה, במסוף, Memorystore for Redis נקרא Google Cloud Memorystore for Redis.

  6. ברשימה סוג האירוע, מתוך האירועים ישירים, בוחרים סוג אירוע.
  7. ברשימה סוג התוכן של נתוני האירועים, בוחרים את הקידוד של מטען הייעודי (payload) של האירוע.

    עבור אירועים ישירים מ- Firebase Realtime Database, הערך צריך להיות application/json.

  8. ברשימה Region, בוחרים את אותו אזור כמוGoogle Cloud השירות שמייצר את האירועים.

    מידע נוסף זמין במאמר בנושא מיקומי Eventarc.

  9. בשדה Attribute 1 (מאפיין 1), instance (מופע) resource ID (מזהה משאב) משמש כמסנן אירועים. בוחרים אופרטור למסנן הזה:
  10. בשדה ערך מאפיין 1, מזינים את השם של מופע מסד הנתונים שממנו יתקבלו אירועים. בהתאם לאופרטור שבחרתם בשלב הקודם, ערך המאפיין צריך להיות השם המדויק או פורמט של תבנית נתיב.
  11. בוחרים באופרטור Path pattern (תבנית נתיב) עבור המאפיין ref.
  12. בשדה Attribute value 2 (ערך מאפיין 2), מזינים את הנתיב של מופע מסד הנתונים כדי לקבל אירועים אם הנתונים נוצרים, מתעדכנים או נמחקים בנתיב הזה או בכל נתיב צאצא.
  13. בוחרים את חשבון השירות שיפעיל את השירות או את תהליך העבודה.

    אפשר גם ליצור חשבון שירות חדש.

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

  14. ברשימה Event destination, בוחרים באפשרות Cloud Run.
  15. בוחרים שירות.

    זהו שם השירות שמקבל את האירועים להפעלת הטריגר. השירות צריך להיות באותו פרויקט כמו הטריגר, והוא יקבל אירועים כבקשות HTTP POST שנשלחות לנתיב של כתובת ה-URL הבסיסית שלו (/), בכל פעם שהאירוע נוצר.

  16. אפשר לציין נתיב לכתובת ה-URL של השירות כדי לשלוח את הבקשה הנכנסת.

    זהו הנתיב היחסי בשירות היעד שאליו יישלחו האירועים של הטריגר. לדוגמה: /, /route, route, route/subroute.

  17. אפשר גם ללחוץ על הוספת תווית. תוויות הן צמדי מפתח/ערך שעוזרים לכם לארגן אתGoogle Cloud המשאבים. מידע נוסף זמין במאמר מהן תוויות?
  18. לוחצים על יצירה.
  19. אחרי שיוצרים טריגר, אי אפשר לשנות את המסננים של מקור האירוע. במקום זאת, צריך ליצור טריגר חדש ולמחוק את הטריגר הישן. מידע נוסף זמין במאמר בנושא ניהול טריגרים.

gcloud

כדי ליצור טריגר, מריצים פקודה עם דגלים נדרשים ואופציונליים.gcloud eventarc triggers create

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="instance=INSTANCE" \
    --event-filters-path-pattern="ref=REF" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

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

  • TRIGGER: המזהה של הטריגר או מזהה מלא.
  • LOCATION: המיקום של טריגר Eventarc. אפשר גם להגדיר את המאפיין eventarc/location. לדוגמה: gcloud config set eventarc/location us-central1.

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

  • DESTINATION_RUN_SERVICE: השם של שירות Cloud Run שמקבל את האירועים של הטריגר. השירות יכול להיות בכל אחד מהמיקומים הנתמכים של Cloud Run, והוא לא צריך להיות באותו מיקום כמו הטריגר. עם זאת, השירות צריך להיות באותו פרויקט כמו הטריגר והוא יקבל אירועים כבקשות HTTP POST שנשלחות לנתיב כתובת ה-URL הבסיסית שלו (/), בכל פעם שהאירוע נוצר.
  • DESTINATION_RUN_REGION: (אופציונלי) האזור שבו נמצא שירות היעד של Cloud Run. אם לא מציינים זאת, המערכת מניחה שהשירות נמצא באותו אזור כמו הטריגר.
  • EVENT_FILTER_TYPE: המזהה של האירוע במסד הנתונים בזמן אמת ב-Firebase. יכול להיות אחד מהערכים הבאים:

    • google.firebase.database.ref.v1.created: האירוע נשלח כשנתונים נוצרים במסד הנתונים
    • google.firebase.database.ref.v1.updated: האירוע נשלח כשהנתונים מתעדכנים במסד הנתונים
    • google.firebase.database.ref.v1.deleted: האירוע נשלח כשנתונים נמחקים במסד הנתונים
    • google.firebase.database.ref.v1.written: האירוע נשלח כשנתונים נוצרים, מתעדכנים או נמחקים במסד הנתונים
  • INSTANCE: מופע יחיד של מסד נתונים, והאופרטור יכול להיות אחד מהבאים:

    • שווה; לדוגמה, --event-filters="instance=INSTANCE"
    • דפוס נתיב; לדוגמה, --event-filters-path-pattern="instance=INSTANCE". מידע נוסף זמין במאמר הסבר על דפוסי נתיבים.
  • REF: הנתיב בתוך מופע מסד הנתונים שאתם רוצים לקבל ממנו אירועים כשנתונים נוצרים, מתעדכנים או נמחקים בנתיב הזה או בכל אחד מהנתיבים המשניים שלו.

  • SERVICE_ACCOUNT_NAME: השם של חשבון השירות שמנוהל על ידי המשתמש.
  • PROJECT_ID: מזהה הפרויקט ב- Google Cloud .

הערות:

  • באירועים ישירים מ- Firebase Realtime Database, הקידוד של מטען הייעודי (payload) של האירוע הוא application/json.
  • חובה להשתמש בדגלים הבאים:
    • --event-filters="type=EVENT_FILTER_TYPE"
    • --event-filters="instance=INSTANCE" או --event-filters-path-pattern="instance=INSTANCE"
    • --event-filters-path-pattern="ref=REF"
  • אחרי שיוצרים טריגר, אי אפשר לשנות את סוג המסנן של האירועים. כדי להגדיר סוג אירוע אחר, צריך ליצור טריגר חדש.
  • הדגל --service-account משמש לציון כתובת האימייל בחשבון השירות בניהול זהויות והרשאות גישה (IAM) שמשויך לטריגר.
  • אפשר לציין נתיב יחסי בשירות היעד של Cloud Run שאליו הטריגר צריך לשלוח את האירועים באמצעות הדגל --destination-run-path.

דוגמה:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-central1 \
    --destination-run-service=helloworld-events \
    --destination-run-region=us-central1 \
    --event-filters="type=google.firebase.database.ref.v1.created" \
    --event-filters="instance=test-instance" \
    --event-filters-path-pattern="ref=users/*" \
    --service-account=${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com

הפקודה הזו יוצרת טריגר בשם helloworld-trigger לאירוע שמזוהה בתור google.firebase.database.ref.v1.created ולנתיב users/* במופע של מסד הנתונים שמזוהה בתור test-instance.

Terraform

אפשר ליצור טריגר ליעד ב-Cloud Run באמצעות Terraform. פרטים נוספים זמינים במאמר יצירת טריגר באמצעות Terraform.

הצגת טריגר

אפשר לאשר את יצירת הטריגר באמצעות רשימת הטריגרים של Eventarc ב-Google Cloud CLI או במסוף Google Cloud .

המסוף

  1. נכנסים לדף Triggers ב-Eventarc במסוף Google Cloud .

    כניסה לדף Triggers

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

  2. כדי לסנן את הטריגרים:

    1. לוחצים על Filter (מסנן) או על השדה Filter triggers (טריגרים של מסנן).
    2. ברשימה Properties, בוחרים אפשרות לסינון הטריגרים.

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

  3. כדי למיין את הטריגרים, לוחצים על מיון לצד כותרת של עמודה נתמכת.

gcloud

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

gcloud eventarc triggers list --location=-

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

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