איך בונים פונקציות בקונטיינרים

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

תרחישי שימוש נפוצים לפיתוח פונקציות בקונטיינר כוללים:

• אינטגרציה רציפה (CI) ופריסה רציפה (CD): המפתחים יוצרים את קוד הפונקציה ומעבירים אותו למאגר מקור, מערכת CI/CD יוצרת באופן אוטומטי את הפונקציה בקונטיינר, מריצה בדיקות ופורסת אותה באופן אוטומטי בסביבת Staging.
• תשתית כקוד: משאבי Cloud Run שמנוהלים באמצעות YAML או Terraform מפנים לכתובת URL של קובץ אימג' של קונטיינר. קוד הפונקציה שנכתב על ידי מפתחים צריך להיבנות לקובץ אימג' של קונטיינר.

בדף הזה מוסבר איך לשכפל את תהליך הבנייה המדויק של פונקציות Cloud Run בשתי דרכים:

• שימוש ב-pack CLI
• שימוש ב-Cloud Build כמערכת פיתוח מרחוק

נקודת הכניסה של הפונקציה

כדי ליצור פונקציות עם buildpacks:

• כוללים את הספרייה Functions Framework.

• מגדירים את הערך של משתנה הסביבה GOOGLE_FUNCTION_TARGET לשם של הפונקציה שבה משתמשים כנקודת הכניסה. כדי לעשות זאת, צריך לכלול project.toml באותה תיקייה של קוד המקור. קובץ project.toml צריך לכלול את ההגדרות הבאות:

[[build.env]]
    name = "GOOGLE_FUNCTION_TARGET"
    value =  "ENTRY_POINT"

מחליפים את ENTRY_POINT בשיטת הפונקציה.

במאמר הגדרת שירותי פונקציות Cloud Run מוסבר איך משתמשים במשתני סביבה בפונקציות Cloud Run.

Builders

פונקציות Cloud Run מבוססות על קובצי אימג' בסיסיים שמתוחזקים ומתפרסמים במסגרת ה-buildpacks של Google Cloud.

Builders הם קובצי אימג' שמורכבים מ-buildpacks ומחבילות של מערכת הפעלה (שנקראים גם Stacks). הכלי Builders משמש להמרת קוד המקור של הפונקציה לקונטיינר פעיל.

אפשר לבחור מתוך רשימת ה-builders של buildpacks ב-Google Cloud.

מבוסס על pack

‫Pack הוא כלי CLI שמתוחזק על ידי פרויקט CNB כדי לתמוך בשימוש ב-buildpacks. צריך להשתמש ב-‎CLI pack כדי לפתח גרסת build מקומית של הפונקציה בתוך קובץ אימג' של קונטיינר.

לפני שמתחילים

1. מתקינים את Docker Community Edition (CE)‎ בתחנת העבודה. ‏Docker משמש את pack ליצירת קובצי אימג' של OCI.
2. מתקינים את Pack CLI.
3. מתקינים את הכלי Git source control כדי שתהיה אפשרות לטעון אפליקציות לדוגמה מ-GitHub.

פיתוח פונקציה באופן מקומי

משתמשים בפקודה pack build ומציינים את ה-builder שמוגדר כברירת המחדל --builder=gcr.io/buildpacks/builder, כדי לפתח גרסת build מקומית של קובצי אימג' של קונטיינר.

pack build --builder=gcr.io/buildpacks/builder IMAGE_NAME

מחליפים את IMAGE_NAME בשם של קובץ אימג' של קונטיינר.

אתם גם יכולים להתאים אישית את קובץ אימג' של קונטיינר באמצעות הרחבה של פיתוח גרסת ה-build והרצה של קובצי אימג'.

פיתוח פונקציה לדוגמה באופן מקומי

בדוגמאות הבאות מוסבר איך לפתח גרסת build מקומית לדוגמה.

1. משכפלים את המאגר לדוגמה ומעבירים אותו למכונה המקומית:

   git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git

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

   Go

   cd buildpack-samples/sample-functions-framework-go

   Java

   cd buildpack-samples/sample-functions-framework-java-mvn

   Node.js

   cd buildpack-samples/sample-functions-framework-node

   Python

   cd buildpack-samples/sample-functions-framework-python

   Ruby

   cd buildpack-samples/sample-functions-framework-ruby

3. כדי ליצור את הפונקציה לדוגמה משתמשים ב-pack:

   Go

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-go

   Java

   pack build --builder gcr.io/buildpacks/builder:v1 sample-functions-java-mvn

   Node.js

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-node

   Python

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-python

   Ruby

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-ruby

4. מריצים את קובץ האימג' באמצעות docker‏:

   Go

   docker run -p8080:8080 sample-functions-framework-go

   Java

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-java-mvn

   Node.js

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-node

   Python

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-python

   Ruby

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-ruby

5. עוברים אל localhost:8080 כדי להיכנס לפונקציה שפועלת.

פיתוח גרסאות build באמצעות מערכת פיתוח מרחוק

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

לפני שמתחילים

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

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build and Artifact Registry APIs, if any are not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the APIs

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build and Artifact Registry APIs, if any are not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the APIs

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

אם כבר התקנתם את Google Cloud CLI בעבר, צריך לוודא שפועלת אצלכם הגרסה העדכנית ביותר של gcloud components update.

1. מוודאים שלפרויקט Google Cloud יש גישה למאגר קובצי אימג' של קונטיינר.

   כדי להגדיר גישה למאגר Docker ב-Artifact Registry:

   1. יוצרים מאגר Docker חדש באותו מיקום של הפרויקט שלכם ב- Google Cloud .

      gcloud artifacts repositories create REPO_NAME \
      --repository-format=docker \
      --location=REGION --description="DESCRIPTION"

      מחליפים את:
      • REPO_NAME בשם שבחרתם למאגר ב-Docker.
      • ‫REGION במיקום של הפרויקט ב- Google Cloud או במיקום שהכי קרוב אליו.
      • DESCRIPTION בתיאור כלשהו.

      לדוגמה, כדי ליצור מאגר docker ב-us-west2 שהתיאור שלו הוא 'Docker repository', מריצים את הפקודה:

      gcloud artifacts repositories create buildpacks-docker-repo --repository-format=docker \
      --location=us-west2 --description="Docker repository"

   2. מוודאים שהמאגר נוצר:

      gcloud artifacts repositories list

      השם שבחרתם למאגר ב-Docker אמור להופיע ברשימה.

פיתוח פונקציה מרחוק

משתמשים בפקודה gcloud builds submit כדי ליצור את קובץ האימג' של קונטיינר ולהעלות אותו למאגר.

אפשר לציין את קובץ האימג' של הקונטיינר בפקודה עצמה או להשתמש בקובץ הגדרה.

איך בונים באמצעות פקודה

כדי ליצור build בלי קובץ תצורה, מציינים את הדגל image:

gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME

מחליפים את:

• ‫LOCATION בשם האזור של מאגר הקונטיינרים, לדוגמה us-west2.
• ‫PROJECT_ID במזהה הפרויקט ב- Google Cloud .
• REPO_NAME בשם המאגר ב-Docker.
• IMAGE_NAME בשם של קובץ האימג' בקונטיינר.

דוגמה:

gcloud builds submit --pack image=us-west2-docker.pkg.dev/my-project-id/my-buildpacks-docker-repo

פיתוח באמצעות קובצי תצורה

אתם יכולים להשתמש בקובץ הגדרות כדי להגדיר את פרטי ההגדרות של מאגר האימג'ים. קובץ התצורה משתמש בפורמט של קובץ YAML, והוא חייב לכלול שלב build שמשתמש ב-CLI של pack.

1. יוצרים קובץ YAML בשם cloudbuild.yaml שכולל את ה-URI של מאגר קובצי האימג' של קונטיינר.

    options:
      logging: CLOUD_LOGGING_ONLY
      pool: {}
    projectId: PROJECT_ID
    steps:
    - name: gcr.io/k8s-skaffold/pack
      entrypoint: pack
      args:
      - build
      - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
      - --builder
      - gcr.io/buildpacks/builder:latest
      - --network
      - cloudbuild
      - --publish
    - name: gcr.io/cloud-builders/docker
      entrypoint: pack
      args:
      - pull
      - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
    images:
    - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
   

   מחליפים את:

   • LOCATION בשם האזור של מאגר הקונטיינרים, לדוגמה, us-west2.
   • PROJECT_ID במזהה הפרויקט. Google Cloud
   • REPO_NAME בשם המאגר ב-Docker.
   • ‫IMAGE_NAME בשם של קובץ האימג' בקונטיינר.

2. מפתחים את האפליקציה.

   אם קראתם לקובץ התצורה cloudbuild.yaml, הריצו את הפקודה הבאה:

   gcloud builds submit .
   

   טיפ: אם אתם משתמשים בשם ייחודי לקובץ התצורה, צריך להשתמש בדגל --config.

דוגמה: יצירת פונקציה לדוגמה מרחוק

בדוגמאות הבאות מוסבר איך לפתח מרחוק גרסת build לדוגמה ולאמת שקובץ אימג' של קונטיינר הועבר למאגר ב-Artifact Registry.

1. משכפלים את המאגר לדוגמה ומעבירים אותו למכונה המקומית:

   git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git

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

   Go

   cd buildpack-samples/sample-functions-framework-go

   Java

   cd buildpack-samples/sample-functions-framework-java-mvn

   Node.js

   cd buildpack-samples/sample-functions-framework-node

   Python

   cd buildpack-samples/sample-functions-framework-python

   Ruby

   cd buildpack-samples/sample-functions-framework-ruby

3. שולחים את קוד המקור של האפליקציה ל-Cloud Build באמצעות gcloud‏:

   Go

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-go

   Java

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-gradle

   Node.js

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-node

   Python

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-python

   Ruby

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-ruby

   מחליפים את:

   • LOCATION בשם האזור של מאגר הקונטיינרים. לדוגמה: us-west2-docker.pkg.dev
   • PROJECT_ID במזהה הפרויקט. Google Cloud
   • REPO_NAME בשם המאגר ב-Docker.

4. מוודאים שהפונקציה לדוגמה פורסמה בהצלחה ב-REPO_NAME:

   gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME

   מחליפים את:

   • LOCATION בשם האזור של מאגר הקונטיינרים, לדוגמה, us-west2.
   • PROJECT_ID במזהה הפרויקט. Google Cloud
   • REPO_NAME בשם המאגר ב-Docker.

יצירת פונקציה לעדכונים אוטומטיים של קובץ אימג' בסיסי

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

קובץ Docker

אתם יכולים להשתמש ב-toolchain הקיים שלכם כדי ליצור קובץ אימג' של קונטיינר פונקציה שתואם לעדכונים אוטומטיים של קובץ אימג' בסיסי. כאן מוסבר איך ליצור קונטיינר מאפס.

‫pack CLI

pack build IMAGE_NAME \
  --builder LOCATION-docker.pkg.dev/serverless-runtimes/google-24-full/builder/LANGUAGE:latest
  --run-image LOCATION-docker.pkg.dev/serverless-runtimes/google-24/scratch/RUNTIME_ID:latest

מחליפים את:

• LOCATION בשם האזור של מאגר הקונטיינרים, לדוגמה, us-west2.
• IMAGE_NAME בשם של קובץ האימג' בקונטיינר.
• ‫LANGUAGE עם השפה של הפונקציה, לדוגמה nodejs.
• ‫RUNTIME_ID במזהה סביבת זמן הריצה, לדוגמה nodejs24.

Cloud Build

options:
  logging: CLOUD_LOGGING_ONLY
  pool: {}
projectId: PROJECT_ID
steps:
- name: gcr.io/k8s-skaffold/pack
  entrypoint: pack
  args:
  - build
  - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
  - --builder
  - LOCATION-docker.pkg.dev/serverless-runtimes/google-24-full/builder/LANGUAGE:latest
  - --run-image
  - LOCATION-docker.pkg.dev/serverless-runtimes/google-24/scratch/RUNTIME_ID:latest
  - --network
  - cloudbuild
images:
- LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME

מחליפים את:

• LOCATION בשם האזור של מאגר הקונטיינרים, לדוגמה, us-west2.
• ‫PROJECT_ID במזהה הפרויקט ב- Google Cloud .
• REPO_NAME בשם המאגר ב-Docker.
• IMAGE_NAME בשם של קובץ האימג' בקונטיינר.
• ‫LANGUAGE עם השפה של הפונקציה, לדוגמה nodejs.
• ‫RUNTIME_ID במזהה זמן הריצה, לדוגמה nodejs24.

מה השלב הבא?

• אחרי שיוצרים גרסת build של הפונקציה בקונטיינר, כדאי לבדוק אותה באופן מקומי לפני הפריסה ב-Cloud Run. מידע נוסף זמין במאמר בנושא בדיקה מקומית של שירות Cloud Run.
• כדי לפרוס את הקונטיינרים שיצרתם ב-Cloud Run, פועלים לפי ההוראות במאמר פריסת שירותים.
• כדי להפוך את תהליכי ה-build והפריסה של שירותי Cloud Run לאוטומטיים באמצעות טריגרים לפיתוח גרסת Build של Cloud Build, אפשר לעיין במאמר בנושא הגדרת פריסה רציפה.