安装新的 Edge 界面

本文档介绍了如何为 Apigee Edge for Private Cloud 安装 Edge 界面。Edge 界面是 Edge 的下一代界面。

前提条件

如需在 Apigee Edge for Private Cloud 安装中试用新的 Edge 界面，您必须满足以下条件：

• 在自己的节点上安装 Edge 界面。您不能将其安装在包含其他 Edge 组件的节点上，包括现有传统版界面所在的节点。 否则，用户将无法登录传统版界面。

  Edge 界面的节点必须满足以下要求：

  • JAVA 1.8
  • 4 GB RAM
  • 2 核
  • 60 GB 磁盘可用空间
  • 您必须先在节点上安装 4.50.00 版的 apigee-setup 实用程序，如安装 Edge apigee-setup 实用程序中所述。
  • 端口 3001 必须处于打开状态。这是用于向 Edge 界面发出请求的默认端口。如果您使用新的 UE 配置文件中所述的属性更改端口，请确保该端口处于打开状态。
• 在 Edge 上启用外部 IDP。Edge 界面支持使用 SAML 或 LDAP 作为身份验证机制。
• （仅限 SAML IDP）Edge 界面仅支持 TLS v1.2。由于您通过 TLS 连接到 SAML IDP，因此如果您使用 SAML，您的 IDP 必须支持 TLS v1.2。

如需详细了解 Edge 界面，请参阅 适用于 Private Cloud 的新 Edge 界面。

安装概览

概括来讲，安装适用于私有云的 Apigee Edge 的 Edge 界面的过程如下：

• 向集群添加新节点
• 登录新节点
• 下载 apigee-setup 实用程序
• 创建配置文件并使用您的设置对其进行修改
• 执行 apigee-setup 实用程序
• 登录并测试新版 UE

在新的节点上执行时，apigee-setup 实用程序会执行以下操作：

• 安装基础经典界面（称为 shoehorn），并将经典版界面配置为使用外部 IDP 进行 Edge 身份验证。
• 安装新的 Edge 界面，并配置 Edge 界面以使用您的外部 IDP 通过 Edge 进行身份验证。

安装新版 Edge 界面前的注意事项

如前面的前提条件中所述，Edge 界面要求您在 Edge 上启用外部 IDP。这意味着用户身份验证由 IDP 控制，您在其中将其配置为使用电子邮件地址作为用户 ID。因此，所有 Edge 界面用户都必须在 IdP 中注册。

经典界面（您随 Apigee Edge for Private Cloud 安装的默认界面）不需要外部 IdP。它可以使用 IDP 或基本身份验证。这意味着，您可以：

• 在 Edge 以及传统版界面和 Edge 界面上启用对外部 IDP 的支持。

  在这种情况下，所有经典版界面和 Edge 版界面用户均已在 IDP 中注册。如需了解如何向 IDP 添加新用户，请参阅注册新的 Edge 用户。

• 在 Edge 上启用外部 IDP 支持，但保留基本身份验证。Edge 界面使用 IDP，而传统界面仍使用基本身份验证。

  在此场景中，所有传统界面用户均使用基本身份验证凭据登录，其凭据存储在 Edge OpenLDAP 数据库中。Edge 界面用户在 IDP 中注册，并使用 SAML 或 LDAP 登录。

  不过，在您将该用户添加到 IDP（如注册新的 Edge 用户中所述）之前，经典界面用户将无法登录 Edge 界面。

与之前版本相比的安装配置变更

请注意，与 Edge 界面的 Beta 版相比，安装流程发生了以下变化。

MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

# Shoehorn/Classic 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

新的 Edge 界面配置文件

以下配置文件包含安装和配置新版 Edge 界面所需的所有信息。您可以使用同一配置文件安装和配置 shoehorn/传统界面和 Edge 界面。

# 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 界面

创建并修改配置文件后，您可以在该新节点上安装新的 Edge 界面。

如需安装 Edge 界面，请执行以下操作：

1. 向集群添加新节点。
2. 以管理员身份登录新节点。
3. 在节点上安装 4.50.00 版 apigee-setup 实用程序，如安装 Edge apigee-setup 实用程序中所述。
4. 执行以下命令，使用 Yum 清除所有缓存信息：

   sudo yum clean all

5. 按照新的 Edge 界面配置文件中所述创建配置文件，并确保该文件归“apigee”用户所有：

   chown apigee:apigee configFile

   请务必对配置文件进行以下修改：

   • 将配置文件中 MANAGEMENT_UI_SSO_CSRF_SECRET 属性的值更改为您的 CSRF 密钥。
   • 将 Edge 配置为使用以下任一选项（新版 Edge 界面需要外部 IDP）：
     • SAML
     • LDAP

     如需了解详情，请参阅外部 IDP 身份验证概览。

6. 为您希望有权访问 Edge 界面的用户配置外部 IDP。如需了解详情，请参阅注册新的 Edge 用户。
7. 在新节点上，执行以下命令：

   /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

   apigee-setup 实用程序会安装传统界面。然后，安装程序会在经典版界面之上安装 Edge 界面。

8. 在浏览器中打开以下网址，登录 Edge 界面：

   http://new_edge_UI_IP:3001

   其中，new_edge_UI_IP 是托管新 Edge 界面的节点的 IP 地址。

   Edge 会提示您输入外部 IDP 凭据。

9. 输入您的凭据。

   新的 Edge 界面随即会显示。如需了解如何使用 Edge 界面，请参阅适用于私有云的新版 Edge 界面。

   如果 Edge 界面未显示，请确保端口 3001 已打开以供外部连接。

卸载新版界面

如需从节点中卸载新版界面，您必须同时卸载新版 Edge 界面和在界面安装过程中安装在节点上的旧版经典界面（鞋拔）。

如需卸载新版 Edge 界面，请执行以下操作：

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

如需卸载基本经典版界面（鞋拔），请执行以下操作：

/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