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

Edge for Private Cloud v4.18.05

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

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

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

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

1. לקוח
2. מנהל ההתקנה
3. Apigee

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

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

לדוגמה, כדי ליצור קובץ .properties:

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

כדי להגדיר מאפיין לרכיב, צריך לערוך את הקובץ .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: התקנה, בעלים ולקוחות. מיקומי ברירת המחדל מוצגים בטבלה הבאה:

/opt/apigee/component_name/conf

/opt/apigee/token

/opt/apigee/customer

קביעת הערך הנוכחי של אסימון

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

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

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

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

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

/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:

1. עורכים את הקובץ /opt/apigee/customer/application/router.properties כדי להגדיר את אסימון conf_http_HTTPRequest.line.limit:

   conf_http_HTTPRequest.line.limit=8k

2. מפעילים מחדש את הנתב Edge:

   /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 מוגבלים, כך שרק מערכת ה-SIS יכולה להפעיל אותם. כדי לראות את הערך של 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 בתיקייה source של הרכיב.

לדוגמה, אם ידוע לך שבגרסה קודמת של 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