如何配置 Edge

适用于私有云的 Edge v. 4.17.01

要在安装后配置 Edge,请结合使用 .properties 文件和 Edge 实用程序。对于 例如,要在 Edge 界面上配置 TLS/SSL,您需要编辑 .properties 文件,以设置必要的协议 属性。对 .properties 文件的更改需要重启 受影响的 Edge 组件。

Apigee 将 .properties 文件修改为使用 配置。从本质上讲,包含 config 的代码是一个基于 .properties 文件中的内容。在代码中使用 配置中,这些密钥被称为令牌。因此,要配置 Edge,您需要设置令牌 位于 .properties 文件中。

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

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

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

如何使用 .properties 文件

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

  1. 以任何用户身份在编辑器中创建该文件。
  2. 对文件的所有者执行 chown 操作(针对 apigee:apigee),或者(如果您更改了用户) 向 apigee 用户运行 Edge 服务,向 正在运行 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 文件有三个顶级目录 分别是安装所有者和客户默认位置如下所示 表:

警告:Edge 客户只能修改位于.properties /opt/apigee/customer.在您 可以查看组件和安装目录下的文件,但不能修改任何文件。

Owner

默认令牌根目录

组件

/opt/apigee/<prefix>-<component>/conf

其中 /<prefix>-<component> 用于标识组件,例如 Edge-router 或 apigee-cassandra。

安装

/opt/apigee/token

客户

/opt/apigee/customer

确定令牌的当前值

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

> /opt/apigee/apigee-service/bin/apigee-service comp configure -search token

其中 comp 是组件名称, 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 配置 -搜索 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/*

查找令牌

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

例如,如果您知道在之前的 Edge 版本中设置了 session.maxAge 属性,并且想了解 token 值进行设置,然后对 /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

例如,您需要在消息上设置名为 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=yhost.name.com