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

Edge for Private Cloud גרסה 4.17.09

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

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

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

בעלים

ספריית ברירת המחדל של האסימון ברמה הבסיסית

רכיב

/opt/apigee/<prefix>-<component>/conf

כאשר /<prefix>-<component> מזהה את הרכיב, למשל נתב קצה או apigee-cassandra.

התקנה

/opt/apigee/token

לקוח/ה

/opt/apigee/customer

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

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

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

כאשר comp הוא שם הרכיב, ו-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
  3. בודקים את הערך של האסימון:

    > /opt/apigee/apigee-service/bin/apigee-service edge-router setup -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 בתיקייה 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