如何配置 Edge

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

Apigee 指的是将 .properties 文件修改为带配置的代码（有时缩写为 CwC）的技术。从本质上讲，包含 config 的代码是一种基于 .properties 文件中的设置的键值对查询工具。在具有 config 的代码中，密钥称为令牌。因此，如需配置 Edge，您需要在 .properties 文件中设置令牌。

借助带有配置的代码，Edge 组件可以设置产品附带的默认值，允许安装团队根据安装拓扑替换这些设置，然后允许客户替换他们选择的任何属性。

如果您将它视为一个层次结构，那么这些设置的排列方式如下，其中客户设置的优先级最高，即覆盖安装程序团队或 Apigee 中的任何设置：

1. 客户
2. 安装程序
3. 组件

确定令牌的当前值

在 .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

如果令牌的值以 # 开头，则注释掉，而您必须使用特殊语法进行更改。如需了解详情，请参阅设置当前被注释掉的令牌。

如果您不知道令牌的整个名称，请使用 grep 等工具按属性名称或关键字进行搜索。如需了解详情，请参阅查找令牌。

属性文件

有可修改和不可修改的组件配置文件。本部分介绍了这些文件。

可修改的组件配置文件

下表列出了 Apigee 组件以及可用于配置这些组件的属性文件：

如果您想在其中某个组件配置文件中设置属性，但该属性不存在，则可以在上面列出的位置创建该属性。

此外，您必须确保属性文件归“apigee”用户所有：

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

不可修改的组件配置文件

除了可修改的组件配置文件之外，还有一些配置文件无法修改。

提供信息（不可修改）的文件包含以下内容：

/opt/apigee/token

/opt/apigee/component_name/conf

设置令牌值

您只能修改 /opt/apigee/customer/application 目录中的 .properties 文件。每个组件在该目录中都有自己的 .properties 文件。例如，router.properties 和 management-server.properties。如需查看属性文件的完整列表，请参阅 .properties 文件的位置。

如需创建 .properties 文件，请执行以下操作：

1. 在编辑器中创建一个新的文本文件。该文件的名称必须与上表中显示的客户文件列表一致。
2. 将文件所有者更改为“apigee:apigee”，如以下示例所示：

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   如果您将运行 Edge 服务的用户从“apigee”用户更改为其他用户，请使用 chown 将所有权更改为运行 Edge 服务的用户。

当您升级 Edge 时，系统会读取 /opt/apigee/customer/application 目录中的 .properties 文件。这意味着升级将保留您在组件上设置的所有属性。

如要设置令牌的值，请执行以下操作：

1. 修改组件的 .properties 文件。
2. 添加或更改令牌的值。以下示例将 conf_http_HTTPRequest.line.limit 属性的值设置为“10k”：

   conf_http_HTTPRequest.line.limit=10k

   如果令牌接受多个值，请用英文逗号分隔每个值，如以下示例所示：

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

   要在此类列表中添加新值，通常要在列表末尾附加新值。

3. 重启组件：

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   其中 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（传统版界面）

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

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

4. （可选）使用 configure -search 选项检查令牌值是否设置为新值。例如：

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

   如需详细了解 configure -search，请参阅确定令牌的当前值。

查找令牌

在大多数情况下，本指南中列出了您需要设置的令牌。但是，如果您需要覆盖您不确定其全名或位置的现有令牌的值，请使用 grep 搜索组件的 source 目录。

例如，如果您知道上一个版本的 Edge 设置了 session.maxAge 属性，并想了解用于设置它的令牌值，请针对 /opt/apigee/edge-ui/source 目录中的属性设置 grep：

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

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

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

以下示例展示了界面 session.maxAge 令牌的值：

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

{T}{/T} 标记之间的字符串是您可以在界面的 .properties 文件中设置的令牌的名称。

设置当前被注释掉的令牌

某些令牌在 Edge 配置文件中会被注释掉。如果您尝试设置在安装或组件配置文件中被注释掉的令牌，您的设置将被忽略。

如需设置在 Edge 配置文件中注释掉的令牌的值，请使用以下特殊语法：

conf/filename+propertyName=propertyValue

例如，如需在消息处理器上设置名为 HTTPClient.proxy.host 的属性，请首先让该属性具有 grep 以确定其令牌：

grep -ri /opt/apigee/edge-message-processor/ -e "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