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

במסמך הזה מוסבר איך להתקין את ממשק המשתמש של Edge עבור Apigee Edge ל-Private Cloud. ממשק המשתמש של Edge הוא הדור הבא של ממשק המשתמש של Edge.

דרישות מוקדמות

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

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

    הצומת של ממשק המשתמש של Edge חייב לעמוד בדרישות הבאות:

    • JAVA 1.8
    • זיכרון RAM של 4GB
    • 2 ליבות
    • נפח אחסון של 60GB
    • תחילה צריך להתקין את גרסה 4.50.00 של כלי השירות apigee-setup בצומת, כפי שמתואר במאמר התקנה של כלי ההגדרה בהגדרת Edge.
    • יציאה 3001 חייבת להיות פתוחה. זוהי יציאת ברירת המחדל לבקשות של ממשק המשתמש של Edge. אם משנים את היציאה באמצעות המאפיינים המתוארים בקובץ התצורה החדש של UE, צריך לוודא שהיציאה פתוחה.
  • הפעלת IDP חיצוני ב-Edge. ממשק המשתמש של Edge תומך ב-SAML או ב-LDAP כמנגנון האימות.
  • (SAML IdP בלבד) ממשק המשתמש של Edge תומך רק ב-TLS v1.2. מאחר שאתם מתחברים ל-SAML IDP באמצעות TLS, אם אתם משתמשים ב-SAML, עליכם לספק תמיכה ב-TLS v1.2 ב-IdP.

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

סקירה כללית של ההתקנה

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

  • הוספת צומת חדש לאשכול
  • התחברות לצומת החדש
  • הורדת קובץ השירות של apigee-setup
  • יצירת קובץ תצורה ושינוי שלו באמצעות ההגדרות שלך
  • הפעלת תוכנית השירות apigee-setup
  • יש להתחבר ולבדוק את האיחוד האירופי החדש

כשהיא מופעלת בצומת החדש, כלי השירות של apigee-setup:

  • מתבצעת התקנה של ממשק המשתמש הבסיסי של הגרסה הקלאסית, שנקרא shoehor, ומגדירה את ממשק המשתמש הקלאסי לשימוש ב-IdP חיצוני לצורך אימות באמצעות Edge.
  • התקנה של ממשק המשתמש החדש של Edge, וממשק המשתמש של Edge מוגדר לשימוש ב-IdP החיצוני לצורך אימות באמצעות Edge.

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

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

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

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

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

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

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

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

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

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

קובץ תצורה חדש של ממשק המשתמש של Edge

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

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

# IP of the Edge UI node.
IP2=edge_UI_server_IP

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

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

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
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=YOUR_CSRF_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 Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI.
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 Edge UI.
#

# 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_REGISTERD_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 your IDP on the Classic 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

# Apigee SSO Component configuration
# 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 Apigee SSO module.
# If Apigee 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 Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

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

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

אחרי שיוצרים ומשנים את קובץ התצורה, אפשר להתקין את ממשק המשתמש החדש של Edge בצומת החדש.

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

  1. הוספה של צומת חדש לאשכול.
  2. התחבר לצומת החדש כאדמין.
  3. מתקינים את גרסה 4.50.00 של כלי השירות apigee-setup בצומת, כפי שמתואר בהתקנה של כלי השירות להגדרת קצה.
  4. כדי לנקות את כל המידע שנשמר במטמון עם Yum, מריצים את הפקודה הבאה: 
    sudo yum clean all
  5. יוצרים את קובץ התצורה כפי שמתואר בקובץ התצורה החדש של ממשק המשתמש של Edge, ומוודאים שהוא בבעלות המשתמש "geepe": 
    chown apigee:apigee configFile

    הקפידו לבצע את פעולות העריכה הבאות בקובץ התצורה:

    • משנים את הערך של המאפיין MANAGEMENT_UI_SSO_CSRF_SECRET בקובץ התצורה לסוד של CSRF.
    • מגדירים את Edge כך שישתמש באחד מהממשקים הבאים (ממשק המשתמש החדש של Edge מחייב IdP חיצוני):
      • SAML
      • LDAP

      מידע נוסף זמין במאמר סקירה כללית על אימות ספקי זהות (IdPs) חיצוניים.

  6. יש להגדיר את ספק הזהויות החיצוני עם המשתמשים שברצונך לאפשר להם גישה לממשק המשתמש של Edge. מידע נוסף זמין במאמר איך רושמים משתמשים חדשים ב-Edge.
  7. בצומת החדש, מבצעים את הפקודה הבאה: 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    כלי השירות apigee-setup מתקין את ממשק המשתמש הקלאסי. מעל ממשק המשתמש הקלאסי, מנהל ההתקנה מתקין את ממשק המשתמש של Edge.

  8. מתחברים לממשק המשתמש של Edge על ידי פתיחת כתובת ה-URL הבאה בדפדפן: 
    http://new_edge_UI_IP:3001

    כאשר new_edge_UI_IP הוא כתובת ה-IP של הצומת שבו מתארח ממשק המשתמש החדש של Edge.

    Edge מבקש מכם את פרטי הכניסה החיצוניים ל-IdP.

  9. מזינים את פרטי הכניסה.

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

    אם ממשק המשתמש של Edge לא מוצג, צריך לוודא שיציאה 3001 פתוחה לחיבורים חיצוניים.

הסרת ממשק המשתמש החדש

כדי להסיר את ממשק המשתמש החדש מהצומת שלו, צריך להסיר את ממשק המשתמש החדש של Edge ואת ממשק המשתמש הבסיסי של הגרסה הקלאסית (shoehar) שהותקנו בצומת במהלך ההתקנה של ממשק המשתמש.

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

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

כדי להסיר את הגרסה הקלאסית של ממשק המשתמש (shoehan):

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

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

  1. מפסיקים את ההפעלה של כל שירותי Edge במחשב: 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. מנקים את המטמון של טעים: 
    sudo yum clean all
  3. מסירים את כל ההכנסה לאלף צפיות ב-Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. מסירים את ספריית הבסיס להתקנה: 
    sudo rm -rf /opt/apigee