安装新版 Edge 体验

适用于私有云的 Edge v4.19.01

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

如需在用于 Private Cloud 的 Edge 中试用全新 Edge 体验，您必须：

  • 在 Edge 上启用 SAML。新版 Edge 仅支持使用 SAML 进行身份验证 机制。
  • 在其专属节点上安装新版 Edge。您不能将其安装在 包含其他 Edge 组件，包括现有 Edge 界面所在的节点。 这样做会导致用户无法登录传统版 Edge 界面。

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

安装概览

如需为私有云的 Edge 安装全新 Edge 体验，请执行以下操作： 执行两个不同的安装过程：

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

安装前提条件

  • 您必须先在 Edge 上启用 SAML，然后才能安装新版 Edge。全新边缘 仅支持使用 SAML 作为身份验证机制。

    如需了解如何在 Edge 上启用 SAML，请参阅 支持在 Edge 上使用 Private Cloud 的 SAML。

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

  • 您必须在自己的节点上安装新版 Edge。您无法在节点上安装 包含其他 Edge 组件，包括现有 Edge 界面所在的节点 资源。

    节点必须满足以下要求：

    • Java 1.8
    • 4 GB RAM
    • 2 核
    • 60GB 磁盘空间
    • 您必须先在 Chrome 中安装 4.19.01 版 apigee-setup 实用程序， 如安装 Edge apigee-setup 实用程序，
    • 端口 3001 必须处于打开状态。这是用于向新版 Edge 发出请求的默认端口。 如果您使用下述属性更改端口，请确保该端口处于开放状态。

安装新版 Edge 体验

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

Edge 经典版界面是您使用适用于私有云的 Edge 安装的默认界面，它不会 要求 SAML。它可以使用 SAML 或基本身份验证。这意味着您可以执行以下任一操作：

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

    在这种情况下，所有传统版界面和新版 Edge 体验用户都是通过 SAML IDP 注册的。 如需了解如何向 SAML IDP 添加新用户，请参阅 注册新的 Edge 用户。

  • 在 Edge 上启用 SAML 支持，但启用基本身份验证。新版 Edge 体验使用 SAML 和传统版界面仍然使用基本身份验证。

    在这种情况下，所有传统版界面用户都使用基本身份验证凭据登录，其中 其凭据会存储在 Edge OpenLDAP 数据库中。使用全新 Edge 体验的用户 在 SAML IDP 中注册，并使用 SAML 登录。

    但是，传统版界面用户在您添加新版 Edge 之前无法登录新版 Edge 用户登录 SAML IDP（如注册新 Edge 中所述） 用户。

先前版本中的安装配置变更

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

从 Edge 4.18.05 开始的安装配置更改

Edge 4.19.01 版的新 Edge 体验包含以下对 配置文件：

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

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

从 Edge 4.18.01 开始的安装配置更改

Edge 4.19.01 版的新 Edge 体验包含以下对 配置文件：

更改类型 受影响的房源
已添加 
# 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 体验。

示例配置文件如下所示：

# 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 基础界面 (shoehorn)

您必须先安装 Edge 基础界面（名为 shoehorn），然后才能安装新版界面 边缘体验。

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

  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 界面： 
    /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 体验

如需安装新版 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 是托管节点的 IP 地址 全新 Edge 体验。系统会提示您输入 SAML 凭据。输入您的 凭据，则会显示新版 Edge。

  6. 请参阅新 “面向私有云的边缘体验”了解详情，其中包括 有关使用新 Edge 体验的信息。

卸载新版 Edge

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

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

如需卸载 Edge 基础界面 (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