安裝新版 Edge 體驗

私有雲 v4.19.01 的邊緣

本文說明如何安裝適用於 Private Cloud 的 New Edge 體驗。新版 Edge 是新一代的 Edge UI,

如要試用 Edge for Private Cloud 中的 New Edge 體驗,請務必完成下列事項:

  • 在 Edge 啟用 SAML。New Edge 服務僅支援 SAML 做為驗證機制。
  • 在自己的節點中安裝 New Edge 服務。您無法在含有其他 Edge 元件的節點 (包括現有 Edge UI 所在的節點) 上安裝該應用程式。這麼做會導致使用者無法登入傳統版 Edge UI。

如要進一步瞭解 New Edge 體驗,請參閱私有雲的新版 Edge 體驗

安裝總覽

如要安裝適用於 Private Cloud 的 New Edge 體驗,請執行以下兩種安裝程序:

  • 安裝基本 Edge UI (名為 shoehorn),並將基礎 Edge UI 設定為透過 Edge 進行驗證。
  • 安裝 New Edge 服務,並將 New Edge 服務設為使用 SAML 進行 Edge 驗證。安裝 New Edge 服務後,即可登入帳戶並用於 Edge。

安裝的必要條件

  • 您必須先啟用 Edge on Edge,才能安裝 New Edge 服務。New Edge 服務僅支援 SAML 做為驗證機制。

    如要瞭解如何啟用 Edge on Edge,請參閱「在 Edge 上支援 Private Cloud 的 SAML」。

  • 新版 Edge 服務僅支援傳輸層安全標準 (TLS) 1.2 版。由於您是透過傳輸層安全標準 (TLS) 連線至 SAML IDP,因此您的 SAML IDP 必須支援 TLS v1.2。
  • 您必須在自己的節點中安裝 New Edge 服務。您無法在含有其他 Edge 元件的節點 (包括現有 Edge UI 所在的節點) 上安裝該應用程式。

    節點必須符合下列條件:

    • JAVA 1.8
    • 4 GB RAM
    • 2 核心
    • 60 GB 磁碟空間
    • 您必須先按照安裝 Edge apigee-setup 公用程式的說明,在節點上安裝 4.19.01 版的 apigee-setup 公用程式。
    • 通訊埠 3001 必須為開啟。這是傳送至 New Edge 服務要求的預設通訊埠。如果你使用下文所述的屬性變更通訊埠,請確認通訊埠已開啟。

安裝 New Edge 服務前的注意事項

如前所述,New Edge 服務會要求您在 Edge 上啟用 SAML。這表示使用者驗證作業是由 SAML IDP 控管,您在其中將 SAML 設為將電子郵件地址設為使用者 ID。因此,所有 New Edge 服務使用者都必須在 SAML IDP 中註冊。

Edge 傳統版 UI 是您以 Edge 為私有雲安裝的預設 UI,不需要使用 SAML,可支援 SAML 或基本驗證。也就是說,您可以採取下列做法:

  • 同時在 Edge、傳統版 UI 和 New Edge 服務中啟用 SAML 支援。

    在這種情況下,所有傳統版 UI 和新版 Edge 體驗的使用者都是透過 SAML IDP 註冊。 如要瞭解如何將新使用者新增至 SAML IDP,請參閱「註冊新的 Edge 使用者」。

  • 啟用 Edge 的 SAML 支援,但保持基本驗證功能啟用。New Edge 服務會使用 SAML,而傳統版 UI 仍會使用基本驗證功能。

    在這個情境中,所有傳統版 UI 使用者都會以基本驗證憑證登入,也就是他們的憑證儲存在 Edge OpenLDAP 資料庫中。新的 Edge 體驗使用者已在 SAML IDP 中註冊,並使用 SAML 登入。

    不過,您必須先按照註冊新的 Edge 使用者一文的說明,將使用者新增至 SAML IDP,傳統版 UI 使用者才能登入 New Edge 服務。

先前版本的安裝設定變更

請注意,從 New Edge 體驗 Beta 版的安裝程序有以下異動。

Edge 4.18.05 的安裝設定變更

新版 Edge 4.19.01 版包含 Edge 4.18.05 版的設定檔有下列異動:

變更類型 受影響的房源
已移除
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

該屬性的預先定義值為 0.5 (30 分鐘),因此無法變更。

已新增 您現在可以在 New Edge 服務中使用屬性啟用傳輸層安全標準 (TLS)。 詳情請參閱「為新邊緣設定 TLS」。

Edge 4.18.01 的安裝設定變更

新版 Edge 4.19.01 版包含 Edge 4.18.01 版的設定檔有下列異動:

變更類型 受影響的房源
已新增
# 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

安裝設定檔

設定檔包含安裝及設定 New Edge 服務所需的所有資訊。您可以使用同一個設定檔安裝及設定基本 UI 和 New 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 UI (鞋子)

您必須先安裝基本 Edge UI (名為 shoehorn),才能安裝 New Edge 服務。

如何安裝基本 UI:

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

    其中 configFile 是上方安裝設定檔中所述的設定檔。

  4. 將設定檔中 MANAGEMENT_UI_SSO_CSRF_SECRET 屬性的值變更為 CSRF 密鑰。
  5. 安裝 Edge UI 的 Shoehorn 版本:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. 設定 Edge UI:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. 在 Edge UI 中啟用 SAML:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

安裝 New Edge 服務

安裝基本 Edge UI 後,即可安裝並設定 New Edge 服務。

如要安裝 New Edge 服務,請按照下列步驟操作:

  1. 安裝 New Edge 服務:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui install
  2. 變更為 edge-management-ui 目錄:
    cd /opt/apigee/edge-management-ui
  3. 設定 New Edge 服務:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui setup -f configFile

    其中 configFile 是上方安裝設定檔中所述的設定檔。

  4. 在 New Edge 服務中啟用 SAML:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui configure-sso -f configFile
  5. 在瀏覽器中開啟下列網址,以便登入 New Edge 服務:
    http://newEdgeExperienceIP:3001

    其中 newEdgeExperienceIP 是託管 New Edge 體驗的節點 IP 位址。系統會提示您輸入 SAML 憑證。輸入憑證後,畫面上會顯示 New Edge 服務。

  6. 詳情請參閱「適用於 Private Cloud 的 New Edge Experience」連結,包括使用 New Edge 服務的連結。

解除安裝 New Edge 服務

如何解除安裝新版 Edge 服務:

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

如何解除安裝基本 Edge UI (鞋子):

/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-)")
  4. 移除安裝根目錄:
    sudo rm -rf /opt/apigee