如何配置 Edge

适用于私有云的 Edge v4.18.05

如需在安装后配置 Edge，请使用 .properties 文件组合 和 Edge 实用程序。例如，如需在 Edge 界面上配置 TLS/SSL，您需要修改 .properties 文件来设置必要的属性。更改为 .properties 文件要求您重启受影响的 Edge 组件。

Apigee 将 .properties 文件修改为使用 配置。从本质上讲，包含 config 的代码是一个基于 .properties 文件。在带有 config 的代码中，这些键称为 tokens。因此，如需配置 Edge，请在 .properties 中设置令牌 文件。

包含配置的代码可让 Edge 组件设置 产品，允许安装团队根据安装拓扑覆盖这些设置， 然后让客户替换他们选择的任何属性。

如果您将其看作一个层级结构，那么系统会按照以下方式对客户设置进行设置 将具有最高优先级的设置覆盖安装程序团队的任何设置，或 Apigee：

  1. 客户
  2. 安装程序
  3. Apigee

如何使用 .properties 文件

作为客户，您只能修改.properties /opt/apigee/customer/application 目录中。每个组件都有自己的 .properties 文件。例如：router.properties 和 management-server.properties。

例如，如需创建 .properties 文件，请使用以下代码：

  1. 以任何用户身份在编辑器中创建该文件。
  2. 使用 chown 将文件的所有者更改为“apigee:apigee”或者，如果您更改了 从“apigee”运行 Edge 服务的用户对文件执行 chown 操作 正在运行 Edge 服务。

如需设置组件的属性，请修改相应 .properties 文件以进行设置 令牌，然后重启组件：

/opt/apigee/apigee-service/bin/apigee-service component restart

例如，修改 router.properties 后，重启路由器：

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

升级 Edge 时，.properties文件 /opt/apigee/customer/application 目录。这意味着升级 并保留您在组件上设置的所有属性。

.properties 文件的位置

Edge 的 .properties 文件有三个顶级目录 组件：安装、所有者和客户。默认位置如下所示 表：

所有者 默认令牌根目录
组件 
/opt/apigee/component_name/conf

其中，component_name 标识组件。可能的值 包括：

  • apigee-cassandra（卡桑德拉）
  • apigee-openldap（打开 LDAP）
  • apigee-postgresql（PostgreSQL 数据库）
  • apigee-qpidd（Qpidd）
  • apigee-sso（边缘单点登录）
  • apigee-zookeeper (ZooKeeper)
  • edge-management-server（管理服务器）
  • edge-management-ui（新版 Edge 界面）
  • edge-message-processor（消息处理器）
  • edge-postgres-server（Postgres 服务器）
  • edge-qpid-server (Qpid Server)
  • edge-router（边缘路由器）
  • edge-ui（传统版界面）
安装 
/opt/apigee/token
客户 
/opt/apigee/customer

确定令牌的当前值

在 .properties 文件中为组件设置令牌之前， 您可以首先使用以下命令确定其当前值：

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

其中，component_name 是组件的名称， token 是要检查的令牌。

此命令会搜索 .properties 文件的层次结构，以确定 令牌的当前值。

例如，如需查看 conf_http_HTTPRequest.line.limit 的当前值， 令牌：

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

您会在表单中看到输出：

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

在 .properties 文件中设置令牌

如需替换令牌的值，请执行以下操作：

  1. 修改组件的 .properties 文件以设置令牌值。如果文件 不存在，则创建一个。
  2. 重启组件。
  3. 检查令牌值。

例如，如需设置边缘路由器的请求行限制，请使用以下命令：

  1. 修改 /opt/apigee/customer/application/router.properties 文件以设置 conf_http_HTTPRequest.line.limit 令牌： 
    conf_http_HTTPRequest.line.limit=8k
  2. 重启边缘路由器： 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  3. 检查令牌的值： 
    /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

设置可接受多个值的令牌

某些词元采用逗号分隔值列表。例如， conf_security_rbac.restricted.resources 令牌接受受限 URI 的列表， 只有系统管理员才能调用它们。如需查看 conf_security_rbac.restricted.resources 的值，请执行以下操作：

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

输出包含以下内容：

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

要设置一个接受一系列值的令牌，请将任何新值附加到 放在 .properties 文件中。 因此，如需将 URI /myuri/* 添加到 conf_security_rbac.restricted.resources， 如下所示，修改 /opt/apigee/customer/application/management-server.properties 文件 如下：

conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

查找令牌

大多数情况下，本指南都会指出您需要设置的令牌。但是，如果您需要 要确定用于替换属性的令牌，请在grep source 文件夹中。

例如，如果您知道在上一版本的 Edge 中，您将 session.maxAge 属性，并且想知道用于设置该属性的令牌值，则 为 /opt/apigee/edge-ui/source 目录中的资源创建 grep：

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

您应该会看到以下形式的结果：

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

{T}{/T} 标记之间的字符串就是您在标记名称中指定的词元 .properties 文件。

设置当前被注释掉的令牌

某些令牌在 Edge 配置文件中已被注释掉。如果您尝试设置 ，则该设置会被忽略。

要设置注释掉的令牌，您可以使用特殊语法，格式如下：

conf/file.extension+propertyName=propertyValue

例如，您想要在 Message 中设置名为 HTTPClient.proxy.host 的属性 处理器。然后，您可以对属性执行 grep 操作，以确定其令牌：

cd /opt/apigee/edge-message-processor
grep -ri "HTTPClient.proxy.host" *

grep 命令会以包含令牌值的形式返回结果。通知 属性名称的注释方式（如 属性名称：

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

要设置该属性，请修改 /opt/apigee/customer/application/message-processor.properties 将该属性设置为：

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

请注意属性名称以位置 conf/http.properties+ 为前缀， 和包含属性的配置文件的名称，后跟“+”。

重启消息处理器后，检查文件 /opt/apigee/edge-message-processor/conf/http.properties:

cat /opt/apigee/edge-message-processor/conf/http.properties

在文件末尾，您将看到属性集，格式如下：

conf/http.properties:HTTPClient.proxy.host=myhost.name.com