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

Edge for Private Cloud גרסה 4.19.01

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

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

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

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

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

כדי להתקין את הממשק החדש של Edge ב-Edge for Private Cloud, צריך לבצע שני תהליכי התקנה שונים:

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

דרישות מוקדמות להתקנה

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

    למידע על הפעלת SAML ב-Edge, קראו את המאמר תמיכה ב-SAML ב-Edge for Private Cloud.

  • הממשק החדש של Edge תומך רק ב-TLS v1.2. מכיוון שאתם מתחברים ל-SAML IDP באמצעות TLS, ה-SAML IDP צריך לתמוך ב-TLS v1.2.

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

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

    • JAVA 1.8
    • זיכרון RAM בנפח 4GB
    • 2 ליבות
    • מקום בכונן בנפח 60GB
    • קודם צריך להתקין את גרסה 4.19.01 של כלי השירות apigee-setup בצומת, כפי שמתואר במאמר התקנת כלי השירות apigee-setup של Edge.
    • יציאה 3001 צריכה להיות פתוחה. זו היציאה שמוגדרת כברירת מחדל לבקשות לממשק החדש של Edge. אם משנים את היציאה באמצעות המאפיינים שמתוארים בהמשך, צריך לוודא שהיציאה פתוחה.

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

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

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

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

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

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

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

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

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

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

שינויים בהגדרות ההתקנה מ-Edge 4.18.05

גרסה 4.19.01 של הממשק החדש של Edge כוללת את השינויים הבאים בקובץ התצורה מגרסה 4.18.05 של Edge:

סוג השינוי הנכסים המושפעים
הוסר 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

למאפיין הזה יש ערך מוגדר מראש של 0.5 (30 דקות) ואי אפשר לשנות אותו.
נוספה עכשיו אפשר להשתמש במאפיינים כדי להפעיל את TLS בממשק החדש של Edge. מידע נוסף זמין במאמר הגדרת TLS בממשק החדש של Edge.

שינויים בהגדרות ההתקנה מ-Edge 4.18.01

גרסה 4.19.01 של הממשק החדש של Edge כוללת את השינויים הבאים בקובץ התצורה מגרסה 4.18.01 של Edge:

סוג השינוי הנכסים המושפעים
נוספה 
# Shoehorn 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.

דוגמה לקובץ תצורה:

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

# IP of the New Edge experience node.
IP2=22.222.222.222

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

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

#
# New Edge experience configuration.
#

# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the New Edge experience.
MANAGEMENT_UI_SCHEME=http

# Location of New Edge experience.
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=CHANGE_TO_YOUR_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 New Edge experience.
MANAGEMENT_UI_SSO_ENABLED=y
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y
MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=secret111

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

# 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 SAML on the classic Edge 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

# Information about Edge SSO module.
# 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 Edge SSO module.
# If Edge 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 Edge SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

#
# Required SMTP information.
#

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

התקנת ממשק המשתמש הבסיסי של Edge (shoehorn)

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

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

  1. מתקינים את גרסה 4.19.01 של כלי השירות apigee-setup בצומת, כמו שמתואר במאמר התקנת כלי השירות apigee-setup של Edge.
  2. ‫Clean Yum: 
    sudo yum clean all
  3. יוצרים את קובץ התצורה כמו שמתואר למעלה ומוודאים שהוא בבעלות המשתמש "apigee": 
    chown apigee:apigee configFile

    ‫configFile הוא קובץ התצורה שמתואר למעלה בקטע קובץ תצורה להתקנה.

  4. משנים את הערך של המאפיין MANAGEMENT_UI_SSO_CSRF_SECRET בקובץ התצורה לסוד ה-CSRF.
  5. מתקינים את גרסת Shoehorn של ממשק המשתמש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. מגדירים את ממשק המשתמש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. מפעילים את SAML בממשק המשתמש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

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

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

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

  1. התקנת הממשק החדש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. עוברים לספרייה edge-management-ui: 
    cd /opt/apigee/edge-management-ui
  3. הגדרת הממשק החדש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    ‫configFile הוא קובץ התצורה שמתואר למעלה בקטע קובץ תצורה להתקנה.

  4. מפעילים את SAML בממשק החדש של Edge: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. כדי להתחבר לממשק החדש של Edge, פותחים את כתובת ה-URL הבאה בדפדפן: 
    http://newEdgeExperienceIP:3001

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

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

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

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

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

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