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

Edge for Private Cloud גרסה 4.18.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.

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

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

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

3. בודקים את ערך האסימון:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -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=myhost.name.com