תהליכי עבודה משותפים לשימוש חוזר

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

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

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

הסרטון הבא מדגים איך ליצור תהליך משותף ולעקוב אחריו בממשק המשתמש של Edge.

הסרטון הבא, באורך 5 דקות, מדגים איך יוצרים תהליך משותף בגרסה הקלאסית ומעקב אחריו. ממשק משתמש של Edge (מתקדם לענן פרטי בלבד).

אפשר להפעיל תהליך משותף באמצעות המדיניות בנושא יתרונות מרכזיים של זרימה. כמו כן, על ידי צירוף תהליך משותף אל הוק (hook) זרימה, אפשר להגדיר את התהליך המשותף כך שתתבצע לפני בקשה לשרת proxy או יעד, או אחרי שרת proxy או תגובת יעד.

לעיון במדיניות בנושא יתרונות מרכזיים של זרימה, אפשר לעיין במדיניותFlowCallout. למידע נוסף על קטעי הוק (hooks) לזרימה, ראו צירוף תהליך משותף באמצעות קרס לזרימה.

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

  • אבטחה, עם קוד הרשאה שמשתמש באימות באמצעות OAuth ומפתח API, וכן קוד להגנה מפני איומים.
  • רישום ביומן, ליצירת הודעות שגיאה רגילות.
  • גישור, לטרנספורמציה בין פורמט הודעות XML ו-JSON.

באיור הבא, שני שרתי proxy ל-API קוראים (באמצעות מדיניות FlowCallout) תהליך משותף לאימות בקשות נכנסות של משתמשים. ה-AuthSharedFlow נפרס בנפרד לארגון לפני שרתי ה-proxy, כך שהוא יהיה זמין לתמוך בבקשות שרתי proxy. צוות שאחראי על החברה הרחבה יכול לפתח ולנהל תהליך משותף כללי מדיניות שונים, ולאחר מכן נעשה בהם שימוש בשרתי proxy על ידי צוותים של עסקים שמתמקדים בבניית אפליקציות ספציפיות יותר.

פיתוח תהליך משותף

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

אלו השלבים הכלליים לפיתוח תהליך משותף:

  1. עליך להבין מהי קבוצת התכונות המשותפת.

    לדוגמה, תוכלו לשלב תכונות לניהול תנועה, כולל ביטול עליות חדות בתנועת הגולשים. כך תוכלו לנהל את ההגדרות שלהם מחוץ למסגרת העבודה להטמיע לוגיקה של תחום עסקי.

  2. לפתח תהליך משותף על ידי הטמעת מדיניות ומקורות מידע תומכים, בדיוק כמו במהלך פיתוח של שרת proxy ל-API.

    תהליך משותף הוא רצף של שלבים מותנים. לכן פיתוח של אתר כזה הוא כמו לפתח שרת proxy ל-API. אפשר לכלול כללי מדיניות ומשאבים שאפשר לכלול בשרת proxy.

    לדוגמה, כחלק מהתמיכה שלך בניהול תעבורת נתונים, ייתכן שבכוונתך להטמיע באתר 'ספייק' מדיניות מעצרת מאפשרת רק 30 בקשות לשנייה, כמו בדוגמה הבאה:

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
    <DisplayName>Spike Arrest</DisplayName>
    <Properties/>
    <Identifier ref="request.header.some-header-name"/>
    <MessageWeight ref="request.header.weight"/>
    <Rate>30ps</Rate>
</SpikeArrest>

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

    <SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
</SharedFlow>

    במאמר הבא מוסבר איך מתחילים תהליך משותף במסוף הניהול: יצירת תהליך משותף בממשק המשתמש של Edge

    בדומה לשרתי proxy ל-API, ניתן לייבא קובץ ZIP שמכיל את מקור התהליך המשותף פריטי מידע שנוצרו בתהליך הפיתוח (Artifact) (מידע נוסף זמין במאמר ייבוא למידע נוסף על ייבוא שרתי proxy ל-API. בקטע הבא מוסבר איך לייבא משותף עם ממשק ה-API לניהול:

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. לפרוס את התהליך המשותף בסביבה לפני שפורסים שרתי proxy או תהליכים משותפים שייצרוך אותו. פריסת תהליך משותף מתבצעת באותו אופן שבו פורסים שרת proxy ל-API. (עבור למידע נוסף, ראו פריסה סקירה כללית.)

    תהליך משותף חייב להיות באותו ארגון ולפרוסה באותה סביבה כמו ה-API ותהליכים משותפים אחרים שצורכים אותה. פריסת התהליך המשותף לפני שרתי ה-proxy מאפשרת לפתור את התלות של שרת ה-proxy בתהליך המשותף בזמן הפריסה.

    תוכלו לפרוס תהליך משותף באמצעות קריאה ל-API לניהול, למשל:

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

    אתם יכולים גם להחליף תהליך משותף שכבר פרוס ללא זמן השבתה. (דומה מאוד ממשקי proxy ל-API. למידע נוסף, ראו פריסת שרתי proxy ל-API באמצעות ממשק ה-API לניהול לקבלת מידע נוסף). זהו טופס הבקשה באמצעות ה-Management API:

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  4. לפתח את שרת ה-proxy ל-API שצורך את שרת ה-proxy, כדי שהוא יוכל להפעיל את התהליך המשותף כחלק מעצמו .

    דרך שרת proxy ל-API, מפעילים תהליך משותף באמצעות מדיניות שלFlowCallout. (אפשר גם לחבר את התהליך המשותף לשרת ה-proxy באמצעות הוק (hook) זרימה, כפי שמתואר במאמר צירוף תהליך משותף באמצעות הוק (hook) זרימה). למדריך מבוא על יצירת שרת proxy ל-API, אפשר לעיין במאמר בניית שרת ה-proxy הראשון ל-API.

    כדי לצרוך תהליך משותף, מוסיפים מדיניות FlowCallout לשרת ה-Proxy או תהליך משותף. תצרוך אותו. בדומה למדיניות יתרונות מרכזיים של שירות, שבה אתם משתמשים בשירות אחר, ה-FflowCallout מפעיל את התהליך המשותף. יש לפרוס את שרת ה-proxy ל-API שצורך אותו אחרי התהליך המשותף ולאותה סביבה כמו התהליך המשותף. יש להגדיר את התהליך המשותף כשרוצים לבדוק שיחה אליו באמצעות המדיניות בנושא יתרונות מרכזיים של זרימה.

    בקוד הבא, מדיניות FlowCallout היא 'תהליך משותף' שנקרא traffic-management-shared

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
    <DisplayName>Traffic Management FlowCallout</DisplayName>
    <Properties/>
    <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
</FlowCallout>

    למידע נוסף, ראו התקשרות לתהליך משותף משרת proxy ל-API או תהליך משותף

  5. פורסים את שרת ה-proxy ל-API כדי להתחיל להשתמש בתהליך המשותף. (למידע נוסף על פריסה באופן כללי, פריסה).
  6. פיתוח איטרטיבי באמצעות מעקב, כמו שעושים עם שרת proxy ל-API.

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

    אלה השלבים:

    1. ודא שהתהליך המשותף ושרת ה-Proxy של ה-API קוראים לפעולה הזו באמצעות FlowCallout הם באותו ארגון ופרוסים באותה סביבה.
    2. בכרטיסייה Trace של שרת ה-proxy של ה-API, מתחילים לעקוב אחרי שרת ה-proxy של ה-API.
    3. שליחת בקשה לנקודת קצה של שרת proxy ב-proxy ל-API. התהליך מנקודת הקצה צריך להיות לכלול את המדיניות FlowCallout , שקוראת לתהליך המשותף.
    4. בכרטיסייה Trace, בודקים את הזרימה משרת ה-Proxy של ה-API לתהליך המשותף.

      שימו לב שבמעקב, התהליך המשותף מיוצג כקבוצה של שלבים או כמדיניות בתוך תיבה אפורה. סמלים שמייצגים את המדיניות בנושא יתרונות מרכזיים של זרימה לפני תהליכים משותפים. (למידע נוסף על מעקב, ראו שימוש כלי המעקב).

יצירת תהליך משותף בממשק המשתמש של Edge

כשמשתמשים בממשק המשתמש של Apigee Edge כדי ליצור תהליך משותף, אפשר ליצור תהליך משותף מאפס או על ידי ייבוא מקורות זרימה קיימים כקובץ ZIP של חבילת זרימה.

  1. נכנסים לדף 'תהליכים משותפים' כמו שמתואר בהמשך. בדף 'תהליכים משותפים' אפשר לראות רשימה של תהליכי העבודה המשותפים בארגון. לערוך או למחוק את התהליכים ברשימה.

    Edge

    כך נכנסים לדף 'תהליכים משותפים' דרך ממשק המשתמש של Edge:

    1. נכנסים לחשבון בכתובת apigee.com/edge.
    2. בוחרים את הארגון שמכיל את התהליך המשותף. למידע על מעבר בין הארגונים

      התהליך המשותף יהיה זמין לכל שרתי proxy ל-API ותהליכי עבודה משותפים שנפרסו מהארגון הזה. לא ניתן יהיה לגשת אליו מחוץ לארגון הזה.

    3. בוחרים באפשרות פיתוח > תהליכי עבודה משותפים בסרגל הניווט הימני.

    Classic Edge (ענן פרטי)

    כדי לגשת לדף 'תהליכים משותפים' באמצעות ממשק המשתמש הקלאסי של Edge:

    1. יש להיכנס אל http://ms-ip:9000, כאשר ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
    2. בוחרים את הארגון שמכיל את התהליך המשותף. למידע על מעבר בין הארגונים

      התהליך המשותף יהיה זמין לכל שרתי proxy ל-API ותהליכי עבודה משותפים שנפרסו מהארגון הזה. לא ניתן יהיה לגשת אליו מחוץ לארגון הזה.

    3. בוחרים באפשרות APIs > תהליכי עבודה משותפים בסרגל הניווט העליון.
  2. לוחצים על הלחצן + תהליך משותף כדי להתחיל להוסיף תהליך משותף חדש.
  3. בדף יצירת תהליך משותף, בוחרים את האופן שבו רוצים ליצור את התהליך החדש:
    • יצירת תהליך חדש מאפס. תוכלו להגדיר כללי מדיניות ומשאבים בתור בשלבים השונים של התהליך.
      1. בוחרים באפשרות ריקון תהליך משותף.
      2. צריך להזין ערך של שם. זה יהיה השם ששרתי proxy ל-API ותהליכים משותפים אחרים שישמשו להפניה לתהליך המשותף הזה. השם צריך להיות תיאורי למפתחים בולעים את הקצב.
      3. מזינים תיאור שיספק מידע נוסף על פעולת הזרימה.
      4. לוחצים על הבא.
      5. לחלופין, בוחרים את הסביבות שבהן רוצים לפרוס את התהליך החדש.

        לדוגמה, אם תבדקו את התהליך המשותף משרתי proxy ל-API שנפרסו את סביבת הבדיקה, ולאחר מכן פורסים את התהליך המשותף כדי לבדוק.

      6. לוחצים על Build and Deploy (יצירה ופריסה) כדי ליצור את התהליך המשותף החדש וליצור אותו. הסביבות שבחרתם. אם לא בחרתם סביבה, התהליך המשותף אבל לא לפרוס אותם.

    • כדי ליצור תהליך משותף ממקורות קיימים, צריך להעלות חבילת זרימה.
      1. בוחרים באפשרות חבילת תהליך משותף כדי לציין קובץ ZIP שמכיל את פריטי המידע שנוצרו בתהליך הפיתוח (Artifact) כמו שרציתם בתהליך החדש.

        חבילת תהליך משותפת מכילה את פריטי המקור של תהליך משותף. לדוגמה, אם מורידים תהליך משותף מממשק המשתמש של Edge, צריך להשתמש בקובץ ZIP. עם חבילת הזרימה.

      2. לוחצים על הבא.
      3. לוחצים על בחירת קובץ כדי לאתר את קובץ ה-ZIP שמכיל את התהליך המשותף. את המקורות שברצונך לייבא.
      4. בתיבה שם התהליך המשותף, מזינים שם לתהליך המיובא. הפעולה הזו תגרור יהיה השם ששרתי proxy ל-API ותהליכים משותפים אחרים משתמשים בו כדי להפנות לתהליך המשותף הזה. השם צריך להיות תיאורי למפתחים שצורכים את הזרימה.
      5. לוחצים על הבא.
      6. לוחצים על יצירה כדי ליצור את התהליך החדש מהמקורות שמייבאים.

קריאה לתהליך משותף דרך שרת proxy ל-API או תהליך משותף

אפשר להפעיל תהליך משותף משרת proxy או מתהליך משותף אחר באמצעות המדיניות שלFlowCallout.

  1. בממשק המשתמש של Edge, מאתרים את שרת ה-proxy או את התהליך המשותף שמהם רוצים כדי להפעיל תהליך משותף אחר.
  2. בקטע ניווט, לצד מדיניות, לוחצים על הלחצן +.
  3. ברשימת כללי המדיניות, בקטע תוסף לוחצים על FlowCallout.
  4. צריך להזין את השם המוצג ואת השם המוצג (מזהה ייחודי), ואז לבחור את התהליך המשותף קוראים למדיניות שלנו.
  5. לוחצים על הוספה.
  6. צריך להוסיף את המדיניות החדשה של תוספי יתרונות מרכזיים מהאתר לשרת ה-proxy שאליו רוצים לבצע את השיחה.

ראה גם

שרשור בין שרתי proxy ל-API