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

אחרי שמגדירים את קובץ .proto ואת קובץ ההגדרות של gRPC API, פורסים אותם כדי שמערכת Cloud Endpoints תקבל את המידע שהיא צריכה כדי לנהל את ה-API. כדי לפרוס את הגדרת Endpoints, משתמשים בפקודה gcloud endpoints services deploy. הפקודה הזו משתמשת ב-Service Infrastructure, פלטפורמת השירותים הבסיסית של Google, שמשמשת את Endpoints ושירותים אחרים ליצירה ולניהול של ממשקי API ושירותים. בדף הזה מוסבר איך לפרוס את קובצי ההגדרות ב-Endpoints.

דרישות מוקדמות

כנקודת התחלה, בדף הזה מניחים שיש לכם:

הכנה של Google Cloud CLI לפריסה

משתמשים בכלי gcloud של שורת הפקודה כדי לפרוס את ההגדרה. מידע נוסף על הפקודות מופיע ב מדריך העזר ל-gcloud.

כדי להתכונן לפריסה:

  1. מתקינים ומפעילים את ה-CLI של gcloud.
  2. מעדכנים את ה-CLI של gcloud: 
    gcloud components update
  3. מוודאים של-CLI של gcloud יש הרשאה לגשת לנתונים ולשירותים שלכם: 
    gcloud auth login

    תיפתח כרטיסייה חדשה בדפדפן ותתבקשו לבחור חשבון.

  4. מגדירים את פרויקט ברירת המחדל. מחליפים את [YOUR-PROJECT-ID] במזהה הפרויקט ב-GCP. 
    gcloud config set project [YOUR-PROJECT-ID]
  5. אם אתם מתכוונים לפרוס את ה-backend של ה-API ב-Kubernetes או ב-Kubernetes Engine, מריצים את הפקודה הבאה כדי לקבל פרטי כניסה חדשים של משתמש שאפשר להשתמש בהם בפרטי כניסה שמוגדרים כברירת מחדל לאפליקציה. צריך את פרטי הכניסה של המשתמש כדי לתת הרשאה ל-kubectl. 
    gcloud auth application-default login
     נפתחת כרטיסייה חדשה בדפדפן ומוצגת בקשה לבחור חשבון.

פריסת קובצי התצורה

  1. 确保您位于 api_descriptor.pb 和 api_config.yaml 文件所在的目录中。
  2. 确认 gcloud 命令行工具当前使用的默认项目是您要向其部署 Endpoints 配置的 Google Cloud 项目。验证从以下命令返回的项目 ID，以确保不会在错误的项目中创建服务。 
    gcloud config list project

    如果您需要更改默认项目，请运行以下命令：

    gcloud config set project YOUR_PROJECT_ID
  3. 使用 Google Cloud CLI 部署 proto descriptor 文件和配置文件：
    gcloud endpoints services deploy api_descriptor.pb api_config.yaml

    在创建和配置服务时，Service Management 会向终端输出信息。部署完成后，系统将显示如下所示的消息：

    Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

    CONFIG_ID 是部署创建的唯一 Endpoints 服务配置 ID。例如：

    Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

    在前面的示例中，2017-02-13r0 是服务配置 ID，bookstore.endpoints.example-project.cloud.goog 是服务名称。服务配置 ID 由日期戳后跟一个修订版本号组成。如果您在同一天再次部署 Endpoints 配置，服务配置 ID 中的修订版本号将递增。

אם ההגדרות של השירות נמצאות בכמה קובצי YAML, אפשר להעביר את כולם לפקודה deploy. לדוגמה, ההגדרה הבסיסית של חנות הספרים נמצאת ב-api_config.yaml, אבל אפשר להפעיל קידוד מחדש של HTTP בשירות על ידי פריסה גם של api_config_http.yaml, שכולל הגדרה נוספת לתכונה הזו:

‫
gcloud endpoints services deploy api_descriptor.pb api_config.yaml api_config_http.yaml

שימו לב: אם יש ערכים סותרים בקובצי ה-YAML, הערכים בקובץ האחרון שצוין מבטלים את הערכים בקבצים האחרים. מידע נוסף על האופן שבו Endpoints מטפל במיזוג של כמה קובצי YAML זמין במאמר הגדרת שירות gRPC.

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

פריסה מחדש

בכל פעם שמשנים משהו בקובץ .proto או בקובץ ה-YAML של הגדרת השירות, צריך לפרוס את הקבצים מחדש כדי ש-Extensible Service Proxy ‏ (ESP) יקבל את הגרסה העדכנית ביותר של הגדרת השירות של ה-API. אם פרסתם בעבר את ESP עם האפשרות rollout שהוגדרה לערך managed, לא צריך להפעיל מחדש את ESP או לפרוס אותו מחדש. האפשרות rollout=managed מגדירה את ESP כך שישתמש בהגדרת השירות העדכנית ביותר שפריסתה הושלמה. אם תבחרו באפשרות הזו, עד 5 דקות אחרי שתפרסו הגדרת שירות חדשה, ESP יזהה את השינוי ויתחיל להשתמש בה באופן אוטומטי. אנחנו ממליצים לציין את האפשרות הזו במקום מזהה תצורה ספציפי לשימוש ב-ESP.

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

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