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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# Enable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=https

# 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

# CSRF configuration.
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24

# Strict Transport Security configuration.
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 be deleted and a 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.00 של כלי השירות apigee-setup בצומת, כפי שמתואר במאמר התקנת apigee-setup .
  4. מנקים את כל המידע שנשמר במטמון באמצעות Yum על ידי הרצת הפקודה הבאה: 
    sudo yum clean all
  5. יוצרים את קובץ התצורה כפי שמתואר בקטע חדש קובץ התצורה של ממשק המשתמש של Edge ולוודא שהוא נמצא בבעלות ה-apigee user: 
    chown apigee:apigee configFile

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

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

      למידע נוסף, ראו סקירה כללית על IdP חיצוני אימות.

  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 וגם ממשק משתמש קלאסי בסיסי (shoehooורן) שהותקן בצומת במהלך ההתקנה של ממשק המשתמש תהליך האימות.

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

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

כדי להסיר את ההתקנה של ממשק המשתמש הקלאסי הבסיסי (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