将传统版界面属性迁移到新版 Edge 界面

在 Apigee Edge for Private Cloud 4.54.00 中,经典版界面(edge-ui 组件)已被移除,不再可用。新版 Edge 界面(edge-management-ui 组件)是 Edge for Private Cloud 的唯一界面。

您无法在 Edge for Private Cloud 4.54.00 中使用 edge-ui。如果您通过在 /opt/apigee/customer/application/ui.properties 中设置属性来自定义经典版界面,则新版 Edge 界面不会读取该文件。更新到 4.54.00 后,您必须在 /opt/apigee/customer/application/management-ui.properties 中设置等效属性。

本页列出了为 ui.properties 记录的经典版界面属性、新版 Edge 界面的等效属性,以及新版 Edge 界面中不支持的经典版界面属性。

新版 Edge 界面使用与其他 Edge 组件相同的配置代码 (CwC) 机制。如需了解详情,请参阅 如何配置 Edge。

比较经典版界面和新版 Edge 界面的配置

新版 Edge 界面取代了经典版界面组件、属性文件、服务名称、默认端口和 TLS 证书格式。在迁移属性之前,请查看下表以更新自动化脚本、防火墙规则和 TLS 文件:

设置 经典版界面(4.53.01 及更低版本) 新版 Edge 界面 (4.54.00)
组件名称 edge-ui edge-management-ui
属性文件 /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
重启命令 apigee-service edge-ui restart apigee-service edge-management-ui restart
默认端口 9000 3001
TLS 配置 Java 密钥库 (JKS) 文件 PEM 证书和密钥文件。请参阅 为新版 Edge 界面配置 TLS。

为新版 Edge 界面设置属性

在 /opt/apigee/customer/application/management-ui.properties 中设置新版 Edge 界面配置属性,然后重启 edge-management-ui 服务,以使更改生效。

如需为新版 Edge 界面设置属性,请执行以下操作:

  1. 在编辑器中打开 management-ui.properties 文件。如果该 文件不存在,请创建它:
    vi /opt/apigee/customer/application/management-ui.properties
    
  2. 设置属性。例如:
    conf_uebe_disableGeoMap=true
  3. 保存更改。
  4. 确保该文件归 apigee 用户所有:
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
    
  5. 重启新版 Edge 界面:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart
    

为新版 Edge 界面设置属性时,请遵循以下格式规则:

  • 属性名称区分大小写。例如, conf_uebe_disableGeoMap 是有效的,但 conf_uebe_disablegeomap 无效。
  • 将字符串值用双引号括起来,例如 conf_uebe_branding_companyNameShort="My Company".
  • 请勿将布尔值(true 或 false)或 数值用引号括起来。如果布尔值或数值用 引号括起来,则新版 Edge 界面不会启动。

如需检查属性的当前值,请使用 -search 选项。例如:

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

将经典版界面属性映射到新版 Edge 界面

下表将 ui.properties中的每个受支持的经典版界面属性映射到 management-ui.properties中的等效新版 Edge 界面属性。默认 列显示了新版 Edge 界面中的默认值。

配置功能属性

将经典版界面功能标志映射到 management-ui.properties 中的相应 conf_uebe_* 属性:

经典版界面属性 新版 Edge 界面属性 默认 备注
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false 设置为 true 可隐藏地理图。在 Edge for Private Cloud 的经典版界面中,地理图默认处于停用状态。如果您尚未 启用地理位置聚合,请将此属性设置为 true。请参阅 启用地理位置 聚合和地理地图。
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false 设置为 true 可隐藏登录页面上的重置密码 链接。
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true 设置为 false 可允许日期范围超过 14 天的自定义报告。
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false 设置为 true 可允许 Trace 工具向 本地或内部 IP 地址发送请求。
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false 设置为 true 可允许从本地或内部 IP 地址导入 OpenAPI 规范。
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false 设置为 true 可允许从本地 或内部 IP 地址导入 WSDL 文件。

配置会话和 TLS 属性

将经典版界面会话超时和 TLS 属性映射到 management-ui.properties 中的等效新版 Edge 界面属性:

经典版界面属性 新版 Edge 界面属性 默认 备注
conf_application_session.maxage conf_uebe_authsessiontimeout 12(小时) 用户会话在登录后过期的时长。指定小时数(例如 12 或 0.5)或以 h(小时)或 m(分钟)为单位的时长(例如 24h 或 90m)。值 12 和 12h 是等效的。不支持 d (天)单位;例如,将 1d 替换为 24h。如果该值无效,系统会使用 12 小时的默认值,并且不会报告任何错误。 适用于使用基本 身份验证的会话。
conf_application_session.secure 无需 不适用 当 TLS 处于启用状态 (conf_uebe_usehttps=true) 或 TLS 在负载均衡器上终止 (conf_uebe_tlsoffload=true) 时,新版 Edge 界面会自动为会话 Cookie 设置 Secure 标志。
conf/application.conf+trustxforwarded conf_uebe_usehttps=true 和 conf_uebe_tlsoffload=true false 当 TLS 在负载均衡器上终止时,请同时设置这两个属性。负载均衡器必须通过 HTTP 将请求转发到新版 Edge 界面,并设置 X-Forwarded-Proto 标头。当 MANAGEMENT_UI_SCHEME=https 和 MANAGEMENT_UI_TLS_OFFLOAD=y 时,configure-ssl 命令会设置这些属性。请参阅 为新版 Edge 界面配置 TLS。
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false 仅当管理服务器使用自签名证书时,才设置为 true。请参阅 为 管理 API 配置 TLS。

配置电子邮件属性和模板

将经典版界面电子邮件发件人、主题、品牌、主机网址和链接过期属性映射到新版 Edge 界面:

经典版界面属性 新版 Edge 界面属性 默认 备注
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com>,或安装时指定的 SMTPMAILFROM 的值 未更改。
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request 请注意驼峰式大小写的 passwordReset 属性段。
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} 请注意驼峰式大小写的 userAddedExisting 属性段。
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} 请注意驼峰式大小写的 userAddedNew 属性段。
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee 设置电子邮件主题和模板中 {companyNameShort} 占位符的值。
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl 无 未更改。如果未设置,重设密码链接将使用安装时指定的新版 Edge 界面的网址,而用户邀请链接将使用请求的主机名。如果用户通过负载均衡器或 DNS 名称访问新版 Edge 界面,请设置此属性,例如 conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com".
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 适用于重设密码链接和用户邀请链接。

新版 Edge 界面使用内置电子邮件模板。如需使用为经典版界面自定义的模板,请执行以下操作:

  1. 创建 /opt/apigee/edge-management-ui/email-templates 目录。
  2. 将自定义的 password-reset.html、 user-added-existing.html 和 user-added-new.html 文件从更新前创建的备份目录(例如 /opt/apigee/customer/backup/)复制到 /opt/apigee/edge-management-ui/email-templates。模板 文件名和占位符与经典版界面中的相同。
  3. 确保该目录和文件归 apigee 用户所有。
  4. 重启新版 Edge 界面。

如需了解详情,请参阅 自定义 Edge 电子邮件 模板。

配置自动生成的密码属性

将经典版界面自动生成的密码属性映射到新版 Edge 界面:

经典版界面属性 新版 Edge 界面属性 默认
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

配置管理服务器连接和共享密钥属性

将经典版界面管理服务器连接、凭据和应用密钥属性映射到新版 Edge 界面:

经典版界面属性 新版 Edge 界面属性 备注
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl Management API 的网址,例如 https://FQ_domain_name:port/v1。此 属性名称不以conf_开头。如果管理服务器使用自签名证书,请同时设置conf_uebe_skipverify=true。
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential 加密的系统管理员凭据。您必须使用 ./bin/management-ui --encrypt 为新版 Edge 界面重新加密凭据;请参阅 不同系统管理员凭据所需的配置。
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential 加密的 SMTP 凭据。
conf_application_application.secret conf_uebe_applicationsecret 用于加密凭据和会话 Cookie 的密钥。在安装时生成。

移除无需操作的经典版界面属性

以下经典版界面属性在新版 Edge 界面中没有等效属性,因为该行为始终处于启用状态。请勿在 management-ui.properties 中添加这些属性(并从任何自动化配置脚本中移除它们):

经典版界面属性 新版 Edge 界面中的行为
conf_apigee_apigee.feature.expireSessionCookiesInternally 系统始终在服务器上验证会话过期时间。
conf_apigee_apigee.feature.trackSessionCookies 会话信息始终存储在服务器内存中。如果您在负载均衡器后使用 新版 Edge 界面的多个实例,请将负载均衡器配置为使用粘性会话。

移除不受支持的经典版界面属性

以下经典版界面属性不受支持,在新版 Edge 界面中没有等效属性。请勿在 management-ui.properties 中添加这些属性(并从任何自动化配置脚本中移除它们):

经典版界面属性 说明
conf_apigee_apigee.feature.apitimeout, 、conf_apigee_play.ws.timeout.idle, 、conf_apigee_play.ws.timeout.connection 在新版 Edge 界面中,Management API 调用的超时时间不可配置。
conf_application_http.proxyhost、 conf_application_http.proxyport、 conf_application_http.proxyuser、 conf_application_http.proxypassword 新版 Edge 界面不支持 Trace 工具 请求。
conf_apigee-base_apigee.feature.enableconsentbanner, 、conf_apigee-base_apigee.consentbanner.buttoncaption, 、conf_apigee-base_apigee.consentbanner.body 新版 Edge 界面不支持意见征求横幅。
conf_apigee-base_apigee.feature.apiproxypaginationenabled、 conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize 在新版 Edge 界面中,API 代理列表始终按页面加载。页面大小不可配置。
conf_logger_settings_application_log_level, 、conf_logger_settings_play_log_level, 、conf_application_logger.application 在新版 Edge 界面中,日志级别不可配置。日志文件会 写入 /opt/apigee/var/log/edge-management-ui。
bin_setenv_min_mem、bin_setenv_max_mem、bin_setenv_meta_space_size、bin_setenv_ext_jvm_opts 新版 Edge 界面不在 Java 虚拟机中运行。Java 内存 设置不适用。

查看迁移示例

以下示例比较了经典版界面的 ui.properties 文件 与新版 Edge 界面的等效 management-ui.properties 文件。

经典版界面,/opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

新版 Edge 界面,/opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

请注意,布尔值 true 未用引号括起来,并且会话超时时间 1d 已替换为 24。

保存文件后,重启新版 Edge 界面:

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

摘要核对清单

使用以下核对清单完成到 Apigee Edge for Private Cloud 4.54.00 中的新版 Edge 界面的迁移:

  1. 在升级之前,备份 /opt/apigee/customer/application/ui.properties 和 /opt/apigee/edge-ui/email-templates 中的任何自定义电子邮件模板。
  2. 添加映射的属性 /opt/apigee/customer/application/management-ui.properties ,无需引用布尔值或数值,并省略 不受支持的经典版界面属性。
  3. 将自定义的电子邮件模板从您的 备份目录复制到 /opt/apigee/edge-management-ui/email-templates。
  4. 如果您设置了 conf_uebe_mgmtCredential ,请使用 ./bin/management-ui --encrypt 重新加密系统管理员凭据。
  5. 将文件所有权设置为 apigee:apigee 并重启 edge-management-ui。