שלום Cloud Run עם Python

1. מבוא

‫Cloud Run היא פלטפורמת מחשוב מנוהלת שמאפשרת להריץ קונטיינרים בלי שמירת מצב שאפשר להפעיל באמצעות בקשות HTTP. הוא מבוסס על פרויקט הקוד הפתוח Knative, ומאפשר ניידות של עומסי העבודה בין פלטפורמות. ‫Cloud Run הוא שירות בלי שרת (serverless): הוא מסתיר את כל ניהול התשתית, כך שתוכלו להתמקד במה שהכי חשוב – יצירת אפליקציות מעולות.

במדריך הזה נסביר איך ליצור אפליקציית אינטרנט פשוטה ולפרוס אותה ב-Cloud Run.

2. הגדרה ודרישות

הגדרת סביבה בקצב אישי

1. נכנסים ל-מסוף Google Cloud ויוצרים פרויקט חדש או משתמשים בפרויקט קיים. אם עדיין אין לכם חשבון Gmail או Google Workspace, אתם צריכים ליצור חשבון.

• שם הפרויקט הוא השם המוצג של הפרויקט הזה למשתתפים. זו מחרוזת תווים שלא נמצאת בשימוש ב-Google APIs. תמיד אפשר לעדכן את המיקום.
• מזהה הפרויקט הוא ייחודי לכל הפרויקטים ב-Google Cloud, והוא קבוע (אי אפשר לשנות אותו אחרי שהוא מוגדר). מסוף Cloud יוצר באופן אוטומטי מחרוזת ייחודית, ובדרך כלל לא צריך לדעת מה היא. ברוב ה-Codelabs, תצטרכו להפנות למזהה הפרויקט (בדרך כלל מסומן כ-PROJECT_ID). אם אתם לא אוהבים את המזהה שנוצר, אתם יכולים ליצור מזהה אקראי אחר. אפשר גם לנסות שם משתמש משלכם ולבדוק אם הוא זמין. אי אפשר לשנות את ההגדרה הזו אחרי השלב הזה, והיא תישאר לאורך הפרויקט.
• לידיעתכם, יש ערך שלישי, מספר פרויקט, שחלק מממשקי ה-API משתמשים בו. במאמרי העזרה מפורט מידע נוסף על שלושת הערכים האלה.

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

הערה: אם אתם משתמשים בחשבון Gmail, אתם יכולים להשאיר את המיקום שמוגדר כברירת מחדל ללא ארגון. אם אתם משתמשים בחשבון Google Workspace, אתם צריכים לבחור מיקום שמתאים לארגון שלכם.

2. בשלב הבא, תצטרכו להפעיל את החיוב במסוף Cloud כדי להשתמש במשאבי Cloud או בממשקי API של Cloud. השלמת ה-codelab הזה לא תעלה לכם הרבה, אם בכלל. כדי להשבית את המשאבים ולמנוע חיובים נוספים אחרי שתסיימו את המדריך הזה, תוכלו למחוק את המשאבים שיצרתם או למחוק את הפרויקט. משתמשים חדשים ב-Google Cloud זכאים לתוכנית תקופת ניסיון בחינם בשווי 300$.

מפעילים את Cloud Shell

אפשר להפעיל את Google Cloud מרחוק מהמחשב הנייד, אבל במדריך הזה נשתמש ב-Cloud Shell, סביבת שורת פקודה שפועלת בענן.

הפעלת Cloud Shell

1. ב-Cloud Console, לוחצים על Activate Cloud Shell .

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

הקצאת המשאבים והחיבור ל-Cloud Shell נמשכים רק כמה רגעים.

המכונה הווירטואלית הזו כוללת את כל הכלים הדרושים למפתחים. יש בה ספריית בית בנפח מתמיד של 5GB והיא פועלת ב-Google Cloud, מה שמשפר מאוד את הביצועים והאימות ברשת. אפשר לבצע את רוב העבודה ב-codelab הזה, אם לא את כולה, באמצעות דפדפן.

אחרי שמתחברים ל-Cloud Shell, אמור להופיע אימות ושהפרויקט מוגדר לפי מזהה הפרויקט.

2. מריצים את הפקודה הבאה ב-Cloud Shell כדי לוודא שעברתם אימות:

gcloud auth list

פלט הפקודה

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

הערה: כלי שורת הפקודה gcloud הוא כלי שורת הפקודה העוצמתי והמאוחד של Google Cloud. הוא מותקן מראש ב-Cloud Shell. תשימו לב לתמיכה שלו בהשלמה אוטומטית של כרטיסיות. יכול להיות שתתבקשו לבצע אימות בפעם הראשונה שתריצו פקודה. למידע נוסף, ראו סקירה כללית של כלי שורת הפקודה של Google Cloud.

3. מריצים את הפקודה הבאה ב-Cloud Shell כדי לוודא שפקודת gcloud מכירה את הפרויקט:

gcloud config list project

פלט הפקודה

[core]
project = <PROJECT_ID>

אם לא, אפשר להגדיר אותו באמצעות הפקודה הבאה:

gcloud config set project <PROJECT_ID>

פלט הפקודה

Updated property [core/project].

הערה: אם אתם מבצעים את המדריך הזה מחוץ ל-Cloud Shell, אתם צריכים לפעול לפי ההוראות במאמר בנושא הגדרה של Application Default Credentials.

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

מפעילים את ממשקי ה-API של Artifact Registry,‏ Cloud Build ו-Cloud Run מ-Cloud Shell:

gcloud services enable \
  artifactregistry.googleapis.com \
  cloudbuild.googleapis.com \
  run.googleapis.com

יוצג פלט של הודעת הצלחה שדומה להודעה הזו:

Operation "operations/..." finished successfully.

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

• ‫Cloud Build יוצר באופן אוטומטי קובץ אימג' של קונטיינר מקוד המקור ומעביר אותו בדחיפה ל-Artifact Registry.
• Artifact Registry מנהל את קובץ האימג' של הקונטיינר.

עכשיו אפשר להתחיל לעבוד ולכתוב את הבקשה...

4. כתיבת הבקשה

בשלב הזה, תיצרו אפליקציית Python פשוטה שמבוססת על Flask ומגיבה לבקשות HTTP.

ספריית עבודה

משתמשים ב-Cloud Shell כדי ליצור ספריית עבודה בשם helloworld-python ועוברים אליה:

mkdir ~/helloworld-python
cd ~/helloworld-python

main.py

יוצרים קובץ בשם main.py:

touch main.py

עורכים את הקובץ באמצעות עורך שורת הפקודה המועדף (nano,‏ vim או emacs) או באמצעות לחיצה על הלחצן Cloud Shell Editor:

כדי לערוך את הקובץ ישירות באמצעות Cloud Shell Editor, משתמשים בפקודה הזו:

cloudshell edit main.py

main.py

from flask import Flask, request

app = Flask(__name__)


@app.get("/")
def hello():
    """Return a friendly HTTP greeting."""
    who = request.args.get("who", default="World")
    return f"Hello {who}!\n"


if __name__ == "__main__":
    # Development only: run "python main.py" and open http://localhost:8080
    # When deploying to Cloud Run, a production-grade WSGI HTTP server,
    # such as Gunicorn, will serve the app.
    app.run(host="localhost", port=8080, debug=True)

הקוד הזה יוצר שירות אינטרנט בסיסי שמגיב לבקשות HTTP GET עם הודעה ידידותית.

requirements.txt

מוסיפים קובץ בשם requirements.txt כדי להגדיר את יחסי התלות:

touch requirements.txt

כדי לערוך את הקובץ ישירות באמצעות Cloud Shell Editor, משתמשים בפקודה הזו:

cloudshell edit requirements.txt

requirements.txt

# https://pypi.org/project/flask
Flask==3.0.2

# https://pypi.org/project/gunicorn
gunicorn==21.2.0

Procfile

לבסוף, מוסיפים קובץ בשם Procfile כדי לציין איך האפליקציה תוצג:

touch Procfile

כדי לערוך את הקובץ ישירות באמצעות Cloud Shell Editor, משתמשים בפקודה הזו:

cloudshell edit Procfile

Procfile

web: gunicorn --bind :$PORT --workers 1 --threads 8 --timeout 0 main:app

מוודאים שכל הקבצים נמצאים בספריית העבודה:

ls

צריכים להופיע ברשימה הקבצים הבאים:

main.py  Procfile  requirements.txt

יש תיעוד של שפות רבות אחרות שניתן להשתמש בהן כדי להתחיל לעבוד עם Cloud Run. הוראות ל-Go,‏ Node.js,‏ Java,‏ C#‎,‏ C++‎,‏ PHP,‏ Ruby,‏ Shell scripts ועוד זמינות כאן: https://cloud.google.com/run/docs/quickstarts/build-and-deploy

האפליקציה מוכנה לפריסה, אבל כדאי לבדוק אותה קודם...

5. בדיקת האפליקציה

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

virtualenv venv

מפעילים את הסביבה הווירטואלית:

source venv/bin/activate

מתקינים את יחסי התלות:

pip install -r requirements.txt

אמורה להופיע הודעת אישור כמו זו:

...
Successfully installed Flask ... gunicorn ...

מפעילים את האפליקציה:

python main.py

ביומנים אפשר לראות שאתם במצב פיתוח:

 * Serving Flask app 'main'
 * Debug mode: on
   WARNING: This is a development server.
   Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Running on http://localhost:8080
   Press CTRL+C to quit
...

בחלון Cloud Shell, לוחצים על הסמל Web Preview ובוחרים באפשרות Preview on port 8080:

אמור להיפתח חלון בדפדפן עם ההודעה Hello World!.

אפשר גם לפתוח עוד סשן של Cloud Shell (כרטיסיית טרמינל חדשה) בלחיצה על הסמל + ושליחת בקשת אינטרנט לאפליקציה שפועלת באופן מקומי:

curl localhost:8080

אמורה להתקבל התשובה הבאה:

Hello World!

כשמסיימים, חוזרים לסשן הראשי של Cloud Shell ומפסיקים את הפקודה python main.py באמצעות CTRL+C.

יוצאים מהסביבה הווירטואלית:

deactivate

לבסוף, מסירים את ספריית הסביבה הווירטואלית:

rm -r venv/

האפליקציה פועלת כמו שצריך: בואו נבצע פריסה שלה...

6. פריסה ב-Cloud Run

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

REGION="europe-west9"

רשימת האזורים הנתמכים כרגע מופיעה במאמר מיקומים של Cloud Run (בניהול מלא).

מוודאים שאתם עדיין בספריית העבודה:

ls

צריכים להופיע ברשימה הקבצים הבאים:

main.py  Procfile  requirements.txt

פורסים את האפליקציה ב-Cloud Run:

gcloud run deploy helloworld-python \
  --source . \
  --platform managed \
  --region $REGION \
  --allow-unauthenticated

• אפשר להגדיר אזור ברירת מחדל באמצעות הפקודה הזו: gcloud config set run/region $REGION
• אפשר גם להגדיר את Cloud Run כברירת מחדל באמצעות הפקודה הבאה: gcloud config set run/platform managed
• האפשרות --allow-unauthenticated הופכת את השירות לזמין לכולם. כדי למנוע בקשות לא מאומתות, צריך להשתמש במדיניות --no-allow-unauthenticated במקום זאת.

כדי לבדוק את כל האפשרויות, משתמשים ב-gcloud run deploy --help.

בפעם הראשונה, תופיע בקשה ליצור מאגר Artifact Registry. מקישים על Enter כדי לאמת:

Deploying from source requires an Artifact Registry Docker repository to store
built containers. A repository named [cloud-run-source-deploy] in region [REGION]
will be created.

Do you want to continue (Y/n)?

הפעולה הזו תתחיל את ההעלאה של קוד המקור למאגר ב-Artifact Registry ואת יצירת קובץ אימג' של קונטיינר:

Building using Buildpacks and deploying container ...
* Building and deploying new service... Building Container.           
  OK Creating Container Repository...
  OK Uploading sources...
  * Building Container... Logs are available at ...

‫Cloud Build משתמש ב-Buildpacks שמזהה באופן אוטומטי את השפה של קוד המקור ויוצר קובץ אימג' של קונטיינר על סמך הגרסה היציבה האחרונה של רכיב התרגום ב-Python (Python 3.12 בזמן הכתיבה). במקרה הצורך, אפשר להצמיד את ה-build לגרסה ספציפית על ידי הוספת קובץ .python-version לספריית קובצי המקור. פרטים נוספים זמינים במאמר בנושא פיתוח אפליקציה ב-Python.

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

...
OK Building and deploying new service... Done.
  OK Creating Container Repository...
  OK Uploading sources...
  OK Building Container... Logs are available at ...
  OK Creating Revision... Creating Service.
  OK Routing traffic...
  OK Setting IAM Policy...
Done.
Service [SERVICE]... has been deployed and is serving 100 percent of traffic.
Service URL: https://SERVICE-PROJECTHASH-REGIONID.a.run.app

אפשר לקבל את כתובת ה-URL של השירות באמצעות הפקודה הזו:

SERVICE_URL=$( \
  gcloud run services describe helloworld-python \
  --platform managed \
  --region $REGION \
  --format "value(status.url)" \
)
echo $SERVICE_URL

אמור להופיע פלט שדומה לזה:

https://helloworld-python-PROJECTHASH-REGIONID.a.run.app

עכשיו אפשר להשתמש באפליקציה על ידי פתיחת כתובת ה-URL של השירות בדפדפן אינטרנט:

אפשר גם להתקשר לאפליקציה מ-Cloud Shell:

curl $SERVICE_URL?who=me

אמורה להופיע הודעת הפתיחה הצפויה:

Hello me!

במעבדת ה-Lab הקצרה הזו השתמשנו בשורת הפקודה gcloud, אבל אפשר להשתמש ב-Cloud Run גם דרך Cloud Console ( console.cloud.google.com/run). השירות helloworld אמור להופיע ברשימה:

אפשר גם להשתמש במסוף כדי לפרוס שירותי Cloud Run.

מעולה! הרגע פרסת אפליקציה ב-Cloud Run. ‫Cloud Run מבצע התאמה אוטומטית לעומס (autoscaling) של קובץ אימג' של קונטיינר באופן אופקי כדי לטפל בבקשות שהתקבלו, ואז מצמצם את ההקצאה כשהביקוש יורד. משלמים רק על ה-CPU, הזיכרון והרשת שנעשה בהם שימוש במהלך הטיפול בבקשות.

7. הסרת המשאבים

ב-Cloud Run לא מחויבים כשלא משתמשים בשירות, אבל יכול להיות שתחויבו על אחסון קובץ האימג' של הקונטיינר ב-Artifact Registry. כדי להימנע מחיובים, אפשר למחוק את המאגר או את פרויקט בענן. כשמוחקים פרויקט בענן, החיוב על כל המשאבים שנעשה בהם שימוש באותו פרויקט נפסק.

כדי למחוק את מאגר קובצי האימג' של הקונטיינר:

gcloud artifacts repositories delete cloud-run-source-deploy \
  --location $REGION

כדי למחוק את שירות Cloud Run:

gcloud run services delete helloworld-python \
  --platform managed \
  --region $REGION

כדי למחוק את הפרויקט בענן ב-Google Cloud,

1. מאחזרים את מזהה הפרויקט הנוכחי:

PROJECT_ID=$(gcloud config get-value core/project)

2. חשוב לוודא שזה הפרויקט שרוצים למחוק:

echo $PROJECT_ID

3. מחיקת הפרויקט:

gcloud projects delete $PROJECT_ID

8. מעולה!

יצרתם אפליקציית אינטרנט פשוטה ופרסתם אותה ב-Cloud Run.

מידע נוסף

• מסמכי העזרה של Cloud Run
• כדי לראות עוד אפשרויות, אפשר לעבור על השלבים במאמר Dev to Prod in Three Easy Steps with Cloud Run.
• כדי ליצור מסד נתונים של Cloud SQL, לנהל פרטי כניסה באמצעות Secret Manager ולפרוס את Django, צריך להשלים את המדריך Django ב-Cloud Run.
• כדאי לעיין בהדרכות נוספות של Cloud Run…

רישיון

עבודה זו מורשית תחת רישיון Creative Commons שמותנה בייחוס 2.0 כללי.