במדריך הזה נסביר איך לכתוב ולהפעיל פונקציות Cloud Run מבוססות-אירועים באמצעות טריגר של Pub/Sub.
אתם יכולים להגדיר את ניתוב האירועים, כולל מקור האירוע ויעד האירוע, על ידי ציון מסננים לטריגר של Eventarc. בדוגמה שבמדריך הזה, פרסום הודעה בנושא Pub/Sub מפעיל את האירוע, ובקשה נשלחת לפונקציה שלכם בצורה של בקשת HTTP.
אם אתם חדשים ב-Pub/Sub ורוצים לקבל מידע נוסף, עיינו במסמכי התיעוד של Pub/Sub כדי למצוא מדריכי Quickstart ומקורות מידע חשובים.
מטרות
במדריך הזה תלמדו:
עלויות
במסמך הזה משתמשים ברכיבים הבאים של Google Cloud, והשימוש בהם כרוך בתשלום:
בעזרת מחשבון העלויות אתם יכולים להעריך את העלויות בהתאם לשימוש הצפוי.
לפני שמתחילים
יכול להיות שאילוצי אבטחה שהוגדרו על ידי הארגון שלכם ימנעו מכם להשלים את השלבים הבאים. למידע על פתרון בעיות, קראו את המאמר פיתוח אפליקציות בסביבה מוגבלת של Google Cloud .
- נכנסים לחשבון Google Cloud . אנחנו ממליצים למשתמשים חדשים ב- Google Cloud ליצור חשבון כדי שיוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.
-
התקינו את ה-CLI של Google Cloud.
-
אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.
-
כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:
gcloud init -
יוצרים או בוחרים פרויקט ב- Google Cloud .
התפקידים שנדרשים כדי לבחור או ליצור פרויקט
- בחירת פרויקט: כדי לבחור פרויקט לא נדרש תפקיד IAM ספציפי – אתם יכולים לבחור כל פרויקט שקיבלתם בו תפקיד.
-
יצירת פרויקט: כדי ליצור פרויקט, צריך את התפקיד "יצירת פרויקטים" (
roles/resourcemanager.projectCreator), שכולל את ההרשאהresourcemanager.projects.create. איך מקצים תפקידים?
-
יוצרים פרויקט ב- Google Cloud :
gcloud projects create PROJECT_ID
מחליפים את
PROJECT_IDבשם של הפרויקט ב- Google Cloud שאתם יוצרים. -
בוחרים את הפרויקט שיצרתם ב- Google Cloud :
gcloud config set project PROJECT_ID
מחליפים את
PROJECT_IDבשם הפרויקט ב- Google Cloud .
-
התקינו את ה-CLI של Google Cloud.
-
אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.
-
כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:
gcloud init -
יוצרים או בוחרים פרויקט ב- Google Cloud .
התפקידים שנדרשים כדי לבחור או ליצור פרויקט
- בחירת פרויקט: כדי לבחור פרויקט לא נדרש תפקיד IAM ספציפי – אתם יכולים לבחור כל פרויקט שקיבלתם בו תפקיד.
-
יצירת פרויקט: כדי ליצור פרויקט, צריך את התפקיד "יצירת פרויקטים" (
roles/resourcemanager.projectCreator), שכולל את ההרשאהresourcemanager.projects.create. איך מקצים תפקידים?
-
יוצרים פרויקט ב- Google Cloud :
gcloud projects create PROJECT_ID
מחליפים את
PROJECT_IDבשם של הפרויקט ב- Google Cloud שאתם יוצרים. -
בוחרים את הפרויקט שיצרתם ב- Google Cloud :
gcloud config set project PROJECT_ID
מחליפים את
PROJECT_IDבשם הפרויקט ב- Google Cloud .
- אם אתם לא משתמשים ב-Cloud Shell, עדכנו את הרכיבים של Google Cloud CLI והתחברו באמצעות החשבון שלכם:
gcloud components update gcloud auth login
- מפעילים את ממשקי ה-API:
gcloud services enable artifactregistry.googleapis.com \ cloudbuild.googleapis.com \ eventarc.googleapis.com \ run.googleapis.com \ logging.googleapis.com \ pubsub.googleapis.com
- מגדירים את משתני התצורה שמשמשים במדריך הזה:
export REGION=us-central1 gcloud config set run/region ${REGION} gcloud config set run/platform managed gcloud config set eventarc/location ${REGION}
- יוצרים חשבון שירות:
SERVICE_ACCOUNT=eventarc-trigger-sa gcloud iam service-accounts create $SERVICE_ACCOUNT
אם אתם כפופים לכלל מדיניות של הארגון של הגבלה לפי דומיין שמגבילה הפעלות לא מאומתות לפרויקט, תצטרכו לגשת לשירות שנפרס כמו שמתואר בקטע בדיקת שירותים פרטיים.
התפקידים הנדרשים
אתם או האדמין שלכם צריכים להקצות את תפקידי ה-IAM הבאים לחשבון הפריסה, לזהות של הטריגר, ולסוכני השירות של Pub/Sub ו-Cloud Storage (אופציונלי).
התפקידים הנדרשים לחשבון הפריסה
-
אם אתם יוצרי הפרויקט, אתם מקבלים את התפקיד הבסיסי "בעלים" (
roles/owner). כברירת מחדל, תפקיד ה-IAM הזה כולל את ההרשאות שנדרשות לגישה מלאה לרוב המשאבים של Google Cloud, ואתם יכולים לדלג על השלב הזה.אם אתם לא יוצרי הפרויקט, צריך לתת את ההרשאות הנדרשות בפרויקט לחשבון המשתמש המתאים. לדוגמה, חשבון משתמש יכול להיות חשבון Google (למשתמשי קצה) או חשבון שירות (לאפליקציות ולעומסי עבודה ממוחשבים). מידע נוסף זמין בדף תפקידים והרשאות של יעד האירוע.
כדי לקבל את ההרשאות שדרושות להשלמת המדריך, בקשו מהאדמין להקצות לכם את התפקידים הבאים ב-IAM בפרויקט:
- מפתח מקורות ב-Cloud Run (
roles/run.sourceDeveloper) - אדמין IAM בפרויקט (
roles/resourcemanager.projectIamAdmin) - משתמש בחשבון שירות (
roles/iam.serviceAccountUser) - אדמין ב-Service Usage (
roles/serviceusage.serviceUsageAdmin) - גישה לתצוגת יומנים (
roles/logging.viewAccessor)
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
שימו לב שכברירת מחדל, ההרשאות של Cloud Build כוללות הרשאות להעלאה ולהורדה של פריטי מידע שנוצרו ב-Artifact Registry.
- מפתח מקורות ב-Cloud Run (
התפקידים הנדרשים לזהות הטריגר
שימו לב לחשבון השירות שמוגדר כברירת מחדל ב-Compute Engine, כי תצטרכו לצרף אותו לטריגר של Eventarc כדי לייצג את הזהות של הטריגר לצורכי בדיקה. חשבון השירות הזה נוצר באופן אוטומטי אחרי שמפעילים שירות של Google Cloud שמשתמש ב-Compute Engine, או משתמשים בשירות כזה. כתובת האימייל שלו היא בפורמט הבא:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
מחליפים את
PROJECT_NUMBERבמספר הפרויקט ב- Google Cloud. אפשר לראות את מספר הפרויקט בדף Welcome במסוף Google Cloud , או להריץ את הפקודה הבאה:gcloud projects describe PROJECT_ID --format='value(projectNumber)'
בסביבות ייצור, מומלץ מאוד ליצור חשבון שירות חדש ולהקצות לו תפקיד אחד או יותר ב-IAM, שמכילים את ההרשאות המינימליות הנדרשות ופועלים לפי העיקרון של הרשאות מינימליות.
- כברירת מחדל, רק בעלי פרויקטים, עורכי פרויקטים, אדמינים של Cloud Run ומפעילים של Cloud Run יכולים להפעיל שירותי Cloud Run.
אתם יכולים לשלוט בגישה לכל שירות בנפרד, אבל למטרות בדיקה, כדאי לתת לחשבון השירות של Compute Engine את התפקיד "מפעיל Cloud Run" (
run.invoker) בפרויקט Google Cloud . כך מקצים את התפקיד בכל השירותים והמשימות של Cloud Run בפרויקט.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/run.invoker
שימו לב שאם יוצרים טריגר לשירות Cloud Run מאומת בלי להקצות את התפקיד Cloud Run Invoker, הטריגר נוצר בהצלחה והוא פעיל. עם זאת, הטריגר לא יפעל כמו שצריך ותופיע הודעה דומה לזו ביומנים:
The request was not authenticated. Either allow public access or set the proper Authorization header. - מקצים את התפקיד "מקבל אירועים ב-Eventarc" (
roles/eventarc.eventReceiver) בפרויקט לחשבון השירות שמוגדר כברירת מחדל ב-Compute Engine, כדי שהטריגר של Eventarc יוכל לקבל אירועים מספקי אירועים.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/eventarc.eventReceiver
תפקיד אופציונלי לסוכן השירות של Cloud Storage
- לפני שיוצרים טריגר לאירועים ישירים מ-Cloud Storage, צריך לתת לסוכן השירות של Cloud Storage את התפקיד "פרסום הודעות ב-Pub/Sub" (
roles/pubsub.publisher):SERVICE_ACCOUNT="$(gcloud storage service-agent --project=PROJECT_ID)" gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:${SERVICE_ACCOUNT}" \ --role='roles/pubsub.publisher'
תפקיד אופציונלי לסוכן השירות של Pub/Sub
- אם הפעלתם את סוכן השירות של Cloud Pub/Sub ב-8 באפריל 2021 או לפני כן, כדי לתמוך בבקשות דחיפה מאומתות של Pub/Sub, צריך להקצות לסוכן השירות את התפקיד "יצירת אסימונים בחשבון שירות" (
roles/iam.serviceAccountTokenCreator). אחרת, התפקיד הזה מוקצה כברירת מחדל:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
יוצרים נושא Pub/Sub
כשפורסים פונקציה ב-Cloud Run, נושאי Pub/Sub לא נוצרים באופן אוטומטי. לפני פריסת הפונקציה, צריך לפרסם הודעה בנושא הזה ב-Pub/Sub כדי להפעיל את הפונקציה:
gcloud pubsub topics create YOUR_TOPIC_NAME
הכנת האפליקציה
משכפלים את המאגר של האפליקציה לדוגמה ומעבירים אותו למכונה המקומית:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.gitPython
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.gitGo
git clone https://github.com/GoogleCloudPlatform/golang-samples.gitJava
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git.NET
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.gitRuby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.gitPHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.gitעוברים לספרייה שמכילה את הקוד לדוגמה לגישה ל-Pub/Sub:
Node.js
cd nodejs-docs-samples/functions/v2/helloPubSub/Python
cd python-docs-samples/functions/v2/pubsub/Go
cd golang-samples/functions/functionsv2/hellopubsub/Java
cd java-docs-samples/functions/v2/pubsub/.NET
cd dotnet-docs-samples/functions/helloworld/HelloPubSub/Ruby
cd ruby-docs-samples/functions/helloworld/pubsub/PHP
cd php-docs-samples/functions/helloworld_pubsub/הנה קוד לדוגמה:
Node.js
Python
Go
Java
.NET
Ruby
PHP
פריסת פונקציה מבוססת-אירועים
כדי לפרוס את הפונקציה, מריצים את הפקודה הבאה בספרייה שמכילה את הקוד לדוגמה:
Node.js
gcloud run deploy FUNCTION \
--source . \
--function helloPubSub \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
nodejs24. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
Python
gcloud run deploy FUNCTION \
--source . \
--function subscribe \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
python314. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
המשך
gcloud run deploy FUNCTION \
--source . \
--function HelloPubSub \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
go127. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
Java
gcloud run deploy FUNCTION \
--source . \
--function functions.SubscribeToTopic \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
java25. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
.NET
gcloud run deploy FUNCTION \
--source . \
--function HelloPubSub.Function \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
dotnet10. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
Ruby
gcloud run deploy FUNCTION \
--source . \
--function hello_pubsub \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
ruby40. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
PHP
gcloud run deploy FUNCTION \
--source . \
--function helloworldPubsub \
--base-image BASE_IMAGE \
מחליפים את:
- FUNCTION בשם הפונקציה שאתם פורסים. אם לא תציינו את הפרמטר הזה, תתבקשו להזין שם כשתריצו את הפקודה.
- BASE_IMAGE בסביבת קובץ האימג' הבסיסי של הפונקציה, לדוגמה
php85. למידע נוסף על קובצי אימג' בסיסיים ועל החבילות שכלולות בכל קובץ אימג', קראו את המאמר סביבות זמן ריצה של שפות נתמכות וקובצי אימג' בסיסיים.
אם תתבקשו ליצור מאגר באזור שצוין, הקישו על y.
בסיום הפריסה, ב-Google Cloud CLI תוצג כתובת ה-URL שבה השירות פועל.
יצירת טריגר של Eventarc
כדי לפרוס את הפונקציה עם טריגר של Pub/Sub, מריצים את הפקודה הבאה בספרייה שמכילה את הקוד לדוגמה:
יוצרים טריגר של Eventarc Pub/Sub:
gcloud eventarc triggers create TRIGGER_NAME \ --location=${REGION} \ --destination-run-service=FUNCTION \ --destination-run-region=${REGION} \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
מחליפים את:
- TRIGGER_NAME בשם של הטריגר.
- FUNCTION בשם של הפונקציה.
- PROJECT_NUMBER במספר הפרויקט ב- Google Cloud .
שימו לב: כשיוצרים טריגר של Eventarc בפעם הראשונה בפרויקט ב- Google Cloud , יכול להיות עיכוב בהקצאה של סוכן השירות של Eventarc. בדרך כלל אפשר לפתור את הבעיה הזו אם מנסים ליצור את הטריגר שוב. מידע נוסף זמין במאמר שגיאות של דחיית הרשאה.
מוודאים שהטריגר נוצר בהצלחה. שימו לב: למרות שהטריגר נוצר באופן מיידי, יכול להיות שיעברו עד שתי דקות עד שהוא יפעל באופן מלא.
gcloud eventarc triggers list --location=${REGION}
הפלט אמור להיראות כך:
NAME: helloworld-events TYPE: google.cloud.pubsub.topic.v1.messagePublished DESTINATION: Cloud Run service: helloworld-events ACTIVE: Yes LOCATION: us-central1
הפעלת הפונקציה
כדי לבדוק את הפונקציה של Pub/Sub:
מקצים את הנושא למשתנה:
TOPIC_ID=$(gcloud eventarc triggers describe TRIGGER_NAME --location $REGION --format='value(transport.pubsub.topic)')מפרסמים הודעה בנושא:
gcloud pubsub topics publish $TOPIC_ID --message="Hello World"
שירות Cloud Run מתעד את גוף ההודעה הנכנסת. אפשר לראות את זה בקטע Logs של המכונה ב-Cloud Run:
- עוברים אל Google Cloud מסוף.
- לוחצים על הפונקציה.
לוחצים על הכרטיסייה יומנים.
יכול להיות שייקח ליומנים כמה דקות להופיע. אם הם לא מופיעים מיד, כדאי לבדוק שוב אחרי כמה דקות.
מחפשים את ההודעה "Hello World!".
הסרת המשאבים
אם יצרתם פרויקט חדש בשביל המדריך הזה, מחקו את הפרויקט. אם השתמשתם בפרויקט קיים ואתם רוצים לשמור אותו בלי השינויים שנוספו במדריך הזה, מחקו את המשאבים שנוצרו בשביל המדריך.
מחיקת הפרויקט
הדרך הקלה ביותר לבטל את החיוב היא למחוק את הפרויקט שיצרתם בשביל המדריך הזה.
כדי למחוק את הפרויקט:
- במסוף Google Cloud , נכנסים לדף Manage resources.
- ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete.
- כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.
מחיקת משאבי המדריך
מוחקים את השירות ב-Cloud Run שפרסתם במדריך הזה:
gcloud run services delete SERVICE_NAME
כאשר
SERVICE_NAMEהוא שם השירות שבחרתם.אפשר גם למחוק שירותי Cloud Run ממסוףGoogle Cloud .
מסירים את כל הגדרות ברירת המחדל של ה-CLI של gcloud שהוספתם במהלך ההגדרה של המדריך.
לדוגמה:
gcloud config unset run/regionאו
gcloud config unset projectמוחקים משאבים אחרים של Google Cloud שנוצרו במדריך הזה:
- מוחקים את הטריגר של Eventarc:
מחליפים אתgcloud eventarc triggers delete TRIGGER_NAME
TRIGGER_NAMEבשם הטריגר.
- מוחקים את הטריגר של Eventarc: