הגדרת מחבר Apigee API Hub לענן פרטי

בקטע הזה מפורטים שלבי ההגדרה של המחבר Apigee API Hub for Private Cloud, כולל הגדרות רשת, אימות והגדרות ספציפיות לארגון.

הגדרת רשת ואימות

1. הוספת יציאות לרשימת ההיתרים: מחבר Apigee API Hub for Private Cloud צריך להתחבר לשרת הניהול כדי לקבל את מטא הנתונים הנדרשים של ה-API, ולכן המחבר צריך להיות מסוגל להגיע ליציאות 8080 ו-443 של שרת הניהול.
2. אימות מבוסס-מפתח לשירותי Google Cloud Platform: המחבר של Apigee API Hub for Private Cloud מתקשר עם שירותי Google Cloud ודורש אסימונים לאימות. התהליך הזה מתבצע באמצעות מפתח של חשבון שירות כדי ליצור אסימונים של התחזות.
   • חשבון שירות ליצירת אסימונים: יוצרים חשבון שירות חדש שמוקדש ליצירת אסימונים. לחשבון השירות הזה צריך להיות מוקצה התפקיד Token Creator.
   • יצירה והורדה של מפתח לחשבון שירות:
     • פועלים לפי השלבים שבקטע יצירת מפתח לחשבון שירות כדי ליצור מפתח JSON לחשבון השירות שיוצר את האסימון.
     • מורידים את קובץ המפתח הזה (לדוגמה, אל /opt/apigee/keys/uapim.key במכונה הווירטואלית של מחבר Apigee API Hub לענן פרטי).
   • הגדרת GOOGLE_APPLICATION_CREDENTIALS: כשמפעילים את המחבר Apigee API Hub for Private Cloud, צריך לספק את הנתיב לקובץ הזה באמצעות משתנה הסביבה:

     export $GOOGLE_APPLICATION_CREDENTIALS=/opt/apigee/keys/uapim.key

3. אימות של Management API‏ (UAPIM_MGMT_AUTH): כדי להשתמש במחבר Apigee API Hub for Private Cloud, צריך פרטי כניסה לשליחת קריאה ל-Apigee Management API. לצורך אבטחה ואוטומציה, מומלץ להשתמש במשתמש מכונה ב-Apigee ולא במשתמש אנושי.

   כדי ליצור משתמש מכונה ב-Apigee:

   1. יצירת משתמש:
      • במסוף Apigee, יוצרים משתמש מכונה (או משתמש מערכת). מידע נוסף על משתמשים ותפקידים
      • מקצים כתובת אימייל (לזיהוי) ושם תיאורי (למשל, uapim-connector-user).
   2. הקצאת תפקידים: מקצים למשתמש המכונה את התפקיד הבא:
      • אדמין של Apigee API: התפקיד הזה מספק גישה ל-Management API, ומאפשר למחבר של Apigee API Hub for Private Cloud ליצור אינטראקציה עם מערכת הניהול של Apigee (לדוגמה, כדי לאחזר מטא-נתונים או לנהל הגדרות של API).

יצירת פרטי כניסה בקידוד Base64:

1. יוצרים את זוג שם המשתמש והסיסמה עבור המשתמש של המכונה.
2. מקודדים את פרטי הכניסה ב-Base64: echo -n 'username:password' | base64
3. מגדירים את משתנה הסביבה ‎ $UAPIM_MGMT_AUTH עם הערך המקודד ב-Base64:

   export UAPIM_MGMT_AUTH=USERNAME_PASSWORD

   כאשר USERNAME_PASSWORD הוא הערך בקידוד Base64 של צמד שם המשתמש והסיסמה.

   לפני שמפעילים את מחבר Apigee API Hub for Private Cloud, צריך לוודא שמשתנה הסביבה הזה מוגדר.

הגדרת המחבר של Apigee API Hub לענן פרטי

פותחים את קובץ ההגדרות /opt/apigee/customer/application/uapim-connector.properties כדי לציין את הארגונים ב-Apigee שעבורם צריך להעלות נתונים ל-API Hub. יכול להיות שיש לכם כמה מופעים של פלאגין או כמה מופעים של API Hub.

  conf_uapim.settings.json={\
    "connectorConfig" : { \
      "org1" : { \
        "runtimeDataPubsub" : "", \
        "metadataPubsub":"", \
        "serviceAccount": "mysa1@in.myfirstProject",\
        "pluginInstanceId":"aaaa" \
      },\
      "org2" : { \
        "runtimeDataPubsub" : "", \
        "metadataPubsub":"",\
        "serviceAccount": "mysa2@in.mySecondProject",\
        "pluginInstanceId":"bbbbb", \
      } 
    },
    "runtimeDataPath":"/the/nfs/mounted/path", \    
    "managementServer": "hostname"
  } 

הסבר על הגדרות JSON

• connectorConfig Section:
  • זוהי מפה שבה כל מפתח הוא שם של ארגון Apigee (לדוגמה, org1, ‏ org2).
  • כל רשומה של ארגון מכילה את השדות הבאים, שקיבלתם במהלך שלב יצירת התוסף:
    • ‫runtimeDataPubsub: נושא ה-Pub/Sub לנתוני זמן ריצה (ניתוח) של הארגון הזה.
    • ‫metadataPubsub: נושא Pub/Sub למטא-נתונים של API בארגון הזה.
    • ‫serviceAccount: חשבון השירות (למשל, mysa1@in.myfirstProject.iam.gserviceaccount.com) שמשמש לאימות לצורך כתיבת נתונים ל-Pub/Sub בארגון הזה.
    • ‫pluginInstanceId: המזהה הייחודי של המופע של הפלאגין שמשויך לארגון הזה.
• הקטע runtimeDataPath: מציינים את הנתיב לנקודת הטעינה של NFS שבה מעבדי ההודעות יכתבו את נתוני Analytics ‏ (AX). הנתיב הזה צריך להיות זהה לנתיב שהוגדר במעבדי ההודעות.
• הקטע managementServer: שם המארח או כתובת ה-IP של כתובת ה-URL של שרת הניהול של Apigee.
• משתנה הסביבה UAPIM_MGMT_AUTH: משתנה הסביבה הזה, שמוגדר באופן חיצוני, מכיל את username:password בקידוד base64 כדי לגשת לשרת הניהול.

הוספת ההגדרות של שרת ה-proxy הקדמי

הוספת הגדרות של שרת proxy קדימה באותו קובץ /opt/apigee/customer/application/uapim-connector.properties

1. conf_http_client_service_jetty.proxy.enabled=true

2. conf_http_client_service_jetty.proxy.host=
3. conf_http_client_service_jetty.proxy.port=
4. conf_http_client_service_jetty.proxy.user=
5. conf_http_client_service_jetty.proxy.password=

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

• pubsub.googleapis.com:443
• oauth2.googleapis.com:443
• iamcredentials.googleapis.com:443

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

הפעלת Apigee API Hub for Private Cloud Connector

אחרי שמגדירים את כל ההגדרות, מפעילים את המחבר Apigee API Hub for Private Cloud באמצעות פקודת השירות Apigee:

apigee-service edge-uapim-connector start