שילוב עם Deployment Manager

באמצעות Deployment Manager אפשר לרשום API של צד שלישי בשירות Deployment Manager. אחרי שרושמים API כספק סוגים ב-Deployment Manager, אפשר להשתמש ב-Deployment Manager כדי לפרוס משאבים מ-API כסוגים בהגדרה.

במסמך הזה מוסבר תהליך השילוב של API של צד שלישי עם Deployment Manager. בדף הזה לא מופיעות הוראות מפורטות לכל שלב בתהליך, אבל הוא כולל סקירה כללית וקישורים נוספים למידע נוסף. בדף הזה מוסבר בקצרה איך מוסיפים API, אבל כדי לקבל הוראות מפורטות צריך לעיין במסמכים המפורטים.

קביעה אם API עומד בדרישות לשילוב עם Deployment Manager

ל-Deployment Manager יש ציפיות מסוימות מכל API שמנסה להשתלב איתו. פרטים נוספים:

  • ‫Deployment Manager מצפה ל-API מסוג RESTful. כלומר, ה-API חושף ממשק דמוי REST עם שיטות ליצירה, קריאה, עדכון ומחיקה (CRUD).
  • כל הפרמטרים של הנתיב והשאילתה נפתרים בהצלחה. כל הפרמטרים של הנתיב והשאילתה של ה-API צריכים להיות חלק מגוף המשאב או להיות קיימים בכל השיטות של ה-API, כדי ש-Deployment Manager יוכל להתאים את הפרמטר כשמשתמש מספק אותו.
  • חייבת להיות גישה לנקודת הקצה של מסמך התיאור של ה-API. ‫Deployment Manager שולח בקשת HTTP כדי לקבל את מסמך התיאור של ה-API, ולכן המסמך צריך להיות מאוחסן במקום שאפשר לגשת אליו באמצעות Deployment Manager. המסמך צריך להיות גלוי לכולם או מוגן באמצעות אימות בסיסי.
  • בנוסף לנקודה הקודמת, ל-API יש אימות בסיסי, או שאם ה-API פועל ב-Google Kubernetes Engine או ב-Google Cloud Endpoints, ה-API תומך באימות OAuth 2.0 באמצעות אסימון גישה מחשבון השירות של הפרויקט. מידע נוסף על אימות
  • אם ה-API שלכם מורכב, יכול להיות שתצטרכו להגדיר אפשרויות נוספות כדי להסביר ל-Deployment Manager איך לטפל בהתנהגות פחות ברורה של ה-API.

מידע נוסף זמין במאמר דרישות ה-API.

הוספת ה-API ל-Deployment Manager

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

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

ביצוע קריאה לספק סוגים בקובצי הגדרה

אחרי שרושמים API ב-Deployment Manager, אפשר ליצור משאבי API על ידי הפעלת משאב ה-API הזה כסוג בהגדרה.

לדוגמה, אם קראתם לספק הסוגים example-directory-api ואתם רוצים ליצור משאב API שנקרא person, אתם יכולים לציין את הסוג בהגדרות שלכם כך:

resources:
- name: Jane
  type: my-project/example-directory-api:person
  properties:
  - name: Jane
    website: www.example.com
    ...

לשם השוואה, זהו אותו תהליך כמו קריאה ל-Google API ויצירה של משאב API:

resource:
- name: example-instance
  type: compute.v1.instance
  properties:
  - machineType: n1-standard-1
    ...

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