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

Edge for Private Cloud גרסה 4.19.01

במסמך הזה מוסבר איך להתקין את הגרסה החדשה של Edge ב-Edge לענן הפרטי. חוויית המשתמש החדשה של Edge היא הדור הבא של ממשק המשתמש של Edge.

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

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

מידע נוסף על הממשק החדש של Edge זמין כאן חוויית Edge החדשה עבור ענן פרטי.

סקירה כללית בנושא התקנה

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

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

דרישות מוקדמות להתקנה

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

  למידע על הפעלת SAML ב-Edge: תמיכה ב-SAML ב-Edge עבור ענן פרטי.

• חוויית Edge החדשה תומכת רק ב-TLS v1.2. בגלל שאתם מתחברים ל-IdP של SAML דרך TLS, לכן, ה-IdP שלך ב-SAML חייב לתמוך ב-TLS v1.2.

• תצטרכו להתקין את הממשק החדש של Edge בצומת משלו. לא ניתן להתקין אותו בצומת שמכיל רכיבי Edge אחרים, כולל הצומת שבו ממשק המשתמש הקיים של Edge. גרים ב-Google.

  הצומת צריך לעמוד בדרישות הבאות:

  • JAVA 1.8
  • זיכרון RAM בנפח 4GB
  • 2 ליבות
  • מקום אחסון בנפח 60GB
  • קודם עליך להתקין את גרסה 4.19.01 של כלי השירות apigee-setup ב- הצומת כפי שמתואר בהתקנת הקצה הכלי להגדרת apigee.
  • יציאה 3001 חייבת להיות פתוחה. זו יציאת ברירת המחדל שמשמשת לבקשות לממשק החדש של Edge. אם משנים את היציאה באמצעות המאפיינים שמפורטים בהמשך, צריך לוודא שהיציאה פתוחה.

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

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

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

• מפעילים תמיכה ב-SAML ב-Edge וגם בממשק המשתמש הקלאסי וגם בממשק החדש של Edge.

  בתרחיש הזה, כל המשתמשים בממשק הקלאסי ובממשק החדש של Edge רשומים ב-IdP של SAML. למידע על הוספת משתמשים חדשים ל-IdP של SAML, אפשר לעיין במאמר רישום משתמשי Edge חדשים.

• מפעילים תמיכה ב-SAML ב-Edge, אבל משאירים את האימות הבסיסי מופעל. חוויית השימוש החדשה ב-Edge משתמשת ב-SAML ובממשק המשתמש הקלאסי עדיין נעשה שימוש באימות בסיסי.

  בתרחיש הזה, כל המשתמשים בממשק המשתמש הקלאסי מתחברים עם פרטי כניסה בסיסיים לאימות, כאשר פרטי הכניסה שלהם מאוחסנים במסד הנתונים של Edge OpenLDAP. משתמשי הגרסה החדשה של Edge רשומים ב-IdP של SAML ולהתחבר באמצעות SAML.

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

שינויים בהגדרות ההתקנה מגרסאות קודמות

חשוב לשים לב לשינויים הבאים בתהליך ההתקנה מגרסת הבטא של חוויית Edge החדשה.

שינויים בהגדרות ההתקנה מ-Edge 4.18.05

גרסת Edge 4.19.01 של חוויית Edge החדשה כוללת את השינויים הבאים קובץ תצורה מגרסת Edge 4.18.05:

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

שינויים בהגדרות ההתקנה מ-Edge 4.18.01

גרסת Edge 4.19.01 של חוויית Edge החדשה כוללת את השינויים הבאים קובץ תצורה מגרסת Edge 4.18.01:

# Shoehorn UI configurations.
SHOEHORN_SCHEME
SHOEHORN_IP
SHOEHORN_PORT

# Classic UI configurations.
CLASSIC_UI_SCHEME
CLASSIC_UI_IP
CLASSIC_UI_PORT

# Information about Edge SSO module.
MANAGEMENT_UI_SKIP_VERIFY

ROUTES_SHOEHORN
ROUTES_CLASSICUI

MANAGEMENT_UI_USE_HTTPS

MANAGEMENT_UI_SCHEME

קובץ תצורה של ההתקנה

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

קובץ תצורה לדוגמה מוצג למטה:

# IP of the Edge Management Server.
# This node also hosts the Edge SSO module and the current, or classic, Edge UI.
IP1=11.111.111.111

# IP of the New Edge experience node.
IP2=22.222.222.222

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=CHANGE_TO_YOUR_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

# SSO configuration for the New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the New Edge experience.
SHOEHORN_SCHEME=http
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the classic UI,
# but are still required to configure the New Edge experience.
#

# These settings assume that classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO.
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is edgeui.
# Apigee recommends that you use the same settings as you used
# when enabling SAML on the classic Edge UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars. 
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Information about Edge SSO module.
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Edge SSO module.
# If Edge SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

#
# Required SMTP information.
#

SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company myco@company.com"

התקנת ממשק המשתמש של Base Edge (shoeורן)

לפני ההתקנה, צריך להתקין את ממשק המשתמש הבסיסי של Edge, שנקרא shoeורן, חוויית שימוש ב-Edge.

כדי להתקין את ממשק המשתמש הבסיסי:

1. התקנת גרסת 4.19.01 של כלי השירות apigee-setup בצומת כ- שמתואר בדף התקנת apigee-setup .
2. נקי יאמי:

   sudo yum clean all

3. יוצרים את קובץ התצורה כפי שמתואר למעלה ומוודאים שהוא נמצא בבעלות ה-apigee. user:

   chown apigee:apigee configFile

   כאשר configFile הוא קובץ התצורה שמתואר למעלה, קובץ תצורת התקנה.

4. שינוי הערך של המאפיין MANAGEMENT_UI_SSO_CSRF_SECRET בהגדרות לסוד ה-CSRF שלך.
5. מתקינים את גרסת Shoehooורן של ממשק המשתמש של Edge:

   /opt/apigee/apigee-service/bin/apigee-service edge-ui install

6. מגדירים את ממשק המשתמש של Edge:

   /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile

7. הפעלת SAML בממשק המשתמש של Edge:

   /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

התקנת הממשק החדש של Edge

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

כדי להתקין את הגרסה החדשה של Edge:

1. מתקינים את הגרסה החדשה של Edge:

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

2. שינוי לספרייה edge-management-ui:

   cd /opt/apigee/edge-management-ui

3. מגדירים את הממשק החדש של Edge:

   /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

   כאשר configFile הוא קובץ התצורה שמתואר למעלה, קובץ תצורת התקנה.

4. הפעלת SAML בממשק החדש של Edge:

   /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile

5. כדי להתחבר לממשק החדש של Edge פותחים את כתובת ה-URL הבאה בדפדפן:

   http://newEdgeExperienceIP:3001

   כאשר newEdgeExperienceIP הוא כתובת ה-IP של הצומת שמארח חוויית Edge החדשה. תתבקשו להזין את פרטי הכניסה ל-SAML. אחרי שהזנתם את יופיע הממשק החדש של Edge.

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

איך מסירים את הגרסה החדשה של Edge

כדי להסיר את אפליקציית New Edge:

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

כדי להסיר את ממשק המשתמש של Base Edge (shoeורן):

/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall

כדי להסיר לגמרי את Edge מהצומת:

1. הפסקת כל שירותי Edge שפועלים במחשב:

   /opt/apigee/apigee-service/bin/apigee-all stop

2. מנקים את מטמון ה-Yum:

   sudo yum clean all

3. הסרת כל ההכנסות לאלף צפיות ב-Apigee:

   sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")

4. מסירים את תיקיית השורש של ההתקנה:

   sudo rm -rf /opt/apigee