本文說明如何安裝 Apigee Edge for Private Cloud 的 Edge UI。Edge UI 是新一代的 Edge UI。
必要條件
如要在 Apigee Edge for Private Cloud 安裝中試用新版 Edge UI,您必須:
- 在專屬節點上安裝 Edge UI。您無法將其安裝在包含其他 Edge 元件的節點上,包括現有傳統版 UI 所在的節點。否則使用者將無法登入傳統版 UI。
Edge UI 的節點必須符合下列需求:
- JAVA 1.8
- 4 GB RAM
- 2 核心
- 60 GB 磁碟空間
- 您必須先在節點上安裝 4.19.06 版的
apigee-setup公用程式,如「安裝 Edge apigee-setup 公用程式」一文所述。 - 通訊埠 3001 必須開啟。這是向 Edge UI 提出要求時使用的預設通訊埠。如果您使用「新版 UE 設定檔」一節所述的屬性變更通訊埠,請務必開啟該通訊埠。
- 在 Edge 上啟用外部 IDP。Edge UI 支援 SAML 或 LDAP 做為驗證機制。
- (僅限 SAML IDP) Edge UI 僅支援 TLS 1.2 版。由於您是透過 TLS 連線至 SAML IDP,因此如果您使用 SAML,IDP 必須支援 TLS 1.2 版。
如要進一步瞭解 Edge UI,請參閱「Private Cloud 的新版 Edge UI」。
安裝總覽
概略來說,安裝 Apigee Edge for Private Cloud 的 Edge UI 流程如下:
- 在叢集中新增節點
- 登入新節點
- 下載
apigee-setup公用程式 - 建立設定檔並修改設定
- 執行
apigee-setup公用程式 - 登入並測試新版使用者體驗
在新節點上執行時,apigee-setup 公用程式會:
- 安裝基本傳統版 UI (稱為 shoehorn),並設定傳統版 UI 使用外部 IDP 向 Edge 進行驗證。
- 安裝新的 Edge UI,並設定 Edge UI 使用外部 IDP 向 Edge 進行驗證。
安裝新版 Edge UI 前的注意事項
如上述必要條件所述,Edge UI 要求您在 Edge 上啟用外部 IDP。也就是說,使用者驗證是由 IDP 控制,您可以在 IDP 中設定使用電子郵件地址做為使用者 ID。因此,所有 Edge UI 使用者都必須在 IDP 中註冊。
傳統版 UI 是您透過 Apigee Edge for Private Cloud 安裝的預設 UI,不需要外部 IDP。可使用 IDP 或基本驗證。也就是說,您可以:
- 在 Edge、傳統版 UI 和 Edge UI 上啟用外部 IDP 支援。
在這個情境中,所有傳統版 UI 和 Edge UI 使用者都會在 IDP 中註冊。如要瞭解如何在 IDP 中新增使用者,請參閱「註冊新的 Edge 使用者」。
- 在 Edge 上啟用外部 IDP 支援,但保留基本驗證功能。Edge UI 會使用 IDP,傳統版 UI 則仍使用基本驗證。
在這個情境中,所有傳統版 UI 使用者都會使用基本驗證憑證登入,而憑證會儲存在 Edge OpenLDAP 資料庫中。Edge UI 使用者會在 IDP 中註冊,並使用 SAML 或 LDAP 登入。
不過,您必須先按照「註冊新的 Edge 使用者」一節所述,將傳統版 UI 使用者新增至 IDP,該使用者才能登入 Edge UI。
與先前版本相比的安裝設定變更
請注意,Edge UI Beta 版的安裝程序有下列異動。
新版 Edge UI 設定檔
下列設定檔包含安裝及設定新版 Edge UI 所需的所有資訊。您可以使用相同的設定檔,安裝及設定 Shoehorn/傳統版 UI 和 Edge UI。
# IP of the Edge Management Server. # This node also hosts the Apigee SSO module and the current, or Classic, UI. IP1=management_server_IP # IP of the Edge UI node. IP2=edge_UI_server_IP # Edge sys admin credentials. ADMIN_EMAIL=your@email.com APIGEE_ADMINPW=your_password # If omitted, you are prompted for it. # Edge Management Server information. APIGEE_PORT_HTTP_MS=8080 MSIP=$IP1 MS_SCHEME=http # # Edge UI configuration. # # Enable the Edge UI. EDGEUI_ENABLE_UNIFIED_UI=y # Specify IP and port for the Edge UI. # The management UI port must be open for requests to the Edge UI MANAGEMENT_UI_PORT=3001 MANAGEMENT_UI_IP=$IP2 # Set to 'OPDK' to specify a Private Cloud deployment. MANAGEMENT_UI_APP_ENV=OPDK # Disable TLS on the Edge UI. MANAGEMENT_UI_SCHEME=http # Location of Edge UI. 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=YOUR_CSRF_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 Edge UI. MANAGEMENT_UI_SSO_ENABLED=y # Only required if MANAGEMENT_UI_SSO_ENABLED is 'y' MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y MANAGEMENT_UI_SSO_CLIENT_ID=newueclient MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret # # Shoehorn UI configuration # # Set to http even if you enable TLS on the Edge UI. 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 Edge UI. # # 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 your IDP on the Classic 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 # Apigee SSO Component configuration # 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 Apigee SSO module. # If Apigee 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 Apigee SSO module. SSO_ADMIN_NAME=ssoadmin SSO_ADMIN_SECRET=your_sso_admin_secret # ## SSO Configuration (define external IDP) # # # Use one of the following configuration blocks to # # define your IDP settings: # # - SAML configuration properties # # - LDAP Direct Binding configuration properties # # - LDAP Indirect Binding configuration properties # INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect) ## SMTP Configuration (required) # SKIP_SMTP=n # Skip now and configure later by specifying "y". SMTPHOST=smtp.gmail.com SMTPUSER=your@email.com SMTPPASSWORD=your_email_password SMTPSSL=y SMTPPORT=465 # If no SSL, use a different port, such as 25. SMTPMAILFROM="My Company myco@company.com"
安裝 Edge UI
建立及修改設定檔後,您可以在該新節點上安裝新的 Edge UI。
如何安裝 Edge UI:
- 在叢集中新增節點。
- 以管理員身分登入新節點。
- 按照「安裝 Edge apigee-setup 公用程式」一文的說明,在節點上安裝 4.19.06 版的
apigee-setup公用程式。 - 執行下列指令,使用 Yum 清除所有快取資訊:
sudo yum clean all
- 按照「新版 Edge UI 設定檔」一節所述建立設定檔,並確認該檔案的擁有者是「apigee」使用者:
chown apigee:apigee configFile
請務必對設定檔進行下列編輯:
- 將設定檔中的
MANAGEMENT_UI_SSO_CSRF_SECRET屬性值變更為 CSRF 密鑰。 - 設定 Edge 使用下列其中一項 (新版 Edge UI 需要外部 IDP):
- SAML
- LDAP
詳情請參閱「外部 IdP 驗證總覽」。
- 將設定檔中的
- 為外部 IDP 設定可存取 Edge UI 的使用者。詳情請參閱「註冊新的 Edge 使用者」。
- 在新節點上執行下列指令:
/opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile
apigee-setup公用程式會安裝傳統版 UI。安裝程式會在傳統版 UI 上安裝 Edge UI。 - 在瀏覽器中開啟下列網址,登入 Edge UI:
http://new_edge_UI_IP:3001
其中 new_edge_UI_IP 是託管新版 Edge UI 的節點 IP 位址。
Edge 會提示您輸入外部 IDP 憑證。
- 輸入憑證。
新的 Edge UI 隨即顯示。如要瞭解如何使用 Edge UI,請參閱「Private Cloud 的新版 Edge UI」。
如果未顯示 Edge UI,請確認通訊埠 3001 已開放外部連線。
解除安裝傳統版 UI
如要從節點解除安裝傳統版 UI,您必須解除安裝新的 Edge UI,以及在 UI 安裝程序期間安裝在節點上的基本傳統版 UI (shoehorn)。
如要解除安裝新版 Edge UI:
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui uninstall
如要解除安裝基本傳統版 UI (shoehorn):
/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall
如要從節點中移除所有 Edge 元件:
- 停止機器上執行的所有 Edge 服務:
/opt/apigee/apigee-service/bin/apigee-all stop
- 清除 yum 快取:
sudo yum clean all
- 移除所有 Apigee RPM:
sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
- 移除安裝根目錄:
sudo rm -rf /opt/apigee