איך להגדיר את Edge

Edge for Private Cloud גרסה 4.17.05

כדי להגדיר את Edge אחרי ההתקנה, משתמשים בשילוב של קובצי ‎.properties וכלי שירות של Edge. לדוגמה, כדי להגדיר TLS/SSL בממשק המשתמש של Edge, עורכים קובצי ‎.properties כדי להגדיר את המאפיינים הנדרשים. אם מבצעים שינויים בקובצי ‎.properties, צריך להפעיל מחדש את רכיב Edge הרלוונטי.

ב-Apigee, השיטה של עריכת קובצי ‎.properties נקראת קוד עם הגדרות אישיות. בעיקרון, קוד עם הגדרות אישיות הוא כלי לחיפוש מפתח/ערך שמבוסס על ההגדרות בקובצי ‎.properties. בקוד עם config, המפתחות נקראים אסימונים. לכן, כדי להגדיר את Edge, מגדירים אסימונים בקובצי ‎.properties.

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

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

1. לקוח
2. מתקין
3. Apigee

איך משתמשים בקובצי ‎ .properties

כלקוחות, אתם יכולים לשנות רק את קובצי ‎.properties בספרייה /opt/apigee/customer/application. לכל רכיב יש קובץ ‎.properties משלו בספרייה הזו. לדוגמה, router.properties ו-management-server.properties.

1. יוצרים את הקובץ בכלי לעריכת טקסט בתור משתמש כלשהו.
2. משנים את הבעלים של הקובץ ל-apigee:apigee באמצעות הפקודה chown. אם שיניתם את המשתמש שמריץ את שירות Edge מהמשתמש apigee, משנים את הבעלים של הקובץ למשתמש שמריץ את שירות Edge באמצעות הפקודה chown.

כדי להגדיר מאפיין לרכיב, עורכים את קובץ ‎.properties המתאים כדי להגדיר טוקן, ואז מפעילים מחדש את הרכיב:

> /opt/apigee/apigee-service/bin/apigee-service component restart

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

> /opt/apigee/apigee-service/bin/apigee-service edge-router restart

כשמשדרגים את Edge, המערכת קוראת את קובצי ה-‎.properties בספרייה /opt/apigee/customer/application. כלומר, השדרוג ישמור על כל המאפיינים שהגדרתם ברכיב.

המיקום של קובצי ‎ .properties

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

אזהרה: לקוחות Edge יכולים לשנות רק את קובצי ‎.properties ב-/opt/apigee/customer. אפשר לראות את הקבצים בספריות הרכיבים וההתקנה, אבל אסור לשנות אותם.

איך בודקים את הערך הנוכחי של טוקן

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

> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token

כאשר comp הוא שם הרכיב, ו-token הוא האסימון שרוצים לבדוק.

הפקודה הזו מחפשת בהיררכיה של קובצי ‎.properties כדי לקבוע את הערך הנוכחי של הטוקן.

לדוגמה, כדי לבדוק את הערך הנוכחי של הטוקן conf_http_HTTPRequest.line.limit ב-Router:

> /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

הפלט אמור להיראות כך:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

הגדרת טוקנים בקובצי ‎ .properties

כדי לשנות את הערך של טוקן:

1. עורכים את הקובץ ‎.properties של הרכיב כדי להגדיר את ערך הטוקן. אם הקובץ לא קיים, יוצרים אותו.
2. מפעילים מחדש את הרכיב.
3. בודקים את ערך הטוקן.

לדוגמה, כדי להגדיר את מגבלת שורת הבקשה ל-Edge Router:

1. עורכים את הקובץ ‎/opt/apigee/customer/application/router.properties כדי להגדיר את האסימון conf_http_HTTPRequest.line.limit:
   
   conf_http_HTTPRequest.line.limit=8k
2. מפעילים מחדש את Edge Router:
   
   > ‎/opt/apigee/apigee-service/bin/apigee-service edge-router restart
3. בודקים את הערך של הטוקן:
   
   > /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

הגדרת טוקן שמקבל כמה ערכים

חלק מהאסימונים מקבלים רשימת ערכים מופרדים בפסיקים. לדוגמה, הטוקן conf_security_rbac.restricted.resources מקבל רשימה של מזהי URI מוגבלים, כך שרק ה-sysadmin יכול לקרוא להם. כדי לראות את הערך של conf_security_rbac.restricted.resources:

> cd /opt/apigee/edge-management-server
> grep -ri "conf_security_rbac.restricted.resources" *

הפלט מכיל את הפרטים הבאים:

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

כדי להגדיר אסימון שמקבל רשימת ערכים, מוסיפים ערכים חדשים לערך הנוכחי של האסימון בקובץ ‎.properties. לכן, כדי להוסיף את ה-URI‏ /myuri/*‎ אל conf_security_rbac.restricted.resources, צריך לערוך את הקובץ ‎/opt/apigee/customer/application/management-server.properties כמו שמוצג בהמשך:

conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

איתור טוקן

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

לדוגמה, אם אתם יודעים שבגרסה קודמת של Edge הגדרתם את המאפיין session.maxAge ואתם רוצים לדעת מה ערך הטוקן ששימש להגדרה שלו, אתם יכולים להשתמש ב-grep כדי לחפש את המאפיין בספרייה /opt/apigee/edge-ui/source:

> grep -ri "session.maxAge" /opt/apigee/edge-ui/source

התוצאה אמורה להיראות כך:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

המחרוזת בין התגים {T}{/T} היא האסימון שהגדרתם בקובץ ‎.properties.

הגדרת טוקן שמסומן כרגע כהערה

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

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

conf/file.extension+propertyName=propertyValue

לדוגמה, אתם רוצים להגדיר את המאפיין HTTPClient.proxy.host במעבד הבקשות. לאחר מכן, מריצים grep על המאפיין כדי לזהות את האסימון שלו:

> cd /opt/apigee/edge-message-processor
> grep -ri "HTTPClient.proxy.host" *

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

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

כדי להגדיר את המאפיין, עורכים את /opt/apigee/customer/application/message-processor.properties ומגדירים את המאפיין כך:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

שימו לב שלשם המאפיין נוספה הקידומת conf/http.properties+‎, המיקום והשם של קובץ התצורה שמכיל את המאפיין, ואחריו "+".

אחרי שמפעילים מחדש את מעבד הבקשות, בודקים את הקובץ /opt/apigee/edge-message-processor/conf/http.properties:

> cat /opt/apigee/edge-message-processor/conf/http.properties

בסוף הקובץ, תראו את קבוצת הנכסים בפורמט הבא:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com