管理运行时层面组件

本主题介绍如何配置和管理 Apigee Hybrid 运行时平面组件。

替换文件简介

首次将 Hybrid 运行时安装到集群中时，您必须创建配置替换文件。借助此文件，您可以提供安装 Hybrid 所需的属性值，例如 Google 项目名称、组织名称、环境详细信息、证书文件等。您还可以在替换文件中为大多数混合组件替换特定的默认值。如需查看可配置属性的完整列表，请参阅配置属性参考文档。

Hybrid 安装步骤介绍创建替换文件并将配置应用到集群的过程。如果您希望稍后更改配置，请修改您创建的替换文件并重新应用。请参阅更改配置。

进行配置更改

如需更改 Hybrid 运行时平面组件的配置，请修改替换文件，然后使用 apigeectl 应用这些更改。如需查看可配置属性的完整列表，请参阅配置属性参考文档。

例如，如需启用 logger 组件，请更新替换文件并重新应用：

打开替换文件。确保使用用于将 Hybrid 运行时安装到集群中的相同替换文件。
在文件中找到 logger 元素。例如：
```
...
logger:
  enabled: false
...
```
将属性值更改为 true：
```
...
  logger:
  enabled: true
...
```
使用 apigeectl 将更改应用到集群：
```
$APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry
```
--telemetry 标志会告知 apigeectl 仅更新日志记录器组件。如需了解范围限定参数（例如 --telemetry）的相关信息，请参阅应用 apigeectl 的范围。

您可以修改哪些配置属性？

您可以在配置属性参考文档中找到可配置属性的完整列表。该参考文档仅列出可修改的属性；如果您尝试修改不在参考文档中的属性，则系统会忽略该更改。

如何使用配置参考文档

配置属性参考文档使用点表示法来描述配置元素，其中第一项是顶级元素名称，后跟属性和子属性。例如：

authz.image.pullPolicy

在替换文件中，属性采用正确的 YAML 格式。在上述示例中，顶级 authz 元素左缩进，其下的子元素属性也会缩进。此外，YAML 要求每个元素和子元素的末尾都有一个英文冒号。

例如，如需将 authz.image.pullPolicy 属性设置为 Always，请在替换文件中找到以下 YAML Standa，然后设置如下：

authz:
  image:
    pullPolicy: Always

在另一个示例中，cassandra.auth.admin.password 属性（在配置属性参考文档中列出）用于设置 Cassandra 管理员密码。如需进行更改，请在替换文件中找到以下 YAML，然后按如下所示进行设置：

cassandra:
  auth:
    admin:
      password: abc123

请注意，配置属性参考文档描述了您可在 Hybrid 运行时平面组件上设置的所有属性。请按照上述模式在将更改应用到集群之前修改替换文件中的这些元素。

默认配置简介

Apigee 在 $HYBRID_FILES/config/values.yaml 文件中维护其默认组件配置。此文件会尽可能为每个混合组件指定默认值。

替换文件遵循与 values.yaml 相同的 YAML 结构；但是，替换文件仅包含 values.yaml 中的配置属性的子集。请记住，并非所有属性都可以修改。将配置应用于集群时，您的替换将与默认值合并，以创建完整的 Kubernetes 集群配置。

如果您要修改组件的默认值，并且该组件尚未在替换文件中，则可以将其 YAML 从 values.yaml 复制到替换文件并在其中进行修改。

切勿直接修改 values.yaml；始终使用替换文件指定您的配置属性。

使用预定义替换文件示例

Apigee 提供了一组替换文件示例，以帮助引导您设置 Hybrid 部署。最好复制和修改与您的安装要求最相符的替换文件。

$APIGEECTL_HOME/examples 目录中包含以下示例：

替换文件示例	说明
`overrides-small.yaml`	此示例非常适用于快速入门。它使用建议的最小占用空间来启动 Hybrid 运行时组件。此配置示例尽可能依赖于默认设置和值。所有最低副本数都设置为 `1`。
`overrides-medium.yaml`	此示例是测试和质量检查环境的良好起点。我们为单个组件授予了更高级别的资源来处理附加流量。Cassandra 使用 SSD 磁盘提高性能。在此环境中，建议用户将有状态和无状态组件安装在单独的节点上。请参阅配置专用节点。
`overrides-large.yaml`	此示例是预生产和生产等高性能环境的良好起点。本示例包含用于设置加密密钥、密码等的属性。单个组件至少需要两个副本。
`private-overrides.yaml`	此示例说明了如何使用私有映像代码库中的映像。请参阅使用私有映像代码库。

自定义注释

注解是用于将元数据附加到 Kubernetes Pod 的键值对映射。您可以为配置属性参考文档中列出的以下混合组件属性创建自定义注解：

如需添加自定义名称/值对注解，请打开替换文件，并为相应的组件添加 annotations 节，然后使用 apigeectl 应用更改。例如：

runtime:
  annotations:
    businessunit: "bu1"

使用试运行测试配置更改

您可以将 --dry-run 标志与 apigeectl 结合使用，以测试替换配置文件，而无需实际将其应用于您的集群。此选项有助于调试安装问题，因为它可以清楚地显示将应用于集群的内容。

在 Apigee Hybrid 中，--dry-run 标志的语法取决于您运行的 kubectl 的版本。使用以下命令检查 kubectl 的版本：

kubectl version

kubectl 1.17 版及更低版本：

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl 1.18 版及更高版本：

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

根据需要创建多个替换文件

您可以根据需要创建多个替换文件，其中每个替换文件都满足特定要求。例如，您可能会使用一个替换文件调整用于生产的集群，而使用另一个创建测试集群。然后，您可以在源代码控制系统中维护这些文件。

使用 apigeectl apply 命令将替换文件应用于集群。例如：

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

删除运行时组件

apigeectl delete 命令提供了一些标志，可让您删除所有已安装的混合运行时组件或其中一部分。如需详细了解命令用法，请参阅 apigeectl 参考页面。另请参阅卸载 Hybrid 运行时。

删除环境

如需完全删除环境，您必须同时移除运行时（本地）和管理（云）平面。如需了解详情，请参阅删除环境。