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

Edge for Private Cloud גרסה 4.17.01

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

Apigee היא השיטה של עריכת קובצי .properties כקוד עם config. למעשה, קוד עם הגדרה הוא כלי לחיפוש מפתח/ערך שמבוסס על הגדרות קובצי .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 או אם שיניתם את המשתמש להפעיל את שירות 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)

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

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

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

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

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

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

הפקודה מחפשת בהיררכיה של קובצי .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 Router:

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 מחדש
3. צריך לבדוק את ערך האסימון:
   
   > /opt/apigee/apigee-service/bin/apigee-service edge-router configuration -search conf_http_HTTPRequest.line.limit

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

בחלק מהאסימונים מופיעה רשימת ערכים שמופרדים בפסיקים. לדוגמה, האסימון conf_security_rbac.restricted.resources מתעד רשימה של מזהי URI שמוגבלים כך שרק מנהל המערכת יוכל לקרוא להם. כדי לראות את של 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=yhost.name.com