התקנת חוויית Edge החדשה (בטא)

Edge for Private Cloud גרסה 4.18.01

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

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

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

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

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

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

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

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

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

    הערה: בסביבה ללא ייצור, אפשר להשאיר את האימות הבסיסי מופעל ב-Edge, כדי שהמשתמשים בממשק המשתמש הקלאסי וב-Edge API יוכלו להמשיך להשתמש באימות בסיסי.

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

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

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

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

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

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

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

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

קובץ תצורה של התקנה

קובץ התצורה מכיל את כל המידע הנדרש להתקנה ולהגדרה של חוויית 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

# URLs for the different UIs.
# URL of classic Edge UI.
ROUTES_CLASSICUI="http://$IP1:9000"
# URL of New Edge experience.
ROUTES_SHOEHORN="http://$IP2:9000"

# New Edge experience configuration.
# Enable the New Edge experience.
EDGEUI_ENABLE_UNIFIED_UI=y
# Access port for the New Edge experience.
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_APP_ENV=OPDK
MANAGEMENT_UI_IP=$IP2
# Disable TLS on the New Edge experience.
# This release does not support TLS.
MANAGEMENT_UI_USE_HTTPS=n

# 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

# Location of New Edge experience.
MANAGEMENT_UI_PUBLIC_URIS=http://$IP2:3001
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=secret222
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=24
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS=0.5

# Edge SSO configuration.
# Some settings are for the classic UI, 
# but are still required to configure the New Edge experience.
# Enable SSO.
EDGEUI_SSO_ENABLED=y

# Information about Classic UI
EDGEUI_PUBLIC_URIS=http://$IP1:9000
# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS
# 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".
# MANAGEMENT_UI_SKIP_VERIFY=y
SSO_PUBLIC_URL_SCHEME=http
# 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 (shoern)

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

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

  1. מתקינים את גרסה 4.18.01 של כלי השירות apigee-setup בצומת כפי שמתואר במאמר התקנת כלי השירות Edge apigee-setup.
  2. נקי יאם:
    > sudo yum clean all
  3. יוצרים את קובץ התצורה כפי שמתואר למעלה ומוודאים שהוא בבעלות משתמש ה-apigee:
    > chown apigee:apigee configFile

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

  4. מתקינים את גרסת Shoehor של ממשק המשתמש של Edge:
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. מגדירים את ממשק המשתמש של Edge:
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. מפעילים 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 (shoehor):

> /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-|baas)")
  4. מסירים את ספריית הבסיס של ההתקנה:
    > sudo rm -rf /opt/apigee