מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
ב-Edge, נתב מטפל בכל תעבורת ה-API הנכנסת. כלומר כל הפרוטוקולים HTTP ו-HTTPS בקשות לשרת proxy ל-API מטופלות תחילה על ידי נתב Edge.
מארח וירטואלי מאפשר לארח כמה שמות דומיינים בשרת. ב-Edge, השרת תואם ל-Edge Router. באמצעות הגדרה של מארחים וירטואליים מרובים בנתב, הנתב יכול לטפל בבקשות API לכמה שמות דומיינים.
מארח וירטואלי ב-Edge מגדיר את פרוטוקול הגישה (HTTP או HTTPS), יציאת נתב פתוחה ומארח כתובת אימייל חלופית. הכינוי של המארח הוא בדרך כלל שם דומיין ה-DNS שממפה אל כתובת ה-IP של הנתב.
לדוגמה, התמונה הבאה מציגה נתב עם שתי הגדרות של מארח וירטואלי:
המארח הווירטואלי הראשון מטפל בבקשות HTTPS הדומיין domainName1 והשני מטפל בבקשות HTTP ב-domainName2.
בבקשה שנשלחת לשרת proxy ל-API, הנתב משווה את הכותרת Host
של הבקשה הנכנסת אל
רשימה של כינויים של מארחים שהוגדרו על ידי כל המארחים הווירטואליים כדי לקבוע
המארח מטפל בבקשה.
מידע על ההגדרות של מארחים וירטואליים
מארחים וירטואליים מכילים את המידע הבא:
- השם הפנימי של המארח הווירטואלי. אתם משתמשים בשם הזה כדי להתייחס לארח בשרתי ה-proxy ל-API ובזמן הגדרת המארח הווירטואלי.
- הכתובת החלופית של המארח של המארח הווירטואלי. בדרך כלל הכינוי של המארח הוא ה-DNS
שם דומיין שממפה אל כתובת ה-IP בנתב. הכותרת
Host
של בקשות לשרת proxy ל-API חייבות להכיל את הכינוי המארח של המארח הווירטואלי. - יציאה פתוחה בנתב.
- האם TLS (גישת HTTPS) מופעלת או לא (גישת HTTP).
לדוגמה, כשיוצרים מארח וירטואלי, מציינים את הפרטים הבאים:
- name = myvhost
- כינוי מארח = apis.acme.com
- יציאה = 443
- TLS מופעל
על סמך ההגדרה שלמעלה לגבי המארח הווירטואלי, בקשה לשרת proxy ל-API משתמשת הטופס:
https://apis.acme.com/{proxy-base-path}/{resource-path}
איפה:
- הערך {proxy-base-path} מוגדר כשיוצרים שרת proxy ל-API, והוא ייחודי לכל שרת proxy ל-API.
לדוגמה:
https://apis.acme.com/characters
- {resource-path} הנתיב למשאב שאפשר לגשת אליו דרך שרת ה-proxy ל-API. לדוגמה:
https://apis.acme.com/characters/coyote https://apis.acme.com/characters/roadrunner
מידע על מארחים וירטואליים ב- Edge לענן
כל ארגון Edge כולל באופן אוטומטי שתי סביבות (test
ו-prod
), שני מארחים וירטואליים בכל סביבה (ברירת מחדל ומאובטחת),
ואת רשומות ה-DNS עבור כל כינוי מארח.
כינוי המארח של כל מארח וירטואלי שסופק על ידי Apigee מכיל את שם הארגון וגם סביבה, כפי שמוצג בטבלה הבאה:
סביבה | שם המארח הווירטואלי | כתובת אימייל חלופית של מארח | יציאה | TLS מופעל |
---|---|---|---|---|
prod | ברירת מחדל | {org-name}-prod.apigee.net |
80 | לא |
מאובטח | {org-name}-prod.apigee.net |
443 | כן | |
test | ברירת מחדל | {org-name}-test.apigee.net |
80 | לא |
מאובטח | {org-name}-test.apigee.net |
443 | כן |
לדוגמה, שם הדומיין שמוגדר כברירת מחדל בארגון שנקרא 'myorg
'
בסביבה prod
הוא 'myorg-prod.apigee.net
'.
לכן, כדי לגשת לשרת proxy ל-API בארגון הזה, צריך להשתמש בכתובת URL בתבנית:
http://myorg-prod.apigee.net/{proxy-base-path}/{resource-path} https://myorg-prod.apigee.net/{proxy-base-path}/{resource-path}
תוכניות בתשלום של Apigee: שם דומיין שמכיל את הכתובת 'apigee.net' זה לא מה שאתם רוצים לחשוף . אפשר להשתמש ברשומת DNS ורשומת CNAME כדי למפות שם דומיין אל לארגון שלכם ב-Edge. עליך גם ליצור מארח וירטואלי שבו מוגדר הכינוי של המארח שם דומיין. כך מפתחים יכולים לגשת ל-API דרך דומיין ספציפי לחברה שלך.
דוגמה לדומיין מותאם אישית ב-Edge:
https://apis.acme.com/{proxy-base-path}/{resource-path}
מידע על מארחים וירטואליים ב-Edge לענן פרטי
כשמתקינים את Apigee Edge לענן פרטי, אין ארגונים שמוגדרים כברירת מחדל, או מארחים וירטואליים שנוצרו עבורכם. בסיום תהליך ההתקנה של Edge, הפעולה הראשונה היא בדרך כלל יצירת ארגון, סביבה ומארח וירטואלי באמצעות תהליך ההצטרפות תהליך האימות.
כדי לבצע את תהליך ההצטרפות, מריצים את הפקודה הבאה בצומת של שרת ניהול הקצה:
/opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile
כאשר configFile מכיל את המידע הנדרש כדי ליצור משתמש, ארגון, סביבה ומארח וירטואלי.
לדוגמה, יוצרים:
- משתמש לבחירתך כאדמין ארגוני
- ארגון בשם
example
- סביבה בארגון בשם
prod
- מארח וירטואלי בסביבה בשם
default
שמאפשר גישת HTTP ביציאה 9001 - כינוי מארח של שם ה-DNS המשמש לגישה לנתב, או כתובת ה-IP של הנתב
היציאה של המארח הווירטואלי בפורמט
IP:9001
.
מאוחר יותר ניתן להוסיף כל מספר של ארגונים, סביבות ומארחים וירטואליים לגרסה המקומית של Edge. מידע נוסף זמין בדפים הבאים:
המארחים הווירטואליים נפתחים ב-Edge Router. לכן צריך לוודא שהיציאה שציינת עבור המארח הווירטואלי פתוח בנתב. אפשר להשתמש בפקודה מהצורה הבאה: כדי לפתוח יציאה:
iptables -A INPUT -m state --state NEW -m tcp -p tcp --dport 9001 -j ACCEPT --verbose
אחרי שמריצים את הפקודה הזו, ניתן לגשת לממשקי ה-API באמצעות כתובת URL:
http://<router-ip>:9001/{proxy-base-path}/{resource-path}
בדרך כלל, אתם לא מפרסמים את ממשקי ה-API שלכם ללקוחות עם כתובת IP מספר יציאה. במקום זאת, מגדירים רשומת DNS לנתב וליציאה. לדוגמה:
http://myAPI.myCo.com/{proxy-base-path}/{resource-path}
כשמגדירים את רשומת ה-DNS, צריך גם ליצור מארח וירטואלי עם כינוי מארח תואם לשם הדומיין של רשומת ה-DNS. מהדוגמה שלמעלה צריך לציין כינוי של מארח של myAPI.myCo.com בזמן יצירת המארח הווירטואלי.
מידע על כינויים של מארחים ושמות DNS
אחד הנכסים שאתם מגדירים למארח וירטואלי הוא הכינוי החלופי. הכינוי של המארח הוא בדרך כלל שם ה-DNS של המארח הווירטואלי. הגדרת הכינוי של המארח תלויה בסוג התקנת Edge: ענן או ענן פרטי.
כינויי מארח וגם שמות DNS ב-Edge לענן
ב-Edge for Cloud, בפעם הראשונה שיוצרים ארגון Edge, Apigee אוטומטית
יוצרת שתי סביבות (test
ו-prod
), שני מארחים וירטואליים
כל סביבה (ברירת מחדל ומאובטחת), ורשומות DNS לכל סביבה
מארח וירטואלי.
כינוי המארח של המארחים הווירטואליים מכיל את שם הארגון והסביבה. לכן, בקשה דרך מארח וירטואלי תיראה כך:
http://{org-name}-prod.apigee.net/{proxy-base-path}/{resource-path}
https://{org-name}-prod.apigee.net/{proxy-base-path}/{resource-path}
http://{org-name}-test.apigee.net/{proxy-base-path}/{resource-path}
https://{org-name}-test.apigee.net/{proxy-base-path}/{resource-path}
בדרך כלל, ברצונך ליצור מארחים וירטואליים שמשתמשים בשם הדומיין שלך במקום להשתמש
דומיין ברירת המחדל apigee.net
. לבצע
לכן קודם כול צריך ליצור רשומת DNS ורשומת CNAME משלכם.
האיור הבא מציג את ההגדרה האופיינית של האופן שבו Edge מעבד בקשת API:
בדוגמה הזו:
- api.acme.com הוא שם הדומיין הרצוי.
- מגדירים רשומת DNS ורשומת CNAME כדי להפנות אל api.acme.com acme-prod.apigee.net.
- הבקשה מכילה את הכותרת
Host
שבה הנתב משתמש כדי לקבוע את המארח הווירטואלי שמטפל בבקשה.
בדוגמה הזו, מציינים את הפרטים הבאים בהגדרת מארח וירטואלי:
- name = myvhost
- כינוי מארח = apis.acme.com
- יציאה = 443
- הפעלת גישה ל-TLS
למידע נוסף, ראו הגדרת מארחים וירטואליים עבור הענן.
דומיינים חלופיים ושמות DNS ב-Edge לענן פרטי
בדומה ל-Edge בענן, אתם יוצרים מארחים וירטואליים שמשתמשים בשם הדומיין שלכם בשביל המארח כתובת אימייל חלופית. לאחר מכן תוכלו ליצור רשומת DNS ורשומת CNAME משלכם כדי לגשת למארחים הווירטואליים האלה.
אחד ההבדלים בין ענן לענן פרטי הוא שב-Cloud Apigee שמות DNS שנוצרו באופן אוטומטי לארגונים שלכם, בנוסח הבא:
- name=default:
http://{org-name}-{env-name}.apigee.net
(יציאת נתב 80) - name=secure:
https://{org-name}-{env-name}.apigee.net
(יציאת הנתב 443)
ב-Edge עבור ענן פרטי, צריך ליצור את רשומות ה-DNS לכתובת ה-IP וליציאה של הנתב.
לדוגמה, תוכל לציין את המידע הבא בהגדרת מארח וירטואלי:
- name = myvhost
- כינוי מארח = apis.acme.com
- יציאה = 9001
- הפעלת גישה ל-TLS
האיור הבא מציג את ההגדרה האופיינית של האופן שבו Edge מעבד בקשת API:
בדוגמה הזו:
- api.acme.com הוא שם הדומיין הרצוי.
- מגדירים רשומת DNS ורשומת CNAME כדי להפנות את api.acme.com לכתובת ה-IP הכתובת והיציאה של הנתב.
- הבקשה מכילה את הכותרת
Host
שבה הנתב משתמש כדי לקבוע את המארח הווירטואלי שמטפל בבקשה.
מידע נוסף מופיע במאמר הגדרת מארחים וירטואליים לענן הפרטי.
כינויי מארחים ותווים כלליים לחיפוש
אפשר לכלול את הסימן "*" תו כללי לחיפוש בכינוי המארח. הסימן "*" התו הכללי לחיפוש יכול יהיה רק בהתחלה (לפני התו '.') הראשון של הכינוי של המארח, ואי אפשר לשלב אותו עם תווים.
דוגמה לכתובת אימייל חלופית חוקית של מארח שמשתמשת בתו כללי לחיפוש:
*.example.com
הדוגמאות הבאות לא תקינות:
www.*.example.com w*.example.com
השימוש בתו כללי לחיפוש בכינוי מארח וירטואלי מאפשר
שרתי proxy ל-API מטפלים בקריאות שממוענות לכמה תת-דומיינים כמו
alpha.example.com
, beta.example.com
, או
live.example.com
. שימוש בתו כללי לחיפוש עוזר גם להשתמש פחות משתמשים וירטואליים
מארחים לכל סביבה כדי להישאר בתוך המוצר
מגבלות, כי מארח וירטואלי עם תו כללי לחיפוש נספר כמארח וירטואלי אחד בלבד.
אישור ה-TLS של המארח הווירטואלי חייב לכלול תו כללי לחיפוש תואם בשם ה-CN של האישור.
לדוגמה, *.example.com
.
מידע על מאפייני מארח וירטואלי
ב-Edge, מארח וירטואלי מיוצג על ידי אובייקט XML. לדוגמה, אובייקט ה-XML הבא מגדיר מארח וירטואלי:
<VirtualHost name="vhostName"> <HostAliases> <HostAlias>hostAlias</HostAlias> </HostAliases> <Interfaces> <!-- Private Cloud only --> <Interface>interfaceName</Interface> <Port>portNumber</Port> <BaseURL>http://myCo.com<</BaseUrl> <OCSPStapling>off</OCSPStapling> <RetryOptions/> <SSLInfo> <Enabled>trueFalse</Enabled> <ClientAuthEnabled>trueFalse</ClientAuthEnabled> <KeyStore>ref://keystoreRef</KeyStore> <KeyAlias>keyAlias</KeyAlias> <TrustStore>ref://truststoreRef</TrustStore> <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors> </SSLInfo> <Properties> <Property name="proxy_read_timeout">timeout</Property> <Property name="keepalive_timeout">timeout</Property> <Property name="proxy_request_buffering">onOff</Property> <Property name="proxy_buffering">onOff</Property> <Property name="ssl_protocols">protocolList</Property> <Property name="ssl_ciphers">cipherList</Property> </Properties> </VirtualHost>
רשימת המאפיינים שאפשר להגדיר מבוססת על אם אתם משתמשים ב-Edge for Cloud או Edge לענן הפרטי. אם אתם משתמשים ב-Edge בענן הפרטי, המאפיינים הזמינים תלויים גם בגרסת Edge שבה אתם משתמשים. תיאור מלא של כל המאפיינים של מארח וירטואלי זמין בכתובת חומר עזר בנושא נכס מארח וירטואלי.
מידע נוסף על יצירת מארחים וירטואליים לגרסה הספציפית של Edge זמין במאמרים הבאים: