שלום Cloud Run עם Python

1. מבוא

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

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

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

הגדרת סביבה בקצב עצמאי

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

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

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

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

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

הפעלת Cloud Shell

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

הפעלת Cloud Shell

1. במסוף Cloud, לוחצים על 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

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

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 ואחרים זמינים כאן: 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 כך שהיא תהיה זמינה באופן יתירות בכל התחומים (zones) באותו אזור. מגדירים את האזור שישמש לפריסה, לדוגמה:

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 ואת ה-build של קובץ האימג' בקונטיינר:

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 מגדיל את קובץ האימג' של הקונטיינר באופן אוטומטי ואופקי כדי לטפל בבקשות שהתקבלו, ואז מקטין את הפוטנציאל כשהביקוש יורד. התשלום הוא רק על המעבד (CPU), הזיכרון והרשת שנצרכו במהלך הטיפול בבקשה.

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

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

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

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 בשלושה שלבים פשוטים עם Cloud Run כדי לגלות אפשרויות נוספות
• להשלים את Django ב-Cloud Run כדי ליצור Cloud SQL DB, לנהל פרטי כניסה באמצעות Secret Manager ולפרוס את Django
• למידע נוסף על codelabs ב-Cloud Run...

רישיון

היצירה הזו בשימוש ברישיון Creative Commons Attribution 2.0 גנרי.