העברת נכסים מהממשק הקלאסי לממשק החדש של Edge

ב-Apigee Edge for Private Cloud 4.54.00, ממשק המשתמש הקלאסי (הרכיב edge-ui) הוסר והוא לא זמין יותר. ממשק המשתמש החדש של Edge (הרכיב edge-management-ui) הוא ממשק המשתמש היחיד של Edge for Private Cloud.

אי אפשר להשתמש ב-edge-ui ב-Edge for Private Cloud 4.54.00. אם התאמתם אישית את ממשק המשתמש הקלאסי על ידי הגדרת מאפיינים ב-/opt/apigee/customer/application/ui.properties, ממשק המשתמש החדש של Edge לא קורא את הקובץ הזה. אחרי העדכון לגרסה 4.54.00, צריך להגדיר את המאפיינים המקבילים ב-/opt/apigee/customer/application/management-ui.properties.

בדף הזה מפורטים המאפיינים של ממשק המשתמש הקלאסי שמתועדים ב-ui.properties, המאפיינים המקבילים בממשק המשתמש החדש של Edge והמאפיינים של ממשק המשתמש הקלאסי שלא נתמכים בממשק המשתמש החדש של Edge.

ממשק המשתמש החדש של Edge משתמש באותו קוד עם מנגנון תצורה (CwC) כמו רכיבים אחרים של Edge. מידע נוסף זמין במאמר איך מגדירים את Edge.

השוואה בין ההגדרות של ממשק המשתמש הקלאסי לבין ההגדרות של ממשק המשתמש החדש של Edge

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

הגדרה ממשק משתמש קלאסי (גרסה 4.53.01 וגרסאות קודמות) ממשק המשתמש החדש של Edge‏ (4.54.00)
שם הרכיב edge-ui edge-management-ui
קובץ מאפיינים /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
הפעלה מחדש של הפקודה apigee-service edge-ui restart apigee-service edge-management-ui restart
יציאת ברירת המחדל 9000 3001
הגדרת TLS קובץ Java keystore‏ (JKS) קובצי אישור ומפתח בפורמט PEM. מידע נוסף זמין במאמר הגדרת TLS לממשק המשתמש החדש של Edge.

הגדרת מאפיינים לממשק המשתמש החדש של Edge

מגדירים את מאפייני התצורה של ממשק המשתמש החדש של Edge בקובץ /opt/apigee/customer/application/management-ui.properties ומפעילים מחדש את השירות edge-management-ui כדי שהשינויים ייכנסו לתוקף.

כדי להגדיר נכס בממשק המשתמש החדש של Edge:

  1. פותחים את הקובץ management-ui.properties בכלי לעריכת טקסט. אם הקובץ לא קיים, יוצרים אותו: 
    vi /opt/apigee/customer/application/management-ui.properties
  2. מגדירים את המאפיין. לדוגמה: 
    conf_uebe_disableGeoMap=true
  3. שומרים את השינויים.
  4. מוודאים שהמשתמש apigee הוא הבעלים של הקובץ: 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. מפעילים מחדש את ממשק המשתמש החדש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

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

  • שמות המאפיינים הם תלויי אותיות רישיות. לדוגמה, ההגבלה conf_uebe_disableGeoMap תקינה, אבל ההגבלה conf_uebe_disablegeomap לא תקינה.
  • צריך לתחום ערכי מחרוזת במירכאות כפולות, לדוגמה conf_uebe_branding_companyNameShort="My Company".
  • אין להוסיף מירכאות לערכים בוליאניים (true או false) או לערכים מספריים. אם ערך בוליאני או מספרי מוקף במירכאות, ממשק המשתמש החדש של Edge לא יופעל.

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

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

מיפוי מאפיינים בממשק המשתמש הקלאסי לממשק המשתמש החדש של Edge

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

הגדרת מאפייני התכונה

מיפוי של feature flags בממשק המשתמש הקלאסי למאפיינים התואמים conf_uebe_*ב-management-ui.properties:

נכס עם ממשק משתמש קלאסי מאפיין חדש בממשק המשתמש של Edge ברירת מחדל הערות
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false צריך להגדיר את הערך true כדי להסתיר את המפות הגיאוגרפיות. בממשק המשתמש הקלאסי של Edge for Private Cloud, מפות גיאוגרפיות הושבתו כברירת מחדל. אם לא הפעלתם צבירה גיאוגרפית, צריך להגדיר את המאפיין הזה לערך true. הפעלת צבירת נתונים גיאוגרפיים ומפות גיאוגרפיות
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false מגדירים את הערך true כדי להסתיר את הקישור איפוס סיסמה בדף ההתחברות.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true צריך להגדיר את הערך false כדי לאפשר דוחות בהתאמה אישית לטווח תאריכים של יותר מ-14 ימים.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false מגדירים את הערך true כדי לאפשר לכלי Trace לשלוח בקשות לכתובות IP מקומיות או פנימיות.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false הערך שמוגדר הוא true כדי לאפשר ייבוא של מפרטים של OpenAPI מכתובות IP מקומיות או פנימיות.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false צריך להגדיר את הערך true כדי לאפשר ייבוא של קובצי WSDL מכתובות IP מקומיות או פנימיות.

הגדרת מאפייני סשן ו-TLS

ממפים את המאפיינים של TLS ושל הזמן הקצוב לתפוגה של סשן בממשק המשתמש הקלאסי למאפיינים המקבילים בממשק המשתמש החדש של Edge ב-management-ui.properties:

נכס בממשק המשתמש הקלאסי מאפיין חדש בממשק המשתמש של Edge ברירת מחדל הערות
conf_application_session.maxage conf_uebe_authsessiontimeout ‫12 (שעות) הזמן שאחריו פג התוקף של סשן המשתמש לאחר ההתחברות. מציינים מספר שעות (לדוגמה, 12 או 0.5) או משך זמן עם יחידת הזמן h (שעות) או m (דקות) (לדוגמה, 24h או 90m). הערכים 12 ו-12h שווים. היחידה d (ימים) לא נתמכת. לדוגמה, צריך להחליף את 1d ב-24h. אם הערך לא תקין, המערכת תשתמש בערך ברירת המחדל של 12 שעות ולא תדווח על שגיאה. ההגדרה רלוונטית לסשנים שמשתמשים באימות בסיסי.
conf_application_session.secure לא נדרש לא רלוונטי ממשק המשתמש החדש של Edge מגדיר את הדגל Secure בקובצי Cookie של סשנים באופן אוטומטי כש-TLS מופעל (conf_uebe_usehttps=true) או כש-TLS מסתיים במאזן עומסים (conf_uebe_tlsoffload=true).
conf/application.conf+trustxforwarded ‫conf_uebe_usehttps=true וגם conf_uebe_tlsoffload=true false צריך להגדיר את שני המאפיינים כש-TLS מסתיים במאזן עומסים. מאזן העומסים צריך להעביר בקשות לממשק המשתמש החדש של Edge באמצעות HTTP ולהגדיר את הכותרת X-Forwarded-Proto. הפקודה configure-ssl מגדירה את המאפיינים האלה כשמציינים את MANAGEMENT_UI_SCHEME=https ואת MANAGEMENT_UI_TLS_OFFLOAD=y. מידע נוסף זמין במאמר בנושא הגדרת TLS בממשק המשתמש החדש של Edge.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false צריך להגדיר את הערך true רק אם שרת הניהול משתמש באישור בחתימה עצמית. מידע נוסף זמין במאמר בנושא הגדרת TLS עבור Management API.

הגדרת מאפיינים ותבניות של אימיילים

מיפוי של מאפיינים כמו שולח אימייל, נושא, מיתוג, כתובת URL של מארח ותוקף של קישור בממשק המשתמש הקלאסי לממשק המשתמש החדש של Edge:

נכס בממשק המשתמש הקלאסי מאפיין חדש בממשק המשתמש של Edge ברירת מחדל הערות
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom ‫Apigee <sales@apigee.com>, או הערך של SMTPMAILFROM שצוין בזמן ההתקנה ללא שינוי.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request שימו לב לפלח המאפיין passwordReset בפורמט camelCase.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} שימו לב לפלח המאפיין userAddedExisting בפורמט camelCase.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} שימו לב לפלח המאפיין userAddedNew ב-camelCase.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee הפונקציה מגדירה את הערך של ה-placeholder‏ {companyNameShort} בנושאים ובתבניות של אימיילים.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl ללא ללא שינוי. אם לא מגדירים את המדיניות הזו, קישורים לאיפוס סיסמה משתמשים בכתובת ה-URL של ממשק המשתמש החדש של Edge שצוינה בזמן ההתקנה, וקישורים להזמנת משתמשים משתמשים בשם המארח של הבקשה. צריך להגדיר את המאפיין הזה אם המשתמשים ניגשים לממשק המשתמש החדש של Edge דרך מאזן עומסים או שם DNS, לדוגמה conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 ההגדרה חלה על קישורים לאיפוס סיסמה וקישורים להזמנת משתמשים.

בממשק המשתמש החדש של Edge נעשה שימוש בתבניות אימייל מובנות. כדי להשתמש בתבניות שהתאמתם אישית לממשק המשתמש הקלאסי:

  1. יוצרים את הספרייה /opt/apigee/edge-management-ui/email-templates.
  2. מעתינים את הקבצים המותאמים אישית password-reset.html,‏ user-added-existing.html ו-user-added-new.html מהספרייה של הגיבוי שיצרתם לפני העדכון (לדוגמה, /opt/apigee/customer/backup/) אל /opt/apigee/edge-management-ui/email-templates. שמות הקבצים והפלייסהולדרים של התבניות זהים לאלה שבממשק המשתמש הקלאסי.
  3. מוודאים שהספרייה והקבצים נמצאים בבעלות המשתמש apigee.
  4. מפעילים מחדש את ממשק המשתמש החדש של Edge.

מידע נוסף זמין במאמר התאמה אישית של תבניות אימייל ב-Edge.

הגדרת מאפיינים של סיסמאות שנוצרות אוטומטית

מיפוי מאפייני סיסמה שנוצרו באופן אוטומטי בממשק המשתמש הקלאסי לממשק המשתמש החדש של Edge:

נכס בממשק המשתמש הקלאסי מאפיין חדש בממשק המשתמש של Edge ברירת מחדל
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

הגדרת החיבור לשרת הניהול ומאפייני הסוד המשותף

ממפים את מאפייני החיבור, פרטי הכניסה והסוד של האפליקציה של שרת הניהול בממשק המשתמש הקלאסי לממשק המשתמש החדש של Edge:

נכס עם ממשק משתמש קלאסי מאפיין חדש בממשק המשתמש של Edge הערות
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl כתובת ה-URL של ה-Management API, לדוגמה https://FQ_domain_name:port/v1. שם המאפיין הזה לא מתחיל ב-conf_. אם בשרת הניהול נעשה שימוש באישור בחתימה עצמית, צריך להגדיר גם את conf_uebe_skipverify=true.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential פרטי כניסה מוצפנים של אדמין מערכת. צריך להצפין מחדש את פרטי הכניסה עבור ממשק המשתמש החדש של Edge באמצעות ./bin/management-ui --encrypt. אפשר לעיין במאמר נדרשת הגדרה עבור פרטי כניסה שונים של אדמין מערכת.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential פרטי כניסה מוצפנים ל-SMTP.
conf_application_application.secret conf_uebe_applicationsecret סוד שמשמש להצפנת פרטי הכניסה וקובצי ה-Cookie הזמניים. נוצר בזמן ההתקנה.

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

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

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

הסרה של מאפיינים שלא נתמכים בממשק המשתמש הקלאסי

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

נכס בממשק המשתמש הקלאסי תיאור
‫conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection אי אפשר להגדיר את הזמן הקצוב לתפוגה של קריאות ל-Management API בממשק המשתמש החדש של Edge.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword בממשק המשתמש החדש של Edge אין תמיכה בשרת proxy להעברה לבקשות של כלי המעקב.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body באנר בקשת ההסכמה לא נתמך בממשק המשתמש החדש של Edge.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize בממשק המשתמש החדש של Edge, רשימת שרתי ה-proxy ל-API תמיד נטענת בדפים. אי אפשר להגדיר את גודל הדף.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application אי אפשר להגדיר את רמת היומן בממשק המשתמש החדש של Edge. קובצי היומן נכתבים בנתיב /opt/apigee/var/log/edge-management-ui.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts ממשק המשתמש החדש של Edge לא פועל במכונה וירטואלית של Java. הגדרות הזיכרון של Java לא חלות.

דוגמה להעברה

בדוגמה הבאה מוצג קובץ ui.properties של ממשק משתמש קלאסי בהשוואה לקובץ management-ui.properties המקביל של ממשק המשתמש החדש של Edge.

ממשק משתמש קלאסי, /opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

ממשק משתמש חדש של Edge, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

שימו לב שהערך הבוליאני true לא מוקף במירכאות, ושהערך של הזמן הקצוב לתפוגה של הסשן 1d מוחלף בערך 24.

אחרי ששומרים את הקובץ, מפעילים מחדש את ממשק המשתמש החדש של Edge:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

רשימת משימות לסיכום

כדי להשלים את המעבר לממשק המשתמש החדש של Edge ב-Apigee Edge for Private Cloud 4.54.00, אתם יכולים להיעזר ברשימת המשימות הבאה:

  1. לפני השדרוג, כדאי לגבות את /opt/apigee/customer/application/ui.properties ואת כל התבניות המותאמות אישית של אימיילים מ-/opt/apigee/edge-ui/email-templates.
  2. מוסיפים מאפיינים ממופים אל /opt/apigee/customer/application/management-ui.properties בלי להוסיף מירכאות לערכים בוליאניים או מספריים, ומשמיטים מאפיינים לא נתמכים של ממשק המשתמש הקלאסי.
  3. מעתיקים תבניות אימייל בהתאמה אישית מהספרייה של הגיבוי אל /opt/apigee/edge-management-ui/email-templates.
  4. הצפנה מחדש של פרטי הכניסה של מנהל המערכת באמצעות ./bin/management-ui --encrypt אם הגדרתם את conf_uebe_mgmtCredential.
  5. מגדירים את הבעלות על הקובץ ל-apigee:apigee ומפעילים מחדש את edge-management-ui.