安装新版 Edge 体验

Edge for Private Cloud v4.19.01

本文档介绍了如何安装适用于私有云的 Edge 的新 Edge 体验。新版 Edge 体验是 Edge 的新一代界面。

如需在适用于私有云的 Edge 中试用新版 Edge，您必须执行以下操作：

  • 在 Edge 上启用 SAML。New Edge 体验仅支持 SAML 作为身份验证机制。
  • 在单独的节点上安装 New Edge 体验。您不能在包含其他 Edge 组件的节点（包括现有 Edge 界面所在的节点）上安装该节点。这会导致用户无法登录传统版 Edge 界面。

如需详细了解新边缘体验，请参阅私有云的新边缘体验。

安装概览

如需为私有云安装适用于 Edge 的新 Edge 体验，您需要执行两种不同的安装过程：

  • 安装基础 Edge 界面（名为 shoeshorn），并将基础 Edge 界面配置为使用 SAML 向 Edge 进行身份验证。
  • 安装新版 Edge 体验，并将新版 Edge 体验配置为使用 SAML 向 Edge 进行身份验证。安装新版 Edge 体验后，您可以登录和使用新版 Edge。

安装前提条件

  • 您必须先启用 Edge on SAML，然后才能安装新版 Edge。全新 Edge 体验仅支持 SAML 作为其身份验证机制。

    如需了解如何在 Edge 上启用 SAML，请参阅在 Edge 上为私有云支持 SAML。

  • 全新 Edge 体验仅支持 TLS v1.2。由于您通过 TLS 连接到 SAML IDP，因此您的 SAML IDP 必须支持 TLS v1.2。

  • 您必须在自己的节点上安装 New Edge 体验。您不能在包含其他 Edge 组件的节点（包括现有 Edge 界面所在的节点）上安装该节点。

    节点必须满足以下要求：

    • JAVA 1.8
    • 4 GB RAM
    • 2 核
    • 60GB 磁盘可用空间
    • 您必须先在节点上安装 4.19.01 版本的 apigee-setup 实用程序，如安装 Edge apigee-setup 实用程序中所述。
    • 端口 3001 必须处于打开状态。这是用于请求 New Edge 体验的默认端口。 如果您使用下述属性更改端口，请确保该端口处于打开状态。

安装新版 Edge 体验前的注意事项

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

Edge 传统版界面是您使用 Edge for Private Cloud 安装的默认界面，不需要 SAML。它可以使用 SAML 或基本身份验证。也就是说，您可以：

  • 在 Edge 上、传统版界面和新版 Edge 体验中启用 SAML 支持。

    在这种情况下，所有采用传统版界面和新版边缘体验的用户都会在 SAML IdP 中注册。如需了解如何向 SAML IdP 添加新用户，请参阅注册新的 Edge 用户。

  • 在 Edge 上启用 SAML 支持，但让基本身份验证保持启用状态。新版 Edge 体验使用 SAML，而传统版界面仍使用基本身份验证。

    在这种情况下，所有传统界面用户使用登录凭据（其中凭据会存储在 Edge OpenLDAP 数据库中）登录。全新 Edge 体验用户已在 SAML IdP 中注册，并使用 SAML 登录。

    但是，除非您将用户添加到 SAML IDP 中（如注册新的 Edge 用户中所述），否则该用户无法登录新版 Edge。

与先前版本相比的安装配置更改

请注意新版 Edge 体验 Beta 版的安装流程发生的以下变化。

Edge 4.18.05 中的安装配置变更

全新 Edge 体验的 Edge 4.19.01 版本对 Edge 4.18.05 版本的配置文件进行了以下更改：

更改类型 受影响的房源
已移除 
MANAGEMENT_UI_SSO_PUBLIC_KEY_CACHE_HOURS

该属性的预定义值为 0.5（30 分钟），无法更改。
添加了内容 您现在可以使用属性在新版 Edge 体验中启用 TLS。如需了解详情，请参阅为新边缘体验配置 TLS。

Edge 4.18.01 中的安装配置变更

全新 Edge 体验的 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

安装配置文件

配置文件包含安装和配置新版 Edge 体验所需的所有信息。您可以使用同一配置文件来安装和配置基本界面和 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_REGISTERD_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 界面 (horhorn)

您必须先安装名为 Edgehorn 的基本界面，然后才能安装新版 Edge 体验。

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

  1. 按照安装 Edge apigee-setup 实用程序中的说明，在节点上安装 4.19.01 版本的 apigee-setup 实用程序。
  2. 干 Yum： 
    sudo yum clean all
  3. 按照上述说明创建配置文件，并确保该文件归“apigee”用户所有： 
    chown apigee:apigee configFile

    其中 configFile 是上述安装配置文件中所述的配置文件。

  4. 将配置文件中 MANAGEMENT_UI_SSO_CSRF_SECRET 属性的值更改为 CSRF Secret。
  5. 安装 Edge 界面的 Shoehorn 版本： 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui install
  6. 配置 Edge 界面： 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui setup -f configFile
  7. 在 Edge 界面中启用 SAML： 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-sso -f configFile

安装新版 Edge 体验

安装基准边缘界面后，您可以安装和配置新版 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 凭据。输入凭据后，系统会显示“全新边缘体验”。

  6. 如需了解详情，请参阅新的私有云边缘体验，其中包括有关如何使用新边缘体验的信息的链接。

卸载新版 Edge

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

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

如需卸载基本 Edge 界面 (watchhorn)，请执行以下操作：

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

如需从节点中完全移除 Edge，请执行以下操作：

  1. 停止计算机上运行的所有边缘服务： 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. 清除 yum 缓存： 
    sudo yum clean all
  3. 移除所有 Apigee 每千次展示收入： 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. 移除安装根目录： 
    sudo rm -rf /opt/apigee