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

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

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

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

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

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

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

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

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

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

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

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

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

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

כפי שמתואר בדרישות המוקדמות, ממשק המשתמש של Edge מחייב להפעיל IdP חיצוני ב-Edge. המשמעות היא שאימות המשתמשים נשלט על ידי ה-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. אפשר להשתמש באותו קובץ תצורה כדי להתקין ולהגדיר את ממשק המשתמש הקלאסי של shoehoe/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.52.01 של כלי השירות apigee-setup בצומת, כפי שמתואר ב-התקנת כלי השירות של Edge להגדרת apigee.
  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 לענן פרטי.

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

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

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

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

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

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

/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