安裝新版 Edge 體驗

Private Cloud v4.19.01 版

本文說明如何安裝 Edge 的新版 Edge 服務 管理私有雲全新 Edge 體驗是新一代的 Edge UI。

如要試用 Edge for Private Cloud 中的 New Edge 服務,您必須:

  • 在 Edge 上啟用 SAML。新版邊緣服務僅支援 SAML 驗證 以注意力機制為基礎
  • 在專屬的節點中安裝 New Edge 體驗。您無法在 包含其他 Edge 元件,包括現有 Edge UI 所在的節點。 這會導致使用者無法登入傳統版 Edge UI。

如要進一步瞭解 New Edge 體驗,請參閱 全新邊緣體驗 私有雲

安裝總覽

如要為 Private Cloud 安裝全新的 Edge 服務,您必須 會執行兩種不同的安裝程序:

  • 安裝基本 Edge UI (名為 shoehorn),然後設定基本 UI 用於使用 SAML 透過 Edge 進行驗證的 Edge UI。
  • 安裝新版 Edge 服務,然後將 New Edge 體驗設為 使用 SAML 向 Edge 進行驗證安裝新版 Edge 服務後 以便與 Edge 搭配使用

安裝的必要條件

  • 您必須先在 Edge 上啟用 SAML,才能安裝新版 Edge 服務。全新邊緣 體驗僅支援 SAML 做為驗證機制

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

  • 新版邊緣服務僅支援 TLS 1.2 版,因為您是透過傳輸層安全標準 (TLS) 連線至 SAML IDP, 因此,您的 SAML IDP 必須支援 TLS 1.2 版。
  • 您必須在本身的節點上安裝新版 Edge 服務。無法安裝在節點上 ,其中包含其他 Edge 元件,包括現有 Edge UI 所在的節點 存放。

    節點必須符合下列需求條件:

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

安裝新版 邊緣體驗

如上述先決條件所述,如要使用新版 Edge 服務,您必須啟用 SAML, 在 Edge 上也就是說,使用者驗證是由 SAML IDP 控管,您在設定 SAML 時 IDP:使用電子郵件地址做為使用者 ID。因此,所有 New Edge 體驗的使用者都必須處於部署狀態 向 SAML IDP 註冊。

Edge 傳統版 UI (您使用 Edge for Private Cloud 安裝的預設 UI) 不會 需要 SAML。可使用 SAML 或基本驗證。也就是說,您可以:

  • 在 Edge 上以及傳統版 UI 和 New Edge 服務上啟用 SAML 支援。

    在這種情況下,所有傳統版 UI 和 New Edge 服務的使用者都會向 SAML IDP 註冊。 如要瞭解如何將使用者新增至 SAML IDP,請參閱 註冊新的 Edge 使用者

  • 在 Edge 上啟用 SAML 支援,但保持啟用基本驗證。新版 Edge 體驗 SAML 和傳統版 UI 仍會使用基本驗證。

    在此情況下,所有傳統版 UI 使用者都會以基本驗證憑證登入,其中 都會將憑證儲存在 Edge OpenLDAP 資料庫中。新 Edge 體驗的使用者 。

    但是您必須新增傳統版 UI 使用者,才能登入新版 Edge 服務 使用者登入 SAML IDP,如註冊新的邊緣 使用者

先前版本的安裝設定變更

請注意,全新 Edge 測試版的安裝程序有以下變動。

來自 Edge 4.18.05 的安裝設定變更

「新邊緣」體驗的 Edge 4.19.01 版包含下列變更 的設定檔:

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

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

已新增 您現在可以使用屬性來啟用新版 Edge 服務的傳輸層安全標準 (TLS)。 詳情請參閱為新版 Edge 服務設定 TLS

來自 Edge 4.18.01 的安裝設定變更

「新邊緣」體驗的 Edge 4.19.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

安裝設定檔

設定檔包含安裝及設定新的 邊緣體驗您可以使用同一個設定檔來安裝及設定 使用者介面和全新邊緣體驗

以下是設定檔範例:

# 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 (shoehorn)

您必須先安裝名為 shoehorn 的基本 Edge UI,才能安裝新版 邊緣體驗

如何安裝基本 UI:

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

    其中 configFile 是上述說明中的設定檔 安裝設定檔

  4. 變更設定中 MANAGEMENT_UI_SSO_CSRF_SECRET 屬性的值 檔案複製到 CSRF 密鑰中
  5. 安裝 Shoehorn 版本的 Edge UI:
    /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

安裝新版 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. 設定全新邊緣體驗:
    /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. 在瀏覽器中開啟下列網址,登入新版 Edge 服務:
    http://newEdgeExperienceIP:3001

    其中 newEdgeExperienceIP 是節點託管的 IP 位址 全新 Edge 體驗系統會提示您輸入 SAML 憑證。輸入 就會看到 New Edge 體驗。

  6. 請參閱 The New 私有雲的 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-)")
  4. 移除安裝根目錄:
    sudo rm -rf /opt/apigee