אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
ב-Edge, נתב מטפל בכל תעבורת הנתונים הנכנסת של ה-API. כלומר, כל בקשות ה-HTTP ו-HTTPS שנשלחות לשרת proxy ל-API מטופלות תחילה על ידי נתב Edge.
מארח וירטואלי מאפשר לארח כמה שמות דומיינים בשרת אחד. ב-Edge, השרת תואם לנתב Edge. הגדרת מספר מארחים וירטואליים בנתב מאפשרת לנתב לטפל בבקשות API לכמה שמות דומיין.
מארח וירטואלי ב-Edge מגדיר את פרוטוקול הגישה (HTTP או HTTPS), יציאת נתב פתוחה וכינוי מארח. הכינוי של המארח הוא בדרך כלל שם הדומיין ב-DNS שממופה לכתובת ה-IP של הנתב.
לדוגמה, בתמונה הבאה מוצג נתב עם שתי הגדרות של מארחים וירטואליים:
המארח הווירטואלי הראשון מטפל בבקשות HTTPS בדומיין domainName1, והמארח השני מטפל בבקשות HTTP בדומיין domainName2.
בבקשה לשרת proxy של API, הנתב משווה את הכותרת Host
של הבקשה הנכנסת לרשימה של כינויי המארחים שהוגדרו על ידי כל המארחים הווירטואליים, כדי לקבוע איזה מארח וירטואלי מטפל בבקשה.
מידע על הגדרות של מארחים וירטואליים
המארחים הווירטואליים מכילים את הפרטים הבאים:
- השם הפנימי של המארח הווירטואלי. משתמשים בשם הזה כדי להפנות למארח הווירטואלי בשרתי ה-proxy של ה-API ובזמן הגדרת המארח הווירטואלי.
- הכינוי של המארח של המארח הווירטואלי. בדרך כלל הכינוי של המארח הוא שם הדומיין של ה-DNS שממפה לכתובת ה-IP בנתב. הכותרת
Host
של בקשות API לשרתי proxy חייבת להכיל את הכינוי של המארח של המארח הווירטואלי. - יציאה פתוחה בנתב.
- אם הפרוטוקול TLS (גישה ל-HTTPS) מופעל או לא (גישה ל-HTTP).
לדוגמה, כשיוצרים מארח וירטואלי, מציינים את הפרטים הבאים:
- name = myvhost
- host alias = apis.acme.com
- port = 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 for the Cloud
כל ארגון 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 for Private Cloud
כשמתקינים את Apigee Edge לענן פרטי, לא נוצרים ארגונים, סביבות או מארחים וירטואליים כברירת מחדל. אחרי שמסיימים את תהליך ההתקנה של 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: Cloud או Cloud פרטי.
כתובות אימייל חלופיות ומארחים בשמות DNS ב-Edge for the Cloud
ב-Edge for the 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
שמוגדר כברירת מחדל. כדי לעשות זאת, צריך קודם ליצור רשומת CNAME ורשומת DNS משלכם.
באיור הבא מוצגת הגדרה אופיינית לאופן שבו Edge מעבד בקשת API:
בדוגמה הזו:
- api.acme.com הוא שם הדומיין הרצוי.
- מגדירים רשומת DNS ורשומת CNAME כדי להפנות את api.acme.com אל acme-prod.apigee.net.
- הבקשה מכילה את הכותרת
Host
, שבה הנתב משתמש כדי לקבוע מי המארח הווירטואלי שמטפל בבקשה.
בדוגמה הזו, מציינים את הפרטים הבאים בהגדרה של מארח וירטואלי:
- name = myvhost
- host alias = apis.acme.com
- port = 443
- הפעלת גישה ל-TLS
מידע נוסף זמין במאמר הגדרת מארחים וירטואליים ב-Cloud.
דומיינים חלופיים של מארחים ושמות DNS ב-Edge לענן פרטי
בדומה ל-Edge for the Cloud, יוצרים מארחים וירטואליים שמשתמשים בשם הדומיין שלכם בתור הכינוי של המארח. לאחר מכן יוצרים רשומת CNAME ורשומת DNS משלכם כדי לגשת למארחים הווירטואליים האלה.
אחד ההבדלים בין Cloud לענן פרטי הוא שב-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
- host alias = apis.acme.com
- port = 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 בשביל Cloud או ב-Edge לענן הפרטי. אם אתם משתמשים ב-Edge לענן הפרטי, רשימת הנכסים הזמינים תלויה גם בגרסה של Edge. תיאור מלא של כל המאפיינים של מארח וירטואלי זמין במאמר חומר עזר בנושא מאפייני מארח וירטואלי.
מידע נוסף על יצירת מארחים וירטואליים לגרסה הספציפית של Edge זמין במאמרים הבאים: