הפעלת Workflows באמצעות אירועים ישירים מ-Cloud Storage (ה-CLI של gcloud)
במדריך למתחילים הזה נסביר איך להריץ תהליך עבודה באמצעות טריגר Eventarc שמקבל אירועים מ-Cloud Storage.
הטריגר מפעיל את זרימת העבודה על ידי האזנה לאירוע יצירת אובייקט בקטגוריה של Cloud Storage, ומעביר את האירוע כארגומנט של זמן ריצה לזרימת עבודה של יעד.
במדריך למתחילים הזה:
יצירת קטגוריה של Cloud Storage כמקור אירועים.
שימוש ב-Workflows כדי ליצור ולפרוס תהליך עבודה שמחלץ ומחזיר את השם של קטגוריית האחסון ואת השם של קובץ שהועלה.
יוצרים טריגר Eventarc שמקשר את הקטגוריה של Cloud Storage למקבל האירועים של Workflows.
יוצרים אירוע על ידי העלאת קובץ טקסט לקטגוריה של Cloud Storage. האירוע הזה מועבר כארגומנט של זמן ריצה לתהליך העבודה של היעד.
כתוצאה מהרצת תהליך העבודה, רואים את שם הקטגוריה ואת שם קובץ הטקסט.
לחצו על תראו לי איך כדי לקרוא הסבר מפורט על המשימה ישירות במסוף Google Cloud :
לפני שמתחילים
יכול להיות שהגבלות אבטחה שהוגדרו בארגון שלכם ימנעו מכם להשלים את השלבים הבאים. מידע לפתרון בעיות זמין במאמר פיתוח אפליקציות בסביבה Google Cloud מוגבלת.
- נכנסים לחשבון Google Cloud . אנחנו ממליצים למשתמשים חדשים ב- Google Cloud ליצור חשבון כדי שיוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.
-
התקינו את ה-CLI של Google Cloud.
-
אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.
-
כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:
gcloud init -
יוצרים או בוחרים Google Cloud פרויקט.
תפקידים שנדרשים כדי לבחור או ליצור פרויקט
- Select a project: כדי לבחור פרויקט לא צריך תפקיד IAM ספציפי – אפשר לבחור כל פרויקט שקיבלתם בו תפקיד.
-
יצירת פרויקט: כדי ליצור פרויקט, צריך את התפקיד Project Creator (
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 פרויקט.
תפקידים שנדרשים כדי לבחור או ליצור פרויקט
- Select a project: כדי לבחור פרויקט לא צריך תפקיד IAM ספציפי – אפשר לבחור כל פרויקט שקיבלתם בו תפקיד.
-
יצירת פרויקט: כדי ליצור פרויקט, צריך את התפקיד Project Creator (
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 .
מפעילים את ממשקי ה-API של Compute Engine, Eventarc, Pub/Sub ו-Workflows.
gcloud services enable \ compute.googleapis.com \ eventarc.googleapis.com \ pubsub.googleapis.com \ workflows.googleapis.com \ workflowexecutions.googleapis.com
- עדכון רכיבים של
gcloud:gcloud components update
- נכנסים באמצעות החשבון:
gcloud auth login
הגדרת משתני הסביבה
מגדירים את משתני הסביבה שמשמשים במדריך למתחילים הזה.
export PROJECT_ID=PROJECT_ID
export WORKFLOW_LOCATION=us-central1
export TRIGGER_LOCATION=us-central1
gcloud config set project ${PROJECT_ID}
gcloud config set workflows/location ${WORKFLOW_LOCATION}
gcloud config set eventarc/location ${TRIGGER_LOCATION}
אפשר לראות את מזהה הפרויקט בדף Welcome במסוף Google Cloud .
הגדרת חשבונות השירות
נותנים את ההרשאות הנדרשות לחשבונות השירות שבהם משתמשים במדריך הזה.
-
אם אתם יוצרי הפרויקט, מוקצה לכם תפקיד הבעלים הבסיסי (
roles/owner). כברירת מחדל, תפקיד ניהול הזהויות והרשאות הגישה (IAM) הזה כולל את ההרשאות שנדרשות לגישה מלאה לרוב המשאבים Google Cloud, ואפשר לדלג על השלב הזה.אם אתם לא יוצרי הפרויקט, צריך להעניק את ההרשאות הנדרשות בחשבון המשתמש המתאים בפרויקט. לדוגמה, חשבון משתמש יכול להיות חשבון Google (למשתמשי קצה) או חשבון שירות (לאפליקציות ולעומסי עבודה ממוחשבים). מידע נוסף זמין בדף תפקידים והרשאות של יעד האירוע.
ההרשאות הנדרשות
כדי לקבל את ההרשאות שדרושות לביצוע ההפעלה המהירה הזו, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים בפרויקט:
- אדמין ב-Eventarc (
roles/eventarc.admin) - גישה לצפייה ביומנים (
roles/logging.viewAccessor) - אדמין IAM בפרויקט (
roles/resourcemanager.projectIamAdmin) - אדמין בחשבון שירות (
roles/iam.serviceAccountAdmin) - משתמש בחשבון שירות (
roles/iam.serviceAccountUser) - אדמין Service Usage (
roles/serviceusage.serviceUsageAdmin) - אדמין באחסון (
roles/storage.admin) - אדמין ב-Workflows (
roles/workflows.admin)
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
- אדמין ב-Eventarc (
חשוב לשים לב לחשבון השירות שמוגדר כברירת מחדל ב-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 אחד או יותר שמכילים את ההרשאות המינימליות הנדרשות, ולפעול לפי העיקרון של הרשאות מינימליות.
- מקצים את התפקיד 'מקבל אירועים ב-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
- מעניקים את התפקיד 'הפעלת Workflows' (
roles/workflows.invoker) בחשבון השירות שמוגדר כברירת מחדל של Compute Engine, כדי שלחשבון תהיה הרשאה להפעיל את זרימת העבודה.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/workflows.invoker
- מעניקים את התפקיד 'כותב יומנים' (
roles/logging.logWriter) בחשבון השירות שמוגדר כברירת מחדל ב-Compute Engine, כדי שיוכל לשלוח יומנים ל-Cloud Logging.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/logging.logWriter
- לפני שיוצרים טריגר לאירועים ישירים מ-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'
- אם הפעלתם את סוכן השירות של Cloud Pub/Sub ב-8 באפריל 2021 או לפני כן, כדי לתמוך בבקשות push מאומתות של 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
יצירת קטגוריה של Cloud Storage
יוצרים קטגוריה של Cloud Storage לשימוש כמקור האירועים:
gcloud storage buckets create gs://${PROJECT_ID}-bucket --location=us-central1
יצירה ופריסה של תהליך עבודה
יצירה ופריסה של תהליך עבודה שמופעל כשנוצר אובייקט בקטגוריה של Cloud Storage, ומשמש כטריגר לתהליך עבודה עם בקשת HTTP.
בספריית הבית, יוצרים קובץ חדש בשם
myEventWorkflow.yamlאוmyEventWorkflow.json.מעתיקים ומדביקים את הקוד הבא בקובץ החדש ושומרים אותו:
YAML
main: params: [event] steps: - log_event: call: sys.log args: text: ${event} severity: INFO - extract_bucket_object: assign: - bucket: ${event.data.bucket} - object: ${event.data.name} - return_bucket_object: return: bucket: ${bucket} object: ${object}
JSON
{ "main": { "params": [ "event" ], "steps": [ { "log_event": { "call": "sys.log", "args": { "text": "${event}", "severity": "INFO" } } }, { "extract_bucket_object": { "assign": [ { "bucket": "${event.data.bucket}" }, { "object": "${event.data.name}" } ] } }, { "return_bucket_object": { "return": { "bucket": "${bucket}", "object": "${object}" } } } ] } }
פורסים את תהליך העבודה:
export MY_WORKFLOW=myEventWorkflow gcloud workflows deploy ${MY_WORKFLOW} --source=myEventWorkflow.yamlמחליפים את
.yamlב-.jsonאם העתקתם את גרסת ה-JSON של תהליך העבודה לדוגמה.
יצירת טריגר Eventarc
הטריגר של Eventarc שולח אירועים מהקטגוריה של Cloud Storage ליעד Workflows.
יוצרים טריגר שמסנן אירועים של Cloud Storage:
gcloud eventarc triggers create storage-events-trigger \ --destination-workflow=${MY_WORKFLOW} \ --event-filters="type=google.cloud.storage.object.v1.finalized" \ --event-filters="bucket=${PROJECT_ID}-bucket" \ --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com"כך יוצרים טריגר בשם
storage-events-trigger.שימו לב: כשיוצרים טריגר Eventarc בפעם הראשונה בפרויקט Google Cloud , יכול להיות שיהיה עיכוב בהקצאת סוכן השירות של Eventarc. בדרך כלל אפשר לפתור את הבעיה הזו על ידי ניסיון ליצור את הטריגר מחדש. מידע נוסף זמין במאמר בנושא שגיאות שקשורות לסירוב הרשאה.
כדי לוודא שהזיכרון מ-
storage-events-triggerנוצר בהצלחה, מריצים את הפקודה:gcloud eventarc triggers describe storage-events-trigger --location=${TRIGGER_LOCATION}הפלט אמור להיראות כך, עם פירוט של שעת היצירה ומיקום ההפעלה:
createTime: '2021-10-14T15:15:43.872360951Z' [...] name: projects/PROJECT_ID/locations/us-central1/triggers/storage-events-trigger
יצירה וצפייה באירוע
כדי ליצור אירוע, מעלים קובץ טקסט ל-Cloud Storage:
echo "Hello World" > random.txt gcloud storage cp random.txt gs://${PROJECT_ID}-bucket/random.txtההעלאה יוצרת אירוע שמועבר כארגומנט של זמן ריצה לתהליך העבודה, שמחזיר את השמות של קטגוריית האחסון והקובץ שהועלה.
כדי לוודא שהפעלת זרימת עבודה הופעלה, מציגים את חמש ההפעלות האחרונות:
gcloud workflows executions list ${MY_WORKFLOW} --limit=5הפלט אמור להיראות כך, עם רשימה של NAME ו-STATE ששווים ל-
SUCCEEDEDלכל הרצת תהליך עבודה:NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/8c02b8f1-8836-4a6d-99d9-fc321eb9668f STATE: SUCCEEDED START_TIME: 2021-10-13T03:38:03.019148617Z END_TIME: 2021-10-13T03:38:03.249705805Z NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a STATE: SUCCEEDED START_TIME: 2021-10-13T17:28:51.492864252Z END_TIME: 2021-10-13T17:28:52.227212414Zשימו לב שבשדה
NAMEבדוגמה שלמעלה,a6319d9d-36a6-4117-904e-3d1118bdc90aהוא המזהה של הרצת תהליך העבודה. מעתיקים את מזהה ההפעלה כי תצטרכו אותו בשלב הבא.כדי לראות את סטטוס ההפעלה, מריצים את הפקודה הבאה:
gcloud workflows executions describe WORKFLOW_EXECUTION_ID --workflow=${MY_WORKFLOW}מחליפים את
WORKFLOW_EXECUTION_IDבמזהה של ההפעלה של זרימת העבודה שמתאימה לזמן שבו הקובץ הועלה לקטגוריה.הפלט אמור להיראות כך:
argument: [...] name: projects/218898424763/locations/us-central1/workflows/myEventWorkflow/executions/86d2567b-0f1e-49b3-8b10-cdac5d0f6239 result: '{"bucket":"PROJECT_ID-bucket","object":"random.txt"}' startTime: '2021-10-13T03:38:03.019148617Z' state: SUCCEEDEDמוודאים שהשעה,
"timeCreated": "2021-10-13T03:38"שבה הקטגוריה של Cloud Storage עודכנה, והשעהstartTimeשל הפעלת תהליך העבודה תואמות.
כל הכבוד, הצלחת ליצור אירוע ב-Cloud Storage שהפעיל מקלט אירועים של Workflows באמצעות Eventarc.
הסרת המשאבים
כדי לא לצבור חיובים בחשבון Google Cloud על המשאבים שבהם השתמשתם בדף הזה, אתם צריכים למחוק את הפרויקט Google Cloud יחד עם המשאבים.
מוחקים את תהליך העבודה שיצרתם:
gcloud workflows delete ${MY_WORKFLOW}כשמוצגת השאלה אם אתם רוצים להמשיך, מקישים על
y.מחיקת קטגוריית האחסון:
gcloud storage rm gs://${PROJECT_ID}-bucket/ --recursiveמוחקים את הטריגר שנוצר במדריך הזה:
gcloud eventarc triggers delete storage-events-triggerאפשרות אחרת היא למחוק את הפרויקט ב- Google Cloud כדי להימנע מחיובים. אם מוחקים את הפרויקט ב- Google Cloud , החיוב על כל המשאבים שנעשה בהם שימוש באותו פרויקט יופסק.
כדי למחוק Google Cloud פרויקט:
gcloud projects delete PROJECT_ID