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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

# Shoehorn/Classic 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

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

   sudo yum clean all

5. יוצרים את קובץ התצורה כמו שמתואר במאמר קובץ תצורה חדש של Edge UI ומוודאים שהבעלים שלו הוא המשתמש apigee:

   chown apigee:apigee configFile

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

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

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

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 ל-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