הרצת hooks לפני ואחרי פריסה

הרצת hooks לפני ואחרי פריסה

במדריך למתחילים הזה נסביר איך מריצים deploy hook – תוכנית שרירותית שמופעלת לפני או אחרי הפריסה באמצעות Cloud Deploy.

במדריך למתחילים הזה תבצעו את הפעולות הבאות:

1. יצירת אשכול GKE אחד או שירות Cloud Run אחד.

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

2. מגדירים את צינור עיבוד הנתונים לפריסה ואת יעד הפריסה ב-Cloud Deploy.

   ההגדרה של צינור עיבוד הנתונים לפריסה כוללת את ההגדרות של ה-deploy hook, כמו ב-tasks.

   הצינור הזה כולל רק שלב אחד ומשתמש רק ביעד אחד.

3. יוצרים הגדרת Skaffold ומניפסט של Kubernetes או הגדרת שירות של Cloud Run.

   בקובץ ההגדרות של Skaffold מציינים את המניפסטים שרוצים לפרוס באמצעות Cloud Deploy.

4. יוצרים גרסת הפצה, שנפרסת באופן אוטומטי ביעד.

   אחת מהפעולות מתבצעת לפני פריסת האפליקציה, והשנייה מתבצעת אחרי הפריסה.

5. אפשר לראות את התוצאות של ה-hooks לפני ואחרי הפריסה ביומנים של Cloud Build, באמצעות הדף Rollout details של Cloud Deploy במסוףGoogle Cloud .

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

1. 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

2. Verify that billing is enabled for your Google Cloud project.

3. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage 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

4. Install the Google Cloud CLI.

5. Configure the gcloud CLI to use your federated identity.

   For more information, see Sign in to the gcloud CLI with your federated identity.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   אם כבר התקנתם את ה-CLI, צריך לוודא שאתם מריצים את הגרסה העדכנית ביותר:

   gcloud components update
   

7. מוודאים שלחשבון השירות שמשמש כברירת מחדל ב-Compute Engine יש הרשאות מספיקות.

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

1. קודם מוסיפים את התפקיד clouddeploy.jobRunner:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")-compute@ \
       --role="roles/clouddeploy.jobRunner"
   

2. מוסיפים את תפקיד המפתח לזמן הריצה הספציפי.
• ב-GKE:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
      --format="value(projectNumber)")-compute@ \
      --role="roles/container.developer"
  

• ל-Cloud Run:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
      --format="value(projectNumber)")-compute@ \
      --role="roles/run.developer"
  

3. מוסיפים את התפקיד iam.serviceAccountUser, שכולל את ההרשאה actAs לפריסה בסביבת זמן הריצה:

   gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")-compute@ \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")-compute@ \
       --role="roles/iam.serviceAccountUser" \
       --project=PROJECT_ID
   

יצירת סביבת זמן ריצה

אם אתם פורסים ל-Cloud Run, אתם יכולים לדלג על הפקודה הזו.

ב-GKE, יוצרים אשכול אחד: deploy-hooks-cluster, עם הגדרות ברירת המחדל. נקודת קצה ל-API של Kubernetes באשכול צריכה להיות נגישה מהאינטרנט הציבורי. אשכולות GKE נגישים חיצונית כברירת מחדל.

gcloud container clusters create-auto deploy-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

יצירה של צינור העברת נתונים ויעד

אפשר להגדיר את הצינור ואת היעד בקובץ אחד או בקבצים נפרדים. במדריך למתחילים הזה, יוצרים קובץ יחיד.

1. פותחים חלון טרמינל.

2. יוצרים ספרייה חדשה ועוברים אליה.

   GKE

   mkdir deploy-hooks-gke-quickstart
   cd deploy-hooks-gke-quickstart
   

   Cloud Run

   mkdir deploy-hooks-run-quickstart
   cd deploy-hooks-run-quickstart
   

3. יוצרים את צינור ההפצה ואת הגדרת היעד:

   GKE

   בספרייה deploy-hooks-gke-quickstart, יוצרים קובץ חדש: clouddeploy.yaml, עם התוכן הבא:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a postdeploy action"' ]
   ---
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: hooks staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster
   

   Cloud Run

   בספרייה deploy-hooks-run-quickstart, יוצרים קובץ חדש: clouddeploy.yaml, עם התוכן הבא:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a postdeploy action"' ]
   ---
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: staging Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   הערה: בקובץ הזה, היעד נכלל בצינור ההפצה, אבל אפשר להגדיר יעדים בקובץ נפרד או בכמה קבצים נפרדים.

4. רושמים את צינור עיבוד הנתונים ואת היעדים בשירות Cloud Deploy:

   gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
   

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

5. מאשרים את הצנרת ואת היעדים:

   במסוף Google Cloud , נכנסים לדף Delivery pipelines של Cloud Deploy כדי לראות רשימה של צינורות העברת הנתונים שזמינים לכם.

   פתיחת הדף Delivery pipelines

   צינור העברת הנתונים שיצרתם מוצג, עם יעד אחד שמופיע בעמודה יעדים.

   

יצירת קובץ ההגדרות של Skaffold ומניפסט האפליקציה

‫Cloud Deploy משתמש ב-Skaffold כדי לזהות את המניפסטים שמשמשים לפריסת האפליקציה לדוגמה ביעד.

1. יוצרים קובץ בשם skaffold.yaml עם התוכן הבא:

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   

   מידע נוסף על קובץ ההגדרה הזה מופיע בskaffold.yamlמאמר בנושא הפניה.

2. יוצרים את ההגדרה של האפליקציה – הגדרת שירות ל-Cloud Run או מניפסט של Kubernetes ל-GKE.

   GKE

   יוצרים קובץ בשם k8s-pod.yaml עם התוכן הבא:

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-hooks-pod
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   הקובץ הזה הוא מניפסט בסיסי של Kubernetes, שמוחל על האשכול כדי לפרוס את האפליקציה. קובץ האימג' של הקונטיינר שרוצים לפרוס מוגדר כאן כ-placeholder, ‏ my-app-image, שמוחלף באימג' הספציפי כשיוצרים את הגרסה.

   Cloud Run

   יוצרים קובץ בשם service.yaml עם התוכן הבא:

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-hooks-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

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

הערה: אם אתם רוצים להשתמש במניפסטים שונים לכל יעד, כדאי לקרוא את המאמר הזה בנושא ניהול מניפסטים כדי לקבל מידע נוסף על שימוש בפרופילים של Skaffold.

יצירת גרסה

הפצה היא המשאב המרכזי ב-Cloud Deploy שמייצג את השינויים שנפרסים. צינור העברת התוכן מגדיר את מחזור החיים של הגרסה הזו. פרטים על מחזור החיים הזה מופיעים במאמר ארכיטקטורת שירות Cloud Deploy.

GKE

מריצים את הפקודה הבאה מהספרייה deploy-hooks-gke-quickstart כדי ליצור משאב release שמייצג את קובץ האימג' של הקונטיינר לפריסה:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-hooks-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

שימו לב לדגל --images=, שמשמש להחלפת ה-placeholder ‏ (my-app-image) במניפסט בתמונה ספציפית עם חתימת SHA. ‫Google ממליצה ליצור תבניות למניפסטים בדרך הזו, ולהשתמש בשמות תמונות שעומדים בדרישות של SHA כשיוצרים גרסת הפצה.

Cloud Run

מריצים את הפקודה הבאה מהספרייה deploy-hooks-run-quickstart כדי ליצור משאב release שמייצג את קובץ האימג' של הקונטיינר לפריסה:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-hooks-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

שימו לב לדגל --images=, שמשמש להחלפת ה-placeholder ‏ (my-app-image) בהגדרת השירות בתמונה הספציפית שמוגדרת באמצעות SHA. ‫Google ממליצה ליצור תבניות להגדרות של השירותים והמשימות בדרך הזו, ולהשתמש בשמות תמונות שעומדים בדרישות של SHA כשיוצרים מהדורה.

בדומה לכל פריטי התוכן (אלא אם הם כוללים --disable-initial-rollout), גם Cloud Deploy יוצר באופן אוטומטי משאב פריסת גרסה. האפליקציה נפרסת באופן אוטומטי ליעד אחד שהוגדר לצורך צינור אספקה (pipeline) זה.

בנוסף, משימת ההכנה לפריסה מופעלת לפני פריסת האפליקציה, ומשימת הפוסט-פריסה מופעלת אחרי הפריסה.

הצגת התוצאות במסוף Google Cloud

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

ה-hooks שלפני ואחרי הפריסה שהגדרנו (לדוגמה) מדפיסים מחרוזות ביומני Cloud Build. אנחנו יכולים לעיין ביומנים האלה כדי לוודא שה-hooks פעלו כמצופה.

1. במסוף Google Cloud , עוברים לדף Delivery pipelines (צינורות העברה) של Cloud Deploy כדי לראות את צינור ההעברה ("deploy-hooks-demo-app-gke-1" או "deploy-hooks-demo-app-run-1").

   פתיחת הדף Delivery pipelines

2. לוחצים על השם של צינור עיבוד הנתונים לפריסה (deploy-hooks-demo-app-gke-1 או deploy-hooks-demo-app-run-1).

   בתרשים של צינור הנתונים מוצג סטטוס הפריסה של האפליקציה. מכיוון שיש רק שלב אחד בצינור, ההדמיה מציגה רק צומת אחד.

   

   פריט התוכן יופיע בכרטיסייה פריטי תוכן בקטע פרטים על צינור ההפצה.

3. בכרטיסייה Rollouts (השקות), בקטע Delivery pipeline details (פרטים על צינור ההפצה).

4. לוחצים על שם ההשקה כדי לראות את פרטי ההשקה.

   

   ‫Predeploy ו-Postdeploy מופיעים כעבודות.

5. לוחצים על Predeploy.

   יוצג יומן הפעלת העבודה.

6. גוללים למטה ברשימת רשומות היומן כדי למצוא את predeploy-echo ולוחצים עליה.

   

   שימו לב לtextPayload. זו המחרוזת שהוגדרה ב-predeploy-action בצינור ההפצה.

7. לוחצים על המשימה Postdeploy (אחרי הפריסה) ומחפשים את רשומת היומן postdeploy-echo.

   

הסרת המשאבים

כדי לא לצבור חיובים לחשבון Google Cloud על המשאבים שבהם השתמשתם בדף הזה:

1. מוחקים את אשכול GKE או את שירות Cloud Run:

   GKE

   gcloud container clusters delete deploy-hooks-cluster --region=us-central1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-hooks-run-service --region=us-central1 --project=PROJECT_ID
   

2. מחיקת צינור העברת התוכן, היעד, הגרסה וההשקה:

   gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
   

3. מוחקים את הקטגוריות של Cloud Storage שנוצרו על ידי Cloud Deploy.

   אחד מסתיים ב-_clouddeploy, והשני הוא [region].deploy-artifacts.[project].appspot.com.

   פתיחת הדף Cloud Storage browser

סיימתם את המדריך למתחילים.

המאמרים הבאים

• מידע נוסף על Cloud Deploy

• מידע בסיסי על פריסת אפליקציות

• כאן מוסבר איך משלבים Google Cloud כלי CI/CD כדי לפתח תוכנה ולספק אותה ביעילות ל-GKE.