安裝新的 Edge 體驗 (Beta 版)

Edge for Private Cloud 4.18.01 版

本文說明如何安裝 Edge for 私有雲 的新版 Edge 介面 Beta 版。新版 Edge 介面是新一代的 Edge UI。

如要在 Edge for Private Cloud 安裝中試用新版 Edge 介面,您必須:

  • 在 Edge 上啟用 SAML。新版 Edge 介面僅支援 SAML 做為驗證機制。
  • 在新版 Edge 介面專屬的節點上安裝該介面。您無法將其安裝在包含其他 Edge 元件的節點上。

如要進一步瞭解新版 Edge 介面,請參閱「Private Cloud 的新版 Edge 介面」。

安裝總覽

如要安裝 Edge for 私有雲 的新版 Edge 介面 Beta 版,請執行下列兩項不同的安裝程序:

  • 安裝基本 Edge UI (稱為 shoehorn),並設定基本 Edge UI,以便使用 SAML 向 Edge 進行驗證。
  • 安裝新版 Edge 介面,並設定新版 Edge 介面,以便使用 SAML 向 Edge 進行驗證。安裝新版 Edge 介面後,您就可以登入並使用 Edge。

安裝的必要條件

  • 您必須先在 Edge 上啟用 SAML,才能安裝新版 Edge 介面。新版 Edge 介面僅支援 SAML 做為驗證機制。

    注意:在非正式環境中,您可以讓 Edge 保持啟用基本驗證,這樣傳統版 UI 和 Edge API 的使用者仍可使用基本驗證。

    如要瞭解如何在 Edge 啟用 SAML,請參閱「在 Edge for Private Cloud 支援 SAML」。
  • 您必須在專屬節點上安裝新版 Edge 介面。您無法將其安裝在包含其他 Edge 元件的節點上。節點必須符合下列條件:

安裝新版 Edge 介面前的注意事項

如上述必要條件所述,您必須在 Edge 上啟用 SAML,才能使用新版 Edge 介面。也就是說,使用者驗證是由 SAML IDP 控制,您必須設定 SAML IDP,將電子郵件地址做為使用者 ID。因此,所有新版 Edge 介面使用者都必須在 SAML IDP 中註冊。

Edge 傳統版 UI 是您透過 Edge for 私有雲 安裝的預設 UI,不需要 SAML。可使用 SAML 或基本驗證。也就是說,您可以:

  • 在 Edge、傳統版 UI 和新版 Edge 介面上啟用 SAML 支援。

    在這個情境中,所有傳統版 UI 和新版 Edge 介面使用者都會在 SAML IDP 中註冊。 如要瞭解如何將新使用者新增至 SAML IDP,請參閱「註冊新的 Edge 使用者」。
  • 在 Edge 上啟用 SAML 支援,但保留基本驗證功能。新版 Edge 介面使用 SAML,傳統版 UI 則仍使用基本驗證。

    在這種情況下,所有傳統版 UI 使用者都會使用基本驗證憑證登入,而憑證會儲存在 Edge OpenLDAP 資料庫中。新版 Edge 介面使用者會在 SAML IDP 中註冊,並使用 SAML 登入。

    不過,您必須先按照「註冊新的 Edge 使用者」一節所述,將傳統版 UI 使用者新增至 SAML IDP,該使用者才能登入新版 Edge 介面。

安裝設定檔

設定檔包含安裝及設定新版 Edge 介面所需的所有資訊。您可以使用相同的設定檔,安裝及設定基本 UI 和新版 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 UI (shoehorn)

您必須先安裝名為 shoehorn 的基本 Edge UI,才能安裝新版 Edge 介面。

如要安裝基本 UI,請按照下列步驟操作:

  1. 按照「安裝 Edge apigee-setup 公用程式」一文的說明,在節點上安裝 4.18.01 版的 apigee-setup 公用程式。
  2. Clean Yum:
    > sudo yum clean all
  3. 按照上述方式建立設定檔,並確認該檔案的擁有者為「apigee」使用者:
    > chown apigee:apigee configFile

    其中 configFile 是上述「安裝設定檔」一節所述的設定檔。

  4. 安裝 Shoehorn 版本的 Edge UI:
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  5. 設定 Edge UI:
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  6. 在 Edge UI 上啟用 SAML:
    > /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

安裝新版 Edge 介面

安裝基本 Edge UI 後,即可安裝及設定新版 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. 在新版 Edge 介面中啟用 SAML:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. 在瀏覽器中開啟下列網址,登入新版 Edge 介面:
    http://newEdgeExperienceIP:3001

    其中 newEdgeExperienceIP 是託管新版 Edge 介面的節點 IP 位址。系統會提示您輸入 SAML 憑證。輸入憑證後,系統會顯示新版 Edge 介面。

  6. 詳情請參閱「私有雲的新版 Edge 介面 (Beta 版)」,包括新版 Edge 介面使用資訊的連結。

解除安裝新版 Edge 介面

如要解除安裝新版 Edge 介面,請按照下列步驟操作:

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

如要解除安裝基本 Edge UI (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. 移除所有 Apigee RPM:
    > sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-|baas)")
  4. 移除安裝根目錄:
    > sudo rm -rf /opt/apigee