התאמה אישית של הדומיין

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

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

https://orgname-portalname.apigee.io

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

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

https://developers.example.com

במאמר שימוש בדומיין מותאם אישית עם ספק ה-SAML מוסבר איך משתמשים בדומיין מותאם אישית עם ספק זהויות ב-SAML.

בקטעים הבאים מוסבר איך להתאים אישית את הדומיין.

התאמה אישית של שם הדומיין (Apigee Edge)

באמצעות פורטלים משולבים של Apigee Edge, תוכלו לבצע את השלבים הבאים כדי להתאים אישית את שם הדומיין שלכם:

  1. רושמים את שם הדומיין.
  2. הגדרת TLS.
  3. הוספת שם דומיין מותאם אישית לפורטל.
  4. מגדירים את ה-DNS.

אחרי שמוסיפים דומיין מותאם אישית, אפשר לערוך או להשבית אותו. לעזרה בפתרון בעיות, אפשר לעיין בפתרון בעיות עם דומיין מותאם אישית.

שלב 1: רישום שם הדומיין

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

כשאתם מחליטים על שם הדומיין, חשוב להביא בחשבון שכתובות URL ידידותיות למשתמשים וניתנות לקריאה הן רכיב מרכזי בשיפור האופטימיזציה למנועי חיפוש, כפי שמתואר במאמר הטמעה של אופטימיזציה למנועי חיפוש (SEO).

שלב 2: הגדרת TLS (אבטחת שכבת התעבורה)

כדי לתמוך ב-HTTPS, צריך להגדיר TLS (אבטחת שכבת התעבורה) על ידי יצירת מאגרי מפתחות וכינויים שמכילים את האישורים הדיגיטליים הנחוצים בסביבת הפורטל, כמתואר בתהליך הבא.

כדי להגדיר TLS:

  1. רוכשים אישור TLS מרשות אישורים מוכרת, כמו Google Trust Services. אתם קובעים איזו רשות אישורים תבחרו.
  2. נכנסים לחשבון בכתובת https://apigee.com/edge.
  3. בוחרים את הארגון שלכם מהתפריט של פרופיל המשתמש.
  4. בוחרים באפשרות ניהול > סביבה > TLS Keystores כדי להציג את הדף של מאגרי המפתחות של TLS.
  5. בתפריט הנפתח של הסביבה, בוחרים באפשרות פורטל.

  6. יוצרים מאגר מפתחות וכינוי, כפי שמתואר במאמר יצירת מאגרי מפתחות ו-Truststore באמצעות ממשק המשתמש של Edge.

שלב 3: הוספת שם דומיין מותאם אישית לפורטל

כשמוסיפים שם דומיין מותאם אישית לפורטל, המערכת יוצרת עבורך את המשאבים הבאים (תוך שימוש באותה פונקציונליות שמשמשת להחלת שם דומיין מותאם אישית על נקודת קצה, כמו api.example.com):

  • מארח וירטואלי, מאזין ביציאה 443, באמצעות שם הדומיין המותאם אישית שציינת.

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

כדי להוסיף לפורטל שלכם שם דומיין מותאם אישית:

  1. בוחרים פרסום > פורטלים ובוחרים את הפורטל שלכם.
  2. בוחרים באפשרות הגדרות בתפריט הנפתח בסרגל הניווט העליון או בדף הנחיתה.
  3. לוחצים על הכרטיסייה דומיינים.
  4. בקטע דומיין מותאם אישית, ממלאים את השדות הבאים.
    שדה תיאור
    מאגר מפתחות בוחרים מאגר מפתחות מהרשימה הנפתחת.

    הערה: הרשימה מאוכלסת באמצעות מאגרי המפתחות שיצרתם בסביבת הפורטל בשלב 2.

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

    כינוי בוחרים כינוי חוקי מהרשימה הנפתחת.

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

    כדי לקבוע מתי יפוג תוקף אישור מהרשימה:

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

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

    דומיין בוחרים דומיין מהרשימה הנפתחת. אם בחרתם בכינוי תו כללי לחיפוש, יש להזין את תת-הדומיין.

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

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

שלב 4: מגדירים את ה-DNS

בשלב הבא צריך להוסיף רשומת שם קנוני (CNAME) ל-DNS של הדומיין כדי להצביע אל {org_name}-portal.apigee.net.

כדי לאשר את ערך ה-CNAME:

  1. בוחרים פרסום > פורטלים ובוחרים את הפורטל שלכם.
  2. בוחרים באפשרות הגדרות בתפריט הנפתח בסרגל הניווט העליון או בדף הנחיתה.
  3. לוחצים על הכרטיסייה דומיינים.
  4. בודקים את הערך של CNAME של הארגון בקטע הגדרת DNS, כפי שמוצג באיור הבא: הגדרת DNS

הדוגמה הבאה היא רשומת CNAME שהגדרת לדומיין המותאם אישית שמוצגת למעלה (כלומר, לדומיין המותאם אישית developers.example.com בארגון myorg):

developers.example.com. CNAME myorg-portal.apigee.net.

פתרון בעיות בדומיין מותאם אישית

הקטעים הבאים מספקים הצעות לפתרון בעיות בדומיין המותאם אישית.

פתרון בעיות: אימות ההגדרה של ה-DNS של הדומיין באמצעות תקציר

לאחר ש-DNS של הדומיין מתעדכן כך שיכלול את רשומת ה-CNAME, השינויים יופצו לשרתי DNS אחרים ברחבי העולם. באמצעות dig, אתם יכולים לשלוח שאילתה לשרת ה-DNS של הדומיין כדי לוודא שרשומת ה-CNAME הוגדרה בצורה תקינה, עוד לפני שהיא הופצה באופן מלא לשרתי DNS אחרים.

לדוגמה, הפקודה dig הבאה שולחת שאילתה לשרת ה-DNS של הדומיין. בפלט הפקודה, השדה ANSWER SECTION מכיל את רשומת ה-CNAME.

$ dig @your.domain.dns developer.mycompany.com
; <<>> DiG 9.8.3-P1 <<>> @your.domain.dns developer.mycompany.com
; (1 server found)
;; global options:  cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 41356
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 0
;; WARNING: recursion requested but not available

;; QUESTION SECTION:
;developer.mycompany.com.       IN  A

;; ANSWER SECTION:
developer.mycompany.com.    29  IN  CNAME   myorg-portal.apigee.net.

;; Query time: 141 msec
;; SERVER: 192.168.1.254#53(192.168.1.254)
;; WHEN: Mon Mar 20 16:41:59 2017
;; MSG SIZE  rcvd: 136

פתרון בעיות: לא ניתן לזהות שרת proxy למארח

כשמוסיפים לפורטל שם של דומיין מותאם אישית, נוצר כברירת מחדל שרת proxy של API שמשתמש בכתובת ה-URL של הדומיין המותאם אישית, כאשר נקודת הקצה (endpoint) של היעד מוגדרת לדומיין של הפורטל שמוגדר כברירת המחדל. אם משנים או מוחקים את שרת ה-API של ה-API שמשויך לדומיין מותאם אישית, ההגדרות האישיות של הדומיין המותאם אישית יבוטלו, והודעת השגיאה Unable to identify proxy for host תופיע כשתנסו לגשת לכתובת ה-URL של הדומיין המותאם אישית. לדוגמה:


{"fault":{"faultstring":"Unable to identify proxy for host: developers.mycompany.com:443 and url: \/","detail":{"errorcode":"messaging.adaptors.http.flow.ApplicationNotFound"}}}

כדי לשחזר את התצורה של הדומיין המותאם אישית במקרה שבו שרת ה-proxy של ה-API השתנה או נמחק:

  1. בוחרים פרסום > פורטלים ובוחרים את הפורטל שלכם.
  2. בוחרים באפשרות הגדרות בתפריט הנפתח בסרגל הניווט העליון או בדף הנחיתה.
  3. לוחצים על הכרטיסייה דומיינים.
  4. לוחצים על Save (שמירה) כדי לשחזר את שרת ה-API של שרת ה-proxy.

עדכון האישור

למידע כללי על עדכון אישורי TLS, ראו עדכון אישור TLS.

  1. מבצעים את השלבים המפורטים בשלב 2: הגדרת TLS.
  2. מבצעים את השלבים בשלב 3: הוספת שם דומיין מותאם אישית לפורטל