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

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

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

כדי לנסות את ממשק המשתמש החדש של Edge בהתקנה של Apigee Edge for Private Cloud, צריך:

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

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

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

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

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

באופן כללי, תהליך ההתקנה של ממשק המשתמש של Edge ל-Apigee Edge for Private Cloud הוא:

  • הוספת צומת חדש לאשכול
  • מתחברים לצומת החדש.
  • הורדת הכלי apigee-setup
  • יצירת קובץ תצורה ושינוי שלו באמצעות ההגדרות שלכם
  • מריצים את הכלי apigee-setup
  • Log in and test to new UE

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

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

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

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

ממשק המשתמש הקלאסי, ממשק המשתמש שמוגדר כברירת מחדל שהתקנתם עם Apigee Edge for Private Cloud, לא דורש IDP חיצוני. אפשר להשתמש בספק זהויות (IDP) או באימות בסיסי. זה אומר שאתם יכולים:

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

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

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

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

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

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

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

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

קובץ התצורה הבא מכיל את כל המידע שנדרש כדי להתקין ולהגדיר את ממשק המשתמש החדש של Edge. אפשר להשתמש באותו קובץ תצורה כדי להתקין ולהגדיר גם את ממשק המשתמש של shoehorn/Classic וגם את ממשק המשתמש של 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_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 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.19.06 של כלי השירות apigee-setup בצומת, כמו שמתואר במאמר התקנת כלי השירות apigee-setup של Edge.
  4. מנקים את כל המידע שנשמר במטמון באמצעות Yum, על ידי הפעלת הפקודה הבאה: 
    sudo yum clean all
  5. יוצרים את קובץ התצורה כמו שמתואר בקטע קובץ תצורה חדש של ממשק המשתמש של Edge, ומוודאים שהוא בבעלות המשתמש "apigee": 
    chown apigee:apigee configFile

    חשוב לבצע את השינויים הבאים בקובץ התצורה:

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

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

  6. מגדירים ב-IDP החיצוני את המשתמשים שרוצים לתת להם גישה לממשק המשתמש של 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 ל-Private Cloud.

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

הסרת הממשק הקלאסי

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

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

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

כדי להסיר את ממשק המשתמש הקלאסי הבסיסי (shoehorn):

/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. מסירים את כל חבילות ה-RPM של Apigee: 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. מסירים את תיקיית השורש של ההתקנה: 
    sudo rm -rf /opt/apigee