本部分列出了可用于自定义 Apigee 混合部署的运行时平面的所有配置属性。
顶层属性
下表描述了 overrides.yaml 文件中的顶层属性。以下属性不属于其他对象，并应用于组织或环境级别：
| 属性 | 说明 |
|---|---|
axHashSalt |
在以下版本中引入：1.3.0 默认值：您的组织名称 可选 Kubernetes Secret 的名称，其中包含用于对发送至 Apigee Analytics 的经过混淆处理的用户数据进行加密的哈希盐值。如果您未指定盐值，则系统默认使用组织名称。使用盐值作为输入来创建 Secret。您可以对多个集群使用相同的盐，以确保集群之间的哈希结果保持一致。 |
contractProvider |
在以下版本中引入：1.0.0 默认值： 定义安装中所有 API 的 API 路径。 |
gcpProjectID |
Deprecated: 对于 1.2.0 版及更高版本，请改用 gcp.projectID。在以下版本中引入：1.0.0 默认值：none 必需 您的 Google Cloud 项目的 ID。与 |
gcpRegion |
Deprecated: 对于 1.2.0 版及更高版本，请改用 gcp.region。在以下版本中引入：1.0.0 默认值： 必需 您的 Kubernetes 集群的秘密 Google Cloud 区域或可用区。与 |
imagePullSecrets.name |
在以下版本中引入：1.0.0 默认值：None 配置为 docker-registry 类型的 Kubernetes 秘密名称；用于从私有代码库中提取映像。 |
instanceID |
在以下版本中引入：1.3.0 默认值：None 必需 此安装的唯一标识符。 用于标识此实例的唯一字符串。该 ID 可以是字母和数字的任意组合，长度不得超过 63 个字符。 |
k8sClusterName |
Deprecated: 对于 1.2.0 版及更高版本，请改用 k8sCluster.name 和 k8sCluster.region。在以下版本中引入：1.0.0 默认值：None 您的混合项目正在运行的 Kubernetes (K8S) 专业集群名称。与 |
kmsEncryptionKey |
在以下版本中引入：1.0.0 默认值： 可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。 Apigee KMS 数据加密密钥的本地文件系统路径。 |
kmsEncryptionPath |
在以下版本中引入：1.2.0 默认值：None 可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。 包含 base64 编码的加密密钥的文件的路径。请参阅数据加密。 |
kmsEncryptionSecret.key |
在以下版本中引入：1.2.0 默认值：None 可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。 包含 base64 编码的加密密钥的 Kubernetes Secret 的密钥。请参阅数据加密。 |
kmsEncryptionSecret.name |
在以下版本中引入：1.2.0 默认值：None 可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。 包含 base64 编码的加密密钥的 Kubernetes Secret 的名称。请参阅数据加密。 |
kvmEncryptionKey |
在以下版本中引入：1.0.0 默认值： 可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。 Apigee KVM 数据加密密钥的本地文件系统路径。 |
kvmEncryptionPath |
在以下版本中引入：1.2.0 默认值：None 可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。 包含 base64 编码的加密密钥的文件的路径。请参阅数据加密。 |
kvmEncryptionSecret.key |
在以下版本中引入：1.2.0 默认值：None 可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。 包含 base64 编码的加密密钥的 Kubernetes Secret 的密钥。请参阅数据加密。 |
kvmEncryptionSecret.name |
在以下版本中引入：1.2.0 默认值：None 可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。 包含 base64 编码的加密密钥的 Kubernetes Secret 的名称。请参阅数据加密。 |
namespace |
在以下版本中引入：1.0.0 默认值： 将安装 Apigee 组件的 Kubernetes 集群的命名空间。 |
org |
在以下版本中引入：1.0.0 默认值：None 必需 混合启用组织，由 Apigee 在混合安装期间为您预配。组织是 Apigee 中的顶层容器。它包含您的所有 API 代理及相关资源。如果值为空，则必须在创建后将其更新为组织名称。 |
revision |
在以下版本中引入：1.0.0 默认值： Apigee Hybrid 支持滚动 Kubernetes 更新，让部署更新可以通过用新的逐步更新 Pod 实例来实现零停机时间。 在更新可能导致底层 Kubernetes
更改并应用
更改以下对象的属性时，需要更新 如需了解详情，请参阅滚动更新。 |
validateServiceAccounts |
在以下版本中引入：1.0.0 默认值： 对服务账号权限启用严格验证。这使用 Cloud Resource Manager API 方法
另请参阅 |
ao
Apigee Operators (AO) 创建和更新部署和维护 ApigeeDeployment (AD) 所需的低级 Kubernetes 和 Istio 资源。例如，控制器会执行消息处理器的发布。此外，先验证 ApigeeDeployment 配置，然后再将其保留在 Kubernetes 集群中。
下表介绍了 apigee-operators ao 对象的属性：
| 属性 | 说明 |
|---|---|
ao.image.pullPolicy |
在以下版本中引入：1.2.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
ao.image.tag |
在以下版本中引入：1.2.0 默认值： 此服务 Docker 映像的版本标签。 |
ao.image.url |
在以下版本中引入：1.2.0 默认值： 此服务的 Docker 映像的位置。 |
ao.resources.limits.cpu |
在以下版本中引入：1.2.0 默认值： Kubernetes 容器中资源的 CPU 限制，以毫米为单位。
|
ao.resources.limits.memory |
在以下版本中引入：1.2.0 默认值： Kubernetes 容器中资源的内存限制，以字节为单位。
|
ao.resources.requests.cpu |
在以下版本中引入：1.2.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
ao.resources.requests.memory |
在以下版本中引入：1.2.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节为单位。 |
cassandra
定义管理运行时数据存储区的混合服务。此存储区存储在网关上运行的应用存储应用配置、分配的配额计数器、API 密钥和 OAuth 令牌。
如需了解详情，请参阅 StorageClass 配置。
下表介绍了 cassandra 对象的属性：
| 属性 | 说明 |
|---|---|
cassandra.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
cassandra.auth.admin.password |
在以下版本中引入：1.0.0 默认值： 必需 Cassandra 管理员的密码。管理员用户用于在 Cassandra 集群上执行的任何管理活动。 |
cassandra.auth.ddl.password |
在以下版本中引入：1.0.0 默认值： 必需 Cassandra 数据定义语言 (DDL) 用户的密码。MART 用于任何数据定义任务，例如键空间创建、更新和删除。 |
cassandra.auth.default.password |
在以下版本中引入：1.0.0 默认值： 必需 启用身份验证时创建的默认 Cassandra 用户密码。配置 Cassandra 身份验证时，必须重置此密码。请参阅为 Cassandra 配置 TLS。 |
cassandra.auth.dml.password |
在以下版本中引入：1.0.0 默认值： 必需 Cassandra 数据操纵语言 (DML) 用户的密码。DML 用户供客户端通信读取和向 Cassandra 写入数据。 |
cassandra.auth.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
cassandra.auth.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
cassandra.auth.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
cassandra.auth.jmx.password |
在以下版本中引入：1.4.0 默认值： 必需 Cassandra JMX 操作用户的密码。用于通过 Cassandra JMX 接口进行身份验证和通信。 |
cassandra.auth.jmx.username |
在以下版本中引入：1.4.0 默认值： 必需 Cassandra JMX 操作用户的用户名。用于通过 Cassandra JMX 接口进行身份验证和通信。 |
cassandra.auth.jolokia.password |
在以下版本中引入：1.4.0 默认值： 必需 Cassandra Jolokia JMX 操作用户的密码。用于向 Cassandra JMX API 进行身份验证和通信。 |
cassandra.auth.jolokia.username |
在以下版本中引入：1.4.0 默认值： 必需 Cassandra Jolokia JMX 操作用户的用户名。用于向 Cassandra JMX API 进行身份验证和通信。 |
cassandra.auth.secret |
在以下版本中引入：1.3.3 默认值：None
包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。 另请参阅：
|
cassandra.backup.cloudProvider |
在以下版本中引入：1.0.0
默认值： 如果备份已启用，则是必需的。 用于备份存储的云提供商。 您可以将该值设置为 |
cassandra.backup.dbStorageBucket |
在以下版本中引入：1.0.0 默认值：None 如果备份已启用，则是必需的。 备份数据的 Cloud Storage 存储桶。 |
cassandra.backup.enabled |
在以下版本中引入：1.0.0 默认值： 默认情况下，数据备份未启用。要启用该功能，请设置为 请参阅 Cassandra 备份和恢复。 |
cassandra.backup.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
cassandra.backup.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
cassandra.backup.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
cassandra.backup.schedule |
在以下版本中引入：1.0.0 默认值： Cron 作业的时间表。 请参阅 Cassandra 备份和恢复。 |
cassandra.backup.serviceAccountPath |
在以下版本中引入：1.0.0 默认值：None 如果已启用备份，则必须使用 具有 Storage Object Admin 角色的 Google 服务账号密钥文件的路径。 |
cassandra.backup.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 如果已启用备份，则必须使用 |
cassandra.clusterName |
在以下版本中引入：1.0.0 默认值： 指定 Cassandra 集群的名称。 |
cassandra.datacenter |
在以下版本中引入：1.0.0 默认值： 指定 Cassandra 节点的数据中心。 |
cassandra.dnsPolicy |
在以下版本中引入：1.1.1 默认值：None
将 |
cassandra.externalSeedHost |
在以下版本中引入：1.0.0 默认值：None Cassandra 集群节点的主机名或 IP。如果未设置，则使用 Kubernetes 本地服务。 |
cassandra.heapNewSize |
在以下版本中引入：1.0.0 默认值： 分配给较新对象的 JVM 系统内存量，以兆字节为单位。 |
cassandra.hostNetwork |
在以下版本中引入：1.1.1 默认值： 启用 Kubernetes 对于单区域安装和不同集群的 pod 间有连接的多区域安装（例如 GKE 安装），将 对于不同集群的 pod 之间没有通信的多区域安装（例如 GKE On-Prem、GKE on AWS、Anthos on Bare Metal、AKS、EKS 和 OpenShift 安装），将 为 |
cassandra.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
cassandra.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
cassandra.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
cassandra.maxHeapSize |
在以下版本中引入：1.0.0 默认值： 可用于 Cassandra 操作的 JVM 系统内存的上限（以 MB 为单位）。 |
cassandra.multiRegionSeedHost |
在以下版本中引入：1.0.0 默认值：None 现有 Cassandra 集群的 IP 地址，用于将现有集群扩展到新地区。请参阅配置多地区种子主机。 |
cassandra.nodeSelector.key |
在以下版本中引入：1.0.0 默认值：None 必需 节点选择器标签键，用于定位 请参阅配置专用节点池。 |
cassandra.nodeSelector.value |
在以下版本中引入：1.0.0 默认值：None 可选的节点选择器标签值，用于定位 请参阅 nodeSelector。 |
cassandra.port |
在以下版本中引入：1.0.0 默认值： 用于连接到 Cassandra 的端口号。 |
cassandra.rack |
在以下版本中引入：1.0.0 默认值： 指定 Cassandra 节点的 Rack。 |
cassandra.readinessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证将 Pod 标记为“未就绪”前，就绪探测失败的次数。最小值为 1。 |
cassandra.readinessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 就绪探测启动前，容易开始后经过的秒数。 |
cassandra.readinessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行就绪探测的频率，以秒为单位。最小值为 1。 |
cassandra.readinessProbe.successThreshold |
在以下版本中引入：1.0.0 默认值： 在失败后，被认为成功就绪探测需要的最小持续成功次数。最小值为 1。 |
cassandra.readinessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
cassandra.replicaCount |
在以下版本中引入：1.0.0 默认值： Cassandra 是一个副本数据库。此属性用于指定用作 StatefulSet 的 Cassandra 节点的数量。 |
cassandra.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
cassandra.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节为单位。 |
cassandra.restore.cloudProvider |
在以下版本中引入：1.0.0
默认值： 如果恢复已启用，则必须提供。 用于备份存储的云提供商。 |
cassandra.restore.dbStorageBucket |
在以下版本中引入：1.0.0 默认值：None 如果恢复已启用，则必须提供。 要恢复的备份数据的 Cloud Storage 存储桶。 |
cassandra.restore.enabled |
在以下版本中引入：1.0.0 默认值： |
cassandra.restore.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
cassandra.restore.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
cassandra.restore.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
cassandra.restore.serviceAccountPath |
在以下版本中引入：1.0.0 默认值：None 如果已启用恢复，则必须使用 具有 Storage Object Admin 角色的 Google 服务账号密钥文件的路径。 |
cassandra.restore.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 如果已启用恢复，则必须使用 |
cassandra.restore.snapshotTimestamp |
在以下版本中引入：1.0.0 默认值：None 如果恢复已启用，则必须提供。 应恢复的备份的时间戳。 |
cassandra.restore.user |
在以下版本中引入：1.0.0 默认值：管理员账号 用于架构备份恢复的 Cassandra 用户名。如果未指定，系统会使用管理员用户。 |
cassandra.sslCertPath |
在以下版本中引入：1.2.0 默认值：None
系统上指向 TLS 证书文件的路径。 |
cassandra.sslKeyPath |
在以下版本中引入：1.2.0 默认值：None
在系统上指向 TLS 私钥文件的路径。 |
cassandra.sslRootCAPath |
在以下版本中引入：1.2.0 默认值：None 根 CA（证书授权机构）的证书链。 |
cassandra.storage.capacity |
在以下版本中引入：1.0.0 默认值： 如果指定了 指定所需的磁盘大小，以兆比字节为单位。 |
cassandra.storage.storageclass |
在以下版本中引入：1.0.0 默认值：None 指定正在使用的本地存储空间类别。 |
cassandra.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
connectAgent
Apigee Connect 让 Apigee Hybrid 管理平面可安全地连接到运行时平面中的 MART 服务，而无需在互联网上公开 MART 端点。
请参阅 Apigee Connect。
下表介绍了 connectAgent 对象的属性：
| 属性 | 说明 |
|---|---|
connectAgent.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
connectAgent.server |
在以下版本中引入：1.2.0 默认值： 此服务的服务器和端口的位置。 |
connectAgent.logLevel |
在以下版本中引入：1.2.0 默认值： 日志报告的级别。包含以下值：
|
connectAgent.image.pullPolicy |
在以下版本中引入：1.2.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
connectAgent.image.tag |
在以下版本中引入：1.2.0 默认值： 此服务 Docker 映像的版本标签。 |
connectAgent.image.url |
在以下版本中引入：1.2.0 默认值： 此服务的 Docker 映像的位置。 检查特定网址的 |
connectAgent.replicaCountMax |
在以下版本中引入：1.2.0 默认值： 可用于自动扩缩的副本数上限。 |
connectAgent.replicaCountMin |
在以下版本中引入：1.2.0 默认值： 可自动扩缩的副本数下限。 在生产环境中，您可能需要将 |
connectAgent.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
connectAgent.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节为单位。 |
connectAgent.targetCPUUtilizationPercentage |
在以下版本中引入：1.2.0 默认值： pod 上 Apigee Connect 代理的目标 CPU 利用率。在 CPU 利用率达到此值（最多 |
connectAgent.terminationGracePeriodSeconds |
在以下版本中引入：1.2.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
defaults
Apigee Hybrid 安装的默认加密密钥。
下表介绍了 defaults 对象的属性：
| 属性 | 说明 |
|---|---|
defaults.org.kmsEncryptionKey |
在以下版本中引入：1.0.0 默认值： KMS 中组织的默认加密密钥。 |
defaults.org.kvmEncryptionKey |
在以下版本中引入：1.0.0 默认值： KVM 中组织的默认加密密钥。 |
defaults.env.kmsEncryptionKey |
在以下版本中引入：1.0.0 默认值： KMS 中环境 (env) 的默认加密密钥。 |
defaults.env.kvmEncryptionKey |
在以下版本中引入：1.0.0 默认值： KVM 中环境（env）的默认加密密钥。 |
defaults.env.cacheEncryptionKey |
在以下版本中引入：1.0.0 默认值： 环境 (env) 的默认缓存加密密钥。 |
diagnostic
诊断收集器工具的设置。
请参阅使用诊断收集器。
下表介绍了 diagnostic 对象的属性：
| 属性 | 说明 |
|---|---|
diagnostic.bucket |
在以下版本中引入：1.6.0 默认值：None 必需 用于存储诊断数据的 Google Cloud 存储桶的名称。 请参阅创建存储桶。 |
diagnostic.container |
在以下版本中引入：1.6.0 默认值：None 必需 这用于指定要从中捕获数据的 pod 类型。这些值可以是以下值之一：
|
diagnostic.loggingDetails.logDuration |
在以下版本中引入：1.6.0 默认值：None 如果诊断收集操作为“LOGGING”（使用 收集的日志数据的时长（以毫秒为单位）。典型值为 |
diagnostic.loggingDetails.loggerNames[] |
在以下版本中引入：1.6.0 默认值：None 如果诊断收集操作为“LOGGING”（使用 按名称指定从哪个日志记录器收集数据。对于 Apigee Hybrid 1.6.0 版，唯一支持的值是 diagnostic: loggingDetails: loggerNames: - ALL |
diagnostic.loggingDetails.logLevel |
在以下版本中引入：1.6.0 默认值：None 如果诊断收集操作为“LOGGING”（使用 指定要收集的日志记录数据的粒度。在 Apigee Hybrid 1.6 中，仅支持 |
diagnostic.namespace |
在以下版本中引入：1.6.0 默认值：None 必需 您从中收集数据的 pod 所在的 Kubernetes 命名空间。命名空间必须是您使用
|
diagnostic.operation |
在以下版本中引入：1.6.0 默认值：None 必需 指定是收集所有统计信息还是仅收集日志。 有效值包括：
|
diagnostic.podNames[] |
在以下版本中引入：1.6.0 默认值：None 必需 要为其收集数据的 Kubernetes pod 的名称。例如： diagnostic: podNames: - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2 |
diagnostic.serviceAccountPath |
在以下版本中引入：1.6.0 默认值：None 必需 具有 Storage Admin 角色 ( 请参阅： |
diagnostic.tcpDumpDetails.maxMsgs |
在以下版本中引入：1.6.0 默认值：None 如果使用 设置要收集的最大 |
diagnostic.tcpDumpDetails.timeoutInSeconds |
在以下版本中引入：1.6.0 默认值：None 如果使用 设置等待 |
diagnostic.threadDumpDetails.delayInSeconds |
在以下版本中引入：1.6.0 默认值：None 如果您使用的是 收集每个线程转储之间的延迟时间（以秒为单位）。 |
diagnostic.threadDumpDetails.iterations |
在以下版本中引入：1.6.0 默认值：None 如果您使用的是 要收集的 jstack 线程转储迭代的次数。 |
envs
定义您可以部署 API 代理的环境数组。每个环境为运行 API 代理提供隔离上下文或沙盒。
您的混合启用组织必须至少包含一个环境。
如需了解详情，请参阅环境简介。
下表介绍了 envs 对象的属性：
| 属性 | 说明 |
|---|---|
envs[].cacheEncryptionKey |
在以下版本中引入：1.0.0 默认值：None 必须提供 base64 编码的加密密钥。请参阅数据加密。 |
envs[].cacheEncryptionPath |
在以下版本中引入：1.2.0 默认值：None 必须提供 包含 base64 编码的加密密钥的文件的路径。请参阅数据加密。 |
envs[].cacheEncryptionSecret.key |
在以下版本中引入：1.2.0 默认值：None 必须提供 包含 base64 编码的加密密钥的 Kubernetes Secret 的密钥。请参阅数据加密。 |
envs[].cacheEncryptionSecret.name |
在以下版本中引入：1.2.0 默认值：None 必须提供 包含 base64 编码的加密密钥的 Kubernetes Secret 的名称。请参阅数据加密。 |
envs[].hostAliases[] |
在以下版本中引入：1.2.0 默认值：None Deprecated：从 Hybrid 1.4 版开始，运行时平面会从管理平面接收此信息。请参阅环境和环境组简介。 |
envs[].httpProxy.host |
在以下版本中引入：1.2.0 默认值：None 指定运行 HTTP 代理的主机名或 IP 地址。 按
envs:
- name: test
httpProxy:
scheme: HTTP
host: 10.12.0.47
port: 3128
...
另请参阅：为 API 代理配置转发代理。 |
envs[].httpProxy.port |
在以下版本中引入：1.2.0 默认值：None 指定运行 HTTP 代理的端口。如果省略此属性，默认情况下，它将使用端口 |
envs[].httpProxy.scheme |
在以下版本中引入：1.2.0 默认值：None 将 HTTP 代理的类型指定为 HTTP 或 HTTPS。默认情况下，它使用“HTTP”。 |
envs[].httpProxy.username |
在以下版本中引入：1.2.0 默认值：None 如果 HTTP 代理需要基本身份验证，则使用此属性提供用户名。 |
envs[].httpProxy.password |
在以下版本中引入：1.2.0 默认值：None 如果 HTTP 代理需要基本身份验证，则使用此属性提供密码。 |
envs[].name |
在以下版本中引入：1.0.0 默认值：None 必需 要同步的 Apigee 环境名称。 |
envs[].pollInterval |
在以下版本中引入：1.0.0 默认值：None 用于轮询组织和环境同步更改的时间间隔，以秒为单位。 |
envs[].port |
在以下版本中引入：1.0.0 默认值：None HTTPS 流量的 TCP 端口号。 |
envs[].serviceAccountPaths.runtime |
在以下版本中引入：1.4.0 默认值：None 具有 Cloud Trace Agent 角色的 Google 服务账号（通常是 |
envs[].serviceAccountPaths.synchronizer |
在以下版本中引入：1.0 默认值：None 具有 Apigee Synchronizer Manager 角色的 Google 服务账号密钥本地系统文件的路径。 |
envs[].serviceAccountPaths.udca |
在以下版本中引入：1.0 默认值：None 具有 Apigee Analytic Agent 角色的 Google 服务账号密钥本地系统文件的路径。 |
envs[].serviceAccountSecretRefs.runtime |
在以下版本中引入：1.4.0 默认值：None Kubernetes Secret 的名称。您必须使用具有 Cloud Trace Agent 角色的 Google 服务账号密钥作为输入来创建 Secret。 |
envs[].serviceAccountSecretRefs.synchronizer |
在以下版本中引入：1.2.0 默认值：None Kubernetes Secret 的名称。您必须使用具有 Apigee Synchronizer Manager 角色的 Google 服务账号密钥作为输入来创建 Secret。 |
envs[].serviceAccountSecretRefs.udca |
在以下版本中引入：1.2.0 默认值：None Kubernetes Secret 的名称。您必须使用具有 Apigee Analytic Agent 角色的 Google 服务账号密钥作为输入来创建 Secret。 |
envs[].sslCertPath |
在以下版本中引入：1.2.0 默认值：None 必须提供
系统上指向 TLS 证书文件的路径。 |
envs[].sslKeyPath |
在以下版本中引入：1.2.0 默认值：None 必须提供
在系统上指向 TLS 私钥文件的路径。 |
envs[].sslSecret |
在以下版本中引入：1.2.0 默认值：None 必须提供
包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。 另请参阅：
|
gcp
标识 apigee-logger 和 apigee-metrics 推送其数据的 Google Cloud 项目 ID 和区域。
下表介绍了 gcp 对象的属性：
| 属性 | 说明 |
|---|---|
gcp.region |
在以下版本中引入：1.2.0 默认值：None 必需 标识 |
gcp.projectID |
在以下版本中引入：1.2.0 默认值：None 必需 标识 |
gcp.projectIDRuntime |
在以下版本中引入：1.2.0 默认值：None 标识运行时 Kubernetes 集群项目。
|
httpProxy
httpProxy 为 HTTP 转接代理服务器提供配置参数。在 overrides.yaml 中配置时，MART、Synchronizer 和 UDCA 组件的所有互联网通信都会通过代理服务器发送。
另请参阅：Logger、MART、Metrics、Synchronizer 和 UDCA。
下表介绍了 httpProxy 对象的属性：
| 属性 | 说明 |
|---|---|
httpProxy.host |
在以下版本中引入：1.1.1 默认值：None HTTP 代理的主机名。 |
httpProxy.port |
在以下版本中引入：1.1.1 默认值：None HTTP 代理的端口。 |
httpProxy.scheme |
在以下版本中引入：1.1.1 默认值： 代理使用的方案。值可以是 |
k8sCluster
标识安装了 Hybrid 运行时的 Kubernetes 集群。
下表介绍了 k8sCluster 对象的属性：
| 属性 | 说明 |
|---|---|
k8sCluster.name |
在以下版本中引入：1.2.0 默认值：None 安装 Hybrid 运行时的 Kubernetes 集群的名称。 |
k8sCluster.region |
在以下版本中引入：1.2.0 默认值：None 标识创建 Kubernetes 集群的 Google Cloud 区域。 |
kubeRBACProxy
标识 Apigee 应在何处查找 Kubernetes 基于角色的访问权限控制。
下表介绍了 kubeRBACProxy 对象的属性：
| 属性 | 说明 |
|---|---|
kubeRBACProxy.image.pullPolicy |
在以下版本中引入：1.2.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
kubeRBACProxy.image.tag |
在以下版本中引入：1.2.0默认值： 此服务 Docker 映像的版本标签。 |
kubeRBACProxy.image.url |
在以下版本中引入：1.2.0 默认值： 此服务的 Docker 映像的位置。 如果您不想使用 Google Docker Hub，请下载映像并使用您的 Docker 映像在内部托管的地址。 |
logger
定义管理运营日志的服务。Kubernetes 集群中运行的所有 Apigee 混合服务都会输出此信息。
如需了解详情，请参阅 Logging 概览。
下表介绍了 logger 对象的属性：
| 属性 | 说明 |
|---|---|
logger.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
logger.enabled |
在以下版本中引入：1.0.0 默认值： 启用或停用集群上的日志记录功能。对于设置为 |
logger.fluentd.buffer_chunk_limit |
在以下版本中引入：1.0.0 默认值： 允许的缓冲区区块的大小上限，以千字节为单位。超出限制的区块将自动进入输出队列。 |
logger.fluentd.buffer_queue_limit |
在以下版本中引入：1.0.0 默认值： 输出队列的最大长度。默认限制为 256 个区块。 |
logger.fluentd.flush_interval |
在以下版本中引入：1.0.0 默认值： 调用下一个缓冲区刷新前等待的时间间隔，以秒为单位。 |
logger.fluentd.max_retry_wait |
在以下版本中引入：1.0.0 默认值： 写入操作之间的最大时间间隔，以秒为单位。 |
logger.fluentd.num_threads |
在以下版本中引入：1.0.0 默认值： 用于刷新缓冲区的线程数。默认值为 1。 |
logger.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
logger.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
logger.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
logger.livenessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证重启容器前，活跃探测失败的次数。最小值为 1。 |
logger.livenessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测启动前，容易开始后经过的秒数。 |
logger.livenessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行活跃探测的频率，以秒为单位。最小值为 1。 |
logger.livenessProbe.successThreshold |
在以下版本中引入：1.0.0 默认值： 在失败后，被认为成功活跃性探测需要的最小持续成功次数。最小值为 1。 |
logger.livenessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
logger.nodeSelector.key |
在以下版本中引入：1.0.0 默认值： 必需 节点选择器标签键，用于定位 请参阅配置专用节点池。 |
logger.nodeSelector.value |
在以下版本中引入：1.0.0 默认值： 必需 节点选择器标签值，用于定位 请参阅配置专用节点池。 |
logger.proxyURL |
在以下版本中引入：1.0.0 默认值：None 客户代理服务器的网址。 |
logger.resources.limits.memory |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源的内存限制，以字节为单位。
|
logger.resources.limits.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源的 CPU 限制，以毫米为单位。
|
logger.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
logger.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节为单位。 |
logger.serviceAccountPath |
在以下版本中引入：1.0.0 默认值：None 必须提供 具有 Logs Writer 角色的 Google 服务账号密钥文件的路径。 |
logger.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 必须提供 |
logger.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
mart
定义 MART（运行时数据的 Management API）服务，它充当公开 Apigee API 的 API 提供商，以便您可以访问和管理运行时数据实体，例如 KMS（API 密钥和 OAuth 令牌）、KVM、配额和 API 产品。
下表介绍了 mart 对象的属性：
| 属性 | 说明 |
|---|---|
mart.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
mart.hostAlias |
在以下版本中引入：1.0.0 默认值：None 指向 MART 对象的主机别名。您可以将此属性设置为 |
mart.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
mart.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
mart.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 检查特定网址的 |
mart.initCheckCF.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： 分配给 Cloud Foundry 进程初始化检查的 CPU 资源量。 |
mart.livenessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证重启容器前，活跃探测失败的次数。最小值为 1。 |
mart.livenessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测启动前，容易开始后经过的秒数。 |
mart.livenessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行活跃探测的频率，以秒为单位。最小值为 1。 |
mart.livenessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
mart.metricsURL |
在以下版本中引入：1.0.0 默认值： |
mart.nodeSelector.key |
在以下版本中引入：1.0.0 默认值：None 可选节点选择器标签键，用于定位 请参阅配置专用节点池。 |
mart.nodeSelector.value |
在以下版本中引入：1.0.0 默认值：None 可选节点选择器标签值，用于定位 请参阅配置专用节点池。 |
mart.readinessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证将 Pod 标记为“未就绪”前，就绪探测失败的次数。最小值为 1。 |
mart.readinessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 就绪探测启动前，容易开始后经过的秒数。 |
mart.readinessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行就绪探测的频率，以秒为单位。最小值为 1。 |
mart.readinessProbe.successThreshold |
在以下版本中引入：1.0.0 默认值： 在失败后，被认为成功就绪探测需要的最小持续成功次数。最小值为 1。 |
mart.readinessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
mart.replicaCountMax |
在以下版本中引入：1.0.0 默认值： 可用于自动扩缩的副本数上限。 |
mart.replicaCountMin |
在以下版本中引入：1.0.0 默认值： 可自动扩缩的副本数下限。 |
mart.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
mart.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节为单位。 |
mart.serviceAccountPath |
在以下版本中引入：1.1.1 默认值：None 必须提供 无角色的 Google 服务账号密钥文件的路径。 |
mart.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 必须提供 |
mart.sslCertPath |
在以下版本中引入：1.0.0 默认值：None 必须提供 将 SSL 证书加载和编码到 Secret 的本地文件系统路径。 |
mart.sslKeyPath |
在以下版本中引入：1.0.0 默认值：None 必须提供 将 SSL 密钥加载和编码到 Secret 的本地文件系统路径。 |
mart.sslSecret |
在以下版本中引入：1.2.0 默认值：None 必须提供 包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。 另请参阅：
|
mart.targetCPUUtilizationPercentage |
在以下版本中引入：1.0.0 默认值： Pod 上 MART 进程的目标 CPU 利用率。在 CPU 利用率达到此值（最多 |
mart.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
metrics
定义收集操作指标的服务。您可以使用指标数据来监控混合服务的运行状况、设置提醒等。
如需了解详情，请参阅指标集合概览。
下表介绍了 metrics 对象的属性：
| 属性 | 说明 |
|---|---|
metrics.aggregator.resources.requests.cpu |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中聚合器正常运行所需的 CPU（以毫核为单位）。 |
metrics.aggregator.resources.requests.memory |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中聚合器正常运行所需的内存（以 MiB 为单位）。 |
metrics.aggregator.resources.limits.cpu |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中聚合器资源的 CPU 限制（以毫核为单位）。 |
metrics.aggregator.resources.limits.memory |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中聚合器资源的内存限制（以 GiB 为单位）。 |
metrics.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
metrics.app.resources.requests.cpu |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中应用正常运行所需的 CPU（以毫核为单位）。 |
metrics.app.resources.requests.memory |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中应用正常运行所需的内存（以 MiB 为单位）。 |
metrics.app.resources.limits.cpu |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中应用资源的 CPU 限制（以毫核为单位）。 |
metrics.app.resources.limits.memory |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中应用资源的内存限制（以 GiB 为单位）。 |
metrics.appStackdriverExporter.resources.requests.cpu |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 正常运行所需的 CPU（以毫核为单位）。 |
metrics.appStackdriverExporter.resources.requests.memory |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 正常运行所需的内存（以 MiB 为单位）。 |
metrics.appStackdriverExporter.resources.limits.cpu |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 资源的 CPU 限制（以毫核为单位）。 |
metrics.appStackdriverExporter.resources.limits.memory |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 资源的内存限制（以 GiB 为单位）。 |
metrics.enabled |
在以下版本中引入：1.0.0 默认值： 启用 Apigee 指标。设置为 |
metrics.nodeSelector.key |
在以下版本中引入：1.0.0 默认值：None 必需 节点选择器标签键，用于定位 请参阅配置专用节点池。 |
metrics.nodeSelector.value |
在以下版本中引入：1.0.0 默认值：None 必需 节点选择器标签值，用于定位 请参阅配置专用节点池。 |
metrics.prometheus.args.storage_tsdb_retention |
在以下版本中引入：1.0.0 默认值： Prometheus 从本地存储空间中移除旧数据之前等待的时间，以小时为单位。 |
metrics.prometheus.containerPort |
在以下版本中引入：1.0.0 默认值： 连接到 Prometheus 指标服务的端口。 |
metrics.prometheus.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
metrics.prometheus.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
metrics.prometheus.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
metrics.prometheus.livenessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证重启容器前，活跃探测失败的次数。最小值为 1。 |
metrics.prometheus.livenessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行活跃探测的频率，以秒为单位。最小值为 1。 |
metrics.prometheus.livenessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
metrics.prometheus.readinessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证将 Pod 标记为“未就绪”前，就绪探测失败的次数。最小值为 1。 |
metrics.prometheus.readinessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行就绪探测的频率，以秒为单位。最小值为 1。 |
metrics.prometheus.readinessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
metrics.prometheus.sslCertPath |
在以下版本中引入：1.0.0 默认值：None 必需 指向 Prometheus 指标收集过程 SSL 证书的路径。Prometheus 是 Apigee 可用于收集和处理指标的工具。 请参阅：
|
metrics.prometheus.sslKeyPath |
在以下版本中引入：1.0.0 默认值：None 必需 指向 Prometheus 指标收集过程 SSL 密钥的路径。Prometheus 是 Apigee 可用于收集和处理指标的工具。 请参阅：
|
metrics.proxy.resources.requests.cpu |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中代理正常运行所需的 CPU（以毫核为单位）。 |
metrics.proxy.resources.requests.memory |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中代理正常运行所需的内存（以 MiB 为单位）。 |
metrics.proxy.resources.limits.cpu |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中代理资源的 CPU 限制（以毫核为单位）。 |
metrics.proxy.resources.limits.memory |
在以下版本中引入：1.4.0 默认值： Kubernetes 容器中代理资源的内存限制（以 GiB 为单位）。 |
metrics.proxyStackdriverExporter.resources.requests.cpu |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 正常运行所需的 CPU（以毫核为单位）。 |
metrics.proxyStackdriverExporter.resources.requests.memory |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 正常运行所需的内存（以 MiB 为单位）。 |
metrics.proxyStackdriverExporter.resources.limits.cpu |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 资源的 CPU 限制（以毫核为单位）。 |
metrics.proxyStackdriverExporter.resources.limits.memory |
在以下版本中引入：1.7.0 默认值： Kubernetes 容器中 stackdriverExporter 资源的内存限制（以 GiB 为单位）。 |
metrics.proxyURL |
在以下版本中引入：1.0.0 默认值：None Kubernetes 集群中的指标进程 Sidecar 代理的网址。 |
metrics.sdSidecar.containerPort |
在以下版本中引入：1.0.0 默认值： 用于连接到 Cloud Operations 指标服务的端口。 |
metrics.sdSidecar.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 Kubelet 何时提取此服务的 Docker 映像。可能的值包括：
|
metrics.sdSidecar.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
metrics.sdSidecar.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
metrics.serviceAccountPath |
在以下版本中引入：1.0.0 默认值：None 必须提供 具有 Monitoring Metric Writer 角色的 Google 服务账号密钥文件的路径。 |
metrics.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 必须提供 |
metrics.stackdriverExporter.resources.requests.cpu |
在以下版本中引入：1.4.0 Deprecated：从 Hybrid 1.7 版开始， |
metrics.stackdriverExporter.resources.requests.memory |
在以下版本中引入：1.4.0 Deprecated：从 Hybrid 1.7 版开始， |
metrics.stackdriverExporter.resources.limits.cpu |
在以下版本中引入：1.4.0 Deprecated：从 Hybrid 1.7 版开始， |
metrics.stackdriverExporter.resources.limits.memory |
在以下版本中引入：1.4.0 Deprecated：从 Hybrid 1.7 版开始， |
metrics.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
nodeSelector
nodeSelector 对象用于定义 Apigee 实例的节点。apigeectl 运行时场景的背后，应为 apigeeRuntime 和 apigeeData 将标签键/值映射到单个 Istio 和 MART 组件。您可以为 mart:nodeSelector 属性中的各个对象替换此设置。
下表介绍了 nodeSelector 对象的属性：
| 属性 | 说明 |
|---|---|
nodeSelector.apigeeData.key |
在以下版本中引入：1.0.0 默认值： ApigeeData 是 Cassandra 数据库的节点。节点选择器标签键，用于定位 Kubernetes 节点以与 Apigee 服务数据配合使用。 请参阅配置专用节点池。 |
nodeSelector.apigeeData.value |
在以下版本中引入：1.0.0 默认值： apigee-data 是 Cassandra 数据库的节点。节点选择器标签值，用于定位 Kubernetes 节点以与 Apigee 服务数据配合使用。 请参阅配置专用节点池。 |
nodeSelector.apigeeRuntime.key |
在以下版本中引入：1.0.0 默认值： Apigee Runtime 是项目的运行时环境的节点。节点选择器标签键，用于定位 Apigee 运行时服务的 Kubernetes 节点。 请参阅配置专用节点池。 |
nodeSelector.apigeeRuntime.value |
在以下版本中引入：1.0.0 默认值：
请参阅配置专用节点池。 |
nodeSelector.requiredForScheduling |
在以下版本中引入：1.0.0 默认值：false
对于生产环境， 请参阅配置专用节点池。 |
redis
下表介绍了 redis 对象的属性：
| 属性 | 说明 |
|---|---|
redis.auth.password |
在以下版本中引入：1.6.0 默认值： 必需 Redis 管理员的密码。管理员用户用于在 Redis 集群上执行的任何管理活动。 |
redis.replicaCount |
在以下版本中引入：1.6.0 默认值： Redis 是复制的存储空间。此属性用于指定用作 StatefulSet 的 Redis 节点的数量。 |
redis.resources.requests.cpu |
在以下版本中引入：1.6.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
runtime
下表介绍了 runtime 对象的属性：
| 属性 | 说明 |
|---|---|
runtime.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
runtime.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
runtime.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
runtime.image.url |
在以下版本中引入：1.0.0 默认值：安装映像资源网址，例如： 此服务的 Docker 映像的位置。 |
runtime.livenessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证重启容器前，活跃探测失败的次数。最小值为 1。 |
runtime.livenessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测启动前，容易开始后经过的秒数。 |
runtime.livenessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行活跃探测的频率，以秒为单位。最小值为 1。 |
runtime.livenessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
runtime.nodeSelector.key |
在以下版本中引入：1.0.0 默认值：None 可选节点选择器标签键，用于定位 请参阅 nodeSelector 属性。 |
runtime.nodeSelector.value |
在以下版本中引入：1.0.0 默认值：None 节点选择器标签值，用于定位 请参阅配置专用节点池。 |
runtime.readinessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证将 Pod 标记为“未就绪”前，就绪探测失败的次数。最小值为 1。 |
runtime.readinessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 就绪探测启动前，容易开始后经过的秒数。 |
runtime.readinessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行就绪探测的频率，以秒为单位。最小值为 1。 |
runtime.readinessProbe.successThreshold |
在以下版本中引入：1.0.0 默认值： 在失败后，被认为成功就绪探测需要的最小持续成功次数。最小值为 1。 |
runtime.readinessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
runtime.replicaCountMax |
在以下版本中引入：1.0.0 默认值： 可用于自动扩缩的副本数上限。 |
runtime.replicaCountMin |
在以下版本中引入：1.0.0 默认值： 可自动扩缩的副本数下限。 |
runtime.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
runtime.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节 ( |
runtime.service.type |
在以下版本中引入：1.0.0 默认值： 服务类型。您可以将此设置为 ClusterIP 以外的服务；例如 |
runtime.targetCPUUtilizationPercentage |
在以下版本中引入：1.0.0 默认值： Pod 上运行时进程的目标 CPU 利用率。在 CPU 利用率达到此值（最多 |
runtime.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
synchronizer
确保消息处理器与最新部署的 API 代理软件包保持同步。为此，Synchronizer 会轮询管理平面；检测到新合同时，Synchronizer 会将其发送到运行时平面。默认情况下，Synchronizer 将环境配置数据存储在 Cassandra 中。
如需了解详情，请参阅配置 Synchronizer。
下表介绍了 synchronizer 对象的属性：
| 属性 | 说明 |
|---|---|
synchronizer.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
synchronizer.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
synchronizer.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
synchronizer.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
synchronizer.livenessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证重启容器前，活跃探测失败的次数。最小值为 1。 |
synchronizer.livenessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测启动前，容易开始后经过的秒数。 |
synchronizer.livenessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行活跃探测的频率，以秒为单位。最小值为 1。 |
synchronizer.livenessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
synchronizer.nodeSelector.key |
在以下版本中引入：1.0.0 默认值：None 必需 可选节点选择器标签键，用于定位 请参阅 nodeSelector。 |
synchronizer.nodeSelector.value |
在以下版本中引入：1.0.0 默认值：None 可选节点选择器标签值，用于定位 请参阅 nodeSelector。 |
synchronizer.pollInterval |
在以下版本中引入：1.0.0 默认值： Synchronizer 在轮询操作之间等待的时长。Synchronizer 轮询 Apigee 控制平面服务，以检测并提取新的运行时合同。 |
synchronizer.readinessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证将 Pod 标记为“未就绪”前，就绪探测失败的次数。最小值为 1。 |
synchronizer.readinessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 就绪探测启动前，容易开始后经过的秒数。 |
synchronizer.readinessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行就绪探测的频率，以秒为单位。最小值为 1。 |
synchronizer.readinessProbe.successThreshold |
在以下版本中引入：1.0.0 默认值： 在失败后，被认为成功就绪探测需要的最小持续成功次数。最小值为 1。 |
synchronizer.readinessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
synchronizer.replicaCount |
在以下版本中引入：1.0.0 默认值： 自动扩缩的副本数。 |
synchronizer.replicaCountMax |
在以下版本中引入：1.2.0 默认值： 自动扩缩的副本数上限。 |
synchronizer.replicaCountMin |
在以下版本中引入：1.2.0 默认值： 自动扩缩的副本数下限。 |
synchronizer.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
synchronizer.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以千兆字节为单位。 |
synchronizer.serviceAccountPath |
在以下版本中引入：1.0.0 默认值：None 必须提供 具有 Apigee Synchronizer Manager 角色的 Google 服务账号密钥文件的路径。 |
synchronizer.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 必须提供 |
synchronizer.targetCPUUtilizationPercentage |
在以下版本中引入：1.0.0 默认值：
Pod 上 Synchronizer 进程的目标 CPU 利用率。在 CPU 利用率达到此值（最多 |
synchronizer.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
udca
（通用数据收集代理）定义在运行时平面的数据收集 pod 中运行的服务。此服务会提取分析和部署状态数据并将其发送到统一分析平台 (UAP)。
如需了解详情，请参阅分析和部署状态数据收集。
下表介绍了 udca 对象的属性：
| 属性 | 说明 |
|---|---|
udca.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
udca.fluentd.image.pullPolicy |
在以下版本中引入：1.0.0 默认值： 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
udca.fluentd.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
udca.fluentd.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
udca.fluentd.resources.limits.memory |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源的内存限制，以字节为单位。
|
udca.fluentd.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
udca.fluentd.resources.requests.memory |
在以下版本中引入：1.0.0 默认值： 在 Kubernetes 容器中资源正常运行所需的内存，以兆比字节为单位。 |
udca.image.pullPolicy |
在以下版本中引入：1.0.0 默认值：IfNotPresent 确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括：
如需了解详情，请参阅更新映像。 |
udca.image.tag |
在以下版本中引入：1.0.0 默认值： 此服务 Docker 映像的版本标签。 |
udca.image.url |
在以下版本中引入：1.0.0 默认值： 此服务的 Docker 映像的位置。 |
udca.jvmXms |
在以下版本中引入：1.0.0 默认值： 数据收集 pod JVM 的内存量。 |
udca.jvmXmx |
在以下版本中引入：1.0.0 默认值： 数据收集 pod 的 JVM 的最大内存分配。 |
udca.livenessProbe.failureThreshold |
在以下版本中引入：1.0.0 默认值： Kubernetes 将验证重启容器前，活跃探测失败的次数。最小值为 1。 |
udca.livenessProbe.initialDelaySeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测启动前，容易开始后经过的秒数。 |
udca.livenessProbe.periodSeconds |
在以下版本中引入：1.0.0 默认值： 确定执行活跃探测的频率，以秒为单位。最小值为 1。 |
udca.livenessProbe.timeoutSeconds |
在以下版本中引入：1.0.0 默认值： 活跃探测超时后的秒数。最小值为 1。 |
udca.nodeSelector.key |
在以下版本中引入：1.0.0 默认值：None 必需 节点选择器标签键，用于定位 请参阅配置专用节点池。 |
udca.nodeSelector.value |
在以下版本中引入：1.0.0 默认值：None 必需 节点选择器标签值，用于定位 请参阅配置专用节点池。 |
udca.pollingIntervalInSec |
在以下版本中引入：1.0.0 默认值： UDCA 轮询操作之间等待的时长，以秒为单位。UDCA 轮询数据收集 pod 文件系统上的数据目录，以检测要上传的新文件。 |
udca.replicaCountMax |
在以下版本中引入：1.0.0 默认值： 混合可为 UDCA 部署自动添加的 pod 数上限。由于 UDCA 是作为 ReplicaSet 实现的，因此 pod 是副本。 |
udca.replicaCountMin |
在以下版本中引入：1.0.0 默认值： UDCA 部署的 pod 数下限。由于 UDCA 是作为 ReplicaSet 实现的，因此 pod 是副本。 如果 CPU 使用率高于 |
udca.resources.requests.cpu |
在以下版本中引入：1.0.0 默认值： Kubernetes 容器中资源正常运行所需的 CPU，以毫秒为单位。 |
udca.revision |
在以下版本中引入：1 默认值： 填充到标签页中可启用 Canary 部署的静态值。 |
udca.serviceAccountPath |
在以下版本中引入：1.0.0 默认值：None 必须提供 具有 Apigee Analytics Agent 角色的 Google 服务账号密钥文件的路径。 |
udca.serviceAccountRef |
在以下版本中引入：1.2.0 默认值：None 必须提供 |
udca.targetCPUUtilizationPercentage |
在以下版本中引入：1.0.0 默认值： 用于扩缩 ReplicaSet 中 pod 数量的 CPU 使用率的阈值，表示为占可用 CPU 资源的百分比。混合使用数据收集 pod（fluentd 和 UDCA）中所有容器的组合利用率来计算当前利用率。 当 CPU 使用率超过此值时，混合将逐步增加 ReplicaSet 中的 pod 数，最高可达 |
udca.terminationGracePeriodSeconds |
在以下版本中引入：1.0.0 默认值： 请求删除 Pod 与终止 Pod 之间的时间，以秒为单位。在此期间，将执行任何预停止钩子，并且所有正在运行的进程都应正常终止。 |
virtualhosts
virtualhosts 属性是必需的配置属性。虚拟主机允许 Apigee Hybrid 处理向指定环境组发送的 API 请求。
如需了解详情，请参阅配置虚拟主机。
下表介绍了 virtualhosts 对象的属性：
| 属性 | 说明 |
|---|---|
virtualhosts[].additionalGateways |
在以下版本中引入：1.2.0 默认值：None 要将流量路由到的 Istio Gateway 列表。 |
virtualhosts[].name |
在以下版本中引入：1.2.0 默认值：None 必需 虚拟主机的名称。 |
virtualhosts[].hostAliases[] |
在以下版本中引入：1.2.0 默认值：None 必需 Deprecated：从 Hybrid 1.4 版开始，运行时平面会从管理平面接收此信息。请参阅环境和环境组简介。 |
virtualhosts[].maxTLSProtocolVersion |
在以下版本中引入：1.3.0 默认值：None Envoy 可以选择的 TLS 协议的最高版本。Envoy 自动使用 该值必须采用数字形式。例如：
virtualhosts:
- name: default
maxTLSProtocolVersion: "1.3"
其中数字表示 TLS 版本号，格式为 另请参阅 Istio 文档中的 |
virtualhosts[].minTLSProtocolVersion |
在以下版本中引入：1.3.0 默认值：None Envoy 可以选择的 TLS 协议的最低版本。Envoy 自动使用 该值必须采用数字形式。例如：
virtualhosts:
- name: default
minTLSProtocolVersion: "1.2"
其中数字表示 TLS 版本号，格式为 另请参阅 Istio 文档中的 |
virtualhosts[].selector |
在以下版本中引入：1.2.0 默认值： 必需 指向不同入站流量选择器的键值选择器值对。 |
virtualhosts[].sslCertPath |
在以下版本中引入：1.2.0 默认值：None 必须提供
系统上指向 TLS 证书文件的路径。 |
virtualhosts[].sslKeyPath |
在以下版本中引入：1.2.0 默认值：None 必须提供
在系统上指向 TLS 私钥文件的路径。 |
virtualhosts[].sslSecret |
在以下版本中引入：1.2.0 默认值：None 必须提供
包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。 另请参阅：
|
watcher
watcher 属性是必需的配置属性。watcher 是一个监视配置更改并触发将更改应用到运行时平面的进程。
下表介绍了 watcher 对象的属性：
| 属性 | 说明 |
|---|---|
watcher.annotations |
在以下版本中引入：1.5.0 默认值：None 用于为 pod 添加注释的可选键值对映射。如需了解详情，请参阅自定义注释。 |
watcher.replicaCountMax |
在以下版本中引入：1.3.0 默认值： watcher 副本数上限。为避免冲突，应将此文件保留在 |
watcher.replicaCountMin |
在以下版本中引入：1.3.0 默认值： watcher 副本数下限。 |
watcher.serviceAccountPath |
在以下版本中引入：1.3.0 默认值：None 必填。 具有 Apigee Runtime Agent 角色的 Google 服务账号密钥文件的路径。 |
watcher.serviceAccountRef |
在以下版本中引入：1.3.0 默认值：None 必须提供 serviceAccountPath 或 serviceAccountRef。 |