配置属性参考文档

本部分列出了可用于自定义 Apigee 混合部署的运行时平面的所有配置属性。

过滤此页面

如需过滤此页面中显示的属性,请选择基本(最常见的属性)或高级(很少需要更改的属性):

显示   此页面上的配置属性。

顶层属性

下表描述了 overrides.yaml 文件中的顶层属性。以下属性不属于其他对象,并应用于组织或环境级别:

属性 类型 说明
axHashSalt 高级

在以下版本中引入:1.3.0

默认值:您的组织名称

可选

Kubernetes Secret 的名称,其中包含在计算哈希值时使用的盐值,以在将用户数据发送到 Apigee Analytics 之前混淆用户数据。如果您未指定盐值,则默认使用 iloveapis123。使用盐值作为输入来创建 Secret。您可以对多个集群使用相同的盐,以确保集群之间的哈希结果保持一致。

Apigee 会先使用 SHA512 对原始值进行哈希处理,然后再将数据从运行时平面发送到控制平面。

请参阅对用户数据进行混淆处理以用于分析

contractProvider 高级 在以下版本中引入:1.0.0

默认值:https://apigee.googleapis.com

定义安装中所有 API 的 API 路径。

gcpProjectID 高级 Deprecated: 对于 1.2.0 版及更高版本,请改用 gcp.projectID

在以下版本中引入:1.0.0

默认值:none

必需

您的 Google Cloud 项目的 ID。与 k8sClusterName(已弃用)和 gcpRegion(已弃用)搭配使用,用于标识项目并确定 apigee-loggerapigee-metrics 推送其数据的位置。

gcpRegion 高级 Deprecated: 对于 1.2.0 版及更高版本,请改用 gcp.region

在以下版本中引入:1.0.0

默认值:us-central1

必需

您的 Kubernetes 集群的秘密 Google Cloud 区域或可用区。与 gcpProjectID(已弃用)和 k8sClusterName(已弃用)搭配使用,用于标识项目并确定 apigee-loggerapigee-metrics 推送其数据的位置。

hub 高级 在以下版本中引入:1.11.0

默认值:None

仅限 Helm:用于从私有仓库中拉取所有 Apigee 组件的映像的私有映像容器仓库网址。

hub 提供所有 Apigee Hybrid 组件的默认路径。如果您使用的是私有仓库,请使用 hub 为所有组件设置仓库网址,而不是为每个组件使用单独的 image.url 属性。仅当您为特定组件使用单独的仓库时,才配置各个网址。

每个组件的映像路径是 hub 的值加上组件的映像名称和标记。

例如,如果值为 hub private-docker-host.example.com,则各个组件会自动将映像路径:

hub: private-docker-host.example.com

解析为:

## an example of internal component vs 3rd party
containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.11.2
  imagePullPolicy: IfNotPresent

containers:
- name: apigee-ingressgateway
  image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.26-distroless
  imagePullPolicy: IfNotPresent

其他组件遵循类似的模式。

使用 apigee-pull-push --list 查看所有组件的当前仓库网址。

请参阅使用 Helm 处理私有映像仓库

您可以使用以下属性单独替换组件的映像网址:

imagePullSecrets.name 高级 在以下版本中引入:1.0.0

默认值:None

配置为 docker-registry 类型的 Kubernetes 秘密名称;用于从私有代码库中提取映像。

instanceID 基本 在以下版本中引入:1.3.0

默认值:None

必需

此安装的唯一标识符。

用于标识此实例的唯一字符串。该 ID 可以是字母和数字的任意组合,长度不得超过 63 个字符。

k8sClusterName 高级 Deprecated: 对于 1.2.0 版及更高版本,请改用 k8sCluster.namek8sCluster.region

在以下版本中引入:1.0.0

默认值:None

您的混合项目正在运行的 Kubernetes (K8S) 专业集群名称。与 gcpProjectID(已弃用)和 gcpRegion(已弃用)搭配使用,用于标识项目并确定 apigee-loggerapigee-metrics 推送其数据的位置。

kmsEncryptionKey 高级 在以下版本中引入:1.0.0

默认值:defaults.org.kmsEncryptionKey

可选。仅使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 之一。

Apigee KMS 数据加密密钥的本地文件系统路径。

kmsEncryptionPath 高级 在以下版本中引入:1.2.0

默认值:None

可选。仅使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 之一。

包含 base64 编码的加密密钥的文件的路径。请参阅数据加密

kmsEncryptionSecret.key 高级 在以下版本中引入:1.2.0

默认值:None

可选。仅使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 之一。

包含 base64 编码的加密密钥的 Kubernetes Secret 的密钥。请参阅数据加密

kmsEncryptionSecret.name 高级 在以下版本中引入:1.2.0

默认值:None

可选。仅使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 之一。

包含 base64 编码的加密密钥的 Kubernetes Secret 的名称。请参阅数据加密

kvmEncryptionKey 高级 在以下版本中引入:1.0.0

默认值:defaults.org.kmsEncryptionKey

可选。仅使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 之一。

Apigee KVM 数据加密密钥的本地文件系统路径。

kvmEncryptionPath 高级 在以下版本中引入:1.2.0

默认值:None

可选。仅使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 之一。

包含 base64 编码的加密密钥的文件的路径。请参阅数据加密

kvmEncryptionSecret.key 高级 在以下版本中引入:1.2.0

默认值:None

可选。仅使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 之一。

包含 base64 编码的加密密钥的 Kubernetes Secret 的密钥。请参阅数据加密

kvmEncryptionSecret.name 高级 在以下版本中引入:1.2.0

默认值:None

可选。仅使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 之一。

包含 base64 编码的加密密钥的 Kubernetes Secret 的名称。请参阅数据加密

multiOrgCluster 高级 在以下版本中引入:1.10.0

默认值:false

对于多组织集群,此属性可让您将组织的指标导出到 gcp.projectID 属性中列出的项目。 在多组织集群中每个组织的替换文件中应用此设置。如需了解详情,请参阅将多个 Hybrid 组织添加到集群

namespace 基本 在以下版本中引入:1.0.0

默认值:apigee

将安装 Apigee 组件的 Kubernetes 集群的命名空间。

org 基本

在以下版本中引入:1.0.0

默认值:None

必需

混合启用组织,由 Apigee 在混合安装期间为您预配。组织是 Apigee 中的顶层容器。它包含您的所有 API 代理及相关资源。如果值为空,则必须在创建后将其更新为组织名称。

orgScopedUDCA 高级 在以下版本中引入:1.8.0

默认值:true

在组织级别启用通用数据收集代理服务 (UDCA),以提取分析、获利和调试(跟踪)并将其发送到控制平面中的统一分析平台 (UAP)。

组织级 UDCA 在所有 Apigee 环境中都使用一个 Google 服务账号。该服务账号需要具有 Apigee Analytics Agent (roles/apigee.analyticsAgent) 角色。

使用 udca.serviceAccountPath 属性指定服务账号密钥文件的路径或在 overrides.yaml 配置文件中使用 udca.serviceAccountRef 属性提供 Kubernetes Secret 中的密钥。

如果您希望为每个环境使用单独的 UDCA 代理,请设置 orgScopedUDCA: false 并为 envs[].serviceAccountPaths.udcaenvs[].serviceAccountSecretRefs.udca 设置值。

另请参阅:udca

revision 高级 在以下版本中引入:1.0.0

默认值"1112"(不包含句点的 Apigee Hybrid 版本)。例如,对于 1.11.0 版,默认值为 "1110"。)

Apigee Hybrid 支持滚动 Kubernetes 更新,让部署更新可以通过用新的逐步更新 Pod 实例来实现零停机时间。

在更新可能导致底层 Kubernetes PodTemplateSpec 更改的特定 YAML 覆盖时,还必须在客户的 override.yaml 中更改 revision 替换属性。对于底层 Kubernetes ApigeeDeployment (AD) 控制器,必须执行此操作才能执行从上一个版本到新版本的安全滚动更新。您可以使用任意小写文本值,例如:bluea1.0.0

更改并应用 revision 属性后,将针对所有组件执行滚动更新

更改以下对象的属性时,需要更新 revision

如需了解详情,请参阅滚动更新

validateOrg 高级 在以下版本中引入:1.8.0

默认值:true

启用对 Apigee 组织与 Google Cloud 项目之间的关联的严格验证,并检查是否存在环境组。

另请参阅 org

validateServiceAccounts 高级 在以下版本中引入:1.0.0

默认值:true

对服务账号权限启用严格验证。这使用 Cloud Resource Manager API 方法 testIamPermissions 来验证所提供的服务账号是否具备所需的权限。对于 Apigee 组织服务账号,项目 ID 检查就是映射到组织的。对于 Metrics 和 Logger,所检查的项目基于 gcpProjectID overrides.yaml 配置。

另请参阅 gcpProjectID

ao

Apigee Operators (AO) 创建和更新部署和维护组件所需的低级 Kubernetes 和 Istio 资源。例如,控制器会执行消息处理器的发布。

下表介绍了 apigee-operators ao 对象的属性:

属性 类型 说明
ao.args.disableIstioConfigInAPIServer 高级 在以下版本中引入:1.8.0

默认值:true

阻止 Apigee 向客户安装的 ASM 提供配置。

  • 对于使用 Apigee 入站流量网关的 Hybrid 安装,设置为 true
  • 对于使用 Anthos Service Mesh(Apigee Hybrid 1.8 版及更早版本)的 Hybrid 安装,设置为 false
ao.args.disableManagedClusterRoles 高级 在以下版本中引入:1.10.0

默认值:true

如果为 true(默认值),Apigee Hybrid 不会直接管理 Kubernetes ClusterRoleClursterRoleBinding。如果您的进程需要管理这些资源,则此进程必须由具有正确权限的用户执行。

ao.image.pullPolicy 高级 在以下版本中引入:1.2.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

ao.image.tag 高级 在以下版本中引入:1.2.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

ao.image.url 高级 在以下版本中引入:1.2.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

ao.installer.pullPolicy 高级 在以下版本中引入:1.3.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

ao.installer.tag 高级 在以下版本中引入:1.3.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

ao.installer.url 高级 在以下版本中引入:1.3.0

默认值:gcr.io/apigee-release/hybrid/apigee-installer

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

ao.resources.limits.cpu 高级 在以下版本中引入:1.2.0

默认值:250m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

ao.resources.limits.memory 高级 在以下版本中引入:1.2.0

默认值:256Mi

Kubernetes 容器中资源的内存限制,以字节为单位。

ao.resources.requests.cpu 高级 在以下版本中引入:1.2.0

默认值:250m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

ao.resources.requests.memory 高级 在以下版本中引入:1.2.0

默认值:256Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

ao.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

ao.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

ao.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

ao.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

ao.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

apigeeIngressGateway

为 Apigee Hybrid 配置 Apigee 入站流量网关。 使用 apigeeIngressGateway 属性可以将通用配置应用于 Apigee 入站流量网关的所有实例。

请参阅 ingressGateways 以为各个实例设置不同的配置。

如果您使用 Helm 管理 Apigee Hybrid,请使用 apigee-org 图表将更改应用于 apigeeIngressGateway 属性。

下表介绍了 apigeeIngressGateway 对象的属性:

属性 类型 说明
apigeeIngressGateway.image.pullPolicy 高级 在以下版本中引入:1.11.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

apigeeIngressGateway.image.tag 高级 在以下版本中引入:1.11.0

默认值:1.18.7-asm.26-distroless

此服务 Docker 映像的版本标签。

apigeeIngressGateway.image.url 高级 在以下版本中引入:1.11.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

apigeeIngressGateway.nodeSelector.key 高级 在以下版本中引入:1.11.0

默认值:None

必需

节点选择器标签键,用于定位入站流量网关服务的专用 Kubernetes 节点。

请参阅配置专用节点池

apigeeIngressGateway.nodeSelector.value 高级 在以下版本中引入:1.11.0

默认值:None

可选的节点选择器标签值,用于定位入站流量网关服务的专用 Kubernetes 节点并替换 nodeSelector.apigeeData 设置。

请参阅 nodeSelector

apigeeIngressGateway.replicaCountMax 基本 在以下版本中引入:1.11.0

默认值:4

Hybrid 可以为可用于自动缩放的入口流量网关自动添加的最大 Pod 数量。

apigeeIngressGateway.replicaCountMin 基本 在以下版本中引入:1.11.0

默认值:2

可用于自动扩缩的入站流量网关的 Pod 数下限。

apigeeIngressGateway.targetCPUUtilizationPercentage 高级 在以下版本中引入: 1.10.5, 1.11.2

默认值:75

用于扩缩 ReplicaSet 中 pod 数量的 CPU 使用率的阈值,表示为占可用 CPU 资源的百分比。

当 CPU 使用率超过此值时,混合将逐步增加 ReplicaSet 中的 pod 数,最高可达 apigeeIngressGateway.replicaCountMax

如需详细了解如何在 Kubernetes 中进行扩缩,请参阅 Kubernetes 文档中的 Pod 横向自动扩缩部分。

apigeeIngressGateway.tolerations.effect 高级 在以下版本中引入:1.11.0

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

apigeeIngressGateway.tolerations.key 高级 在以下版本中引入:1.11.0

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

apigeeIngressGateway.tolerations.operator 高级 在以下版本中引入:1.11.0

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

apigeeIngressGateway.tolerations.tolerationSeconds 高级 在以下版本中引入:1.11.0

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

apigeeIngressGateway.tolerations.value 高级 在以下版本中引入:1.11.0

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

cassandra

定义管理运行时数据存储区的混合服务。此存储区存储在网关上运行的应用存储应用配置、分配的配额计数器、API 密钥和 OAuth 令牌。

如需了解详情,请参阅 StorageClass 配置

下表介绍了 cassandra 对象的属性:

属性 类型 说明
cassandra.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

cassandra.auth.admin.password 基本 在以下版本中引入:1.0.0

默认值:iloveapis123

必需

Cassandra 管理员的密码。管理员用户用于在 Cassandra 集群上执行的任何管理活动,例如备份和恢复。

cassandra.auth.ddl.password 基本 在以下版本中引入:1.0.0

默认值:iloveapis123

必需

Cassandra 数据定义语言 (DDL) 用户的密码。MART 用于任何数据定义任务,例如键空间创建、更新和删除。

cassandra.auth.default.password 基本 在以下版本中引入:1.0.0

默认值:iloveapis123

必需

启用身份验证时创建的默认 Cassandra 用户密码。配置 Cassandra 身份验证时,必须重置此密码。请参阅为 Cassandra 配置 TLS

cassandra.auth.dml.password 基本 在以下版本中引入:1.0.0

默认值:iloveapis123

必需

Cassandra 数据操纵语言 (DML) 用户的密码。DML 用户供客户端通信读取和向 Cassandra 写入数据。

cassandra.auth.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

cassandra.auth.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

cassandra.auth.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

cassandra.auth.jmx.password 基本 在以下版本中引入:1.4.0

默认值:iloveapis123

必需

Cassandra JMX 操作用户的密码。用于通过 Cassandra JMX 接口进行身份验证和通信。

cassandra.auth.jmx.username 基本 在以下版本中引入:1.4.0

默认值:jmxuser

必需

Cassandra JMX 操作用户的用户名。用于通过 Cassandra JMX 接口进行身份验证和通信。

cassandra.auth.jolokia.password 基本 在以下版本中引入:1.4.0

默认值:iloveapis123

必需

Cassandra Jolokia JMX 操作用户的密码。用于向 Cassandra JMX API 进行身份验证和通信。

cassandra.auth.jolokia.username 基本 在以下版本中引入:1.4.0

默认值:apigee

必需

Cassandra Jolokia JMX 操作用户的用户名。用于向 Cassandra JMX API 进行身份验证和通信。

cassandra.auth.secret 基本 在以下版本中引入:1.3.3

默认值:None

存储在包含 Cassandra 用户和密码的 Kubernetes Secret 中的文件的名称。您可以按照以下说明创建 Secret:创建 Secret

另请参阅:

cassandra.auth.secretProviderClass 高级 在以下版本中引入:1.10.3

默认值:None

Cassandra Secret 存储政策。设置后,它必须与引用外部 Secret 提供程序(例如 Hashicorp Vault)的 SecretProviderClass 匹配。如果未设置,Apigee Hybrid 会使用存储在以下位置的用户名和密码:

或存储在以下位置的 Kubernetes Secret:

如需查看创建政策的说明,请参阅在 Hashicorp Vault 中存储 Cassandra Secret

cassandra.backup.cloudProvider 高级 在以下版本中引入:1.0.0

默认值:GCP

备份提供方的名称。支持的值:GCPHYBRIDCSI。将值设置为:

  • GCP 以在 Google Cloud Storage 上存储备份归档。
  • HYBRID,用于在远程 SSH 服务器上存储备份归档。
  • CSI(推荐),用于利用 Kubernetes CSI 卷快照进行备份。如需了解适用于 Google Cloud、AWS 和 Azure 等云平台的 CSI 备份和恢复,请参阅 CSI 备份和恢复
cassandra.backup.dbStorageBucket 高级 在以下版本中引入:1.0.0

默认值:None

如果已启用备份且 cassandra.backup.cloudProvider 设置为 GCP,则为必需。

必须采用 gs://BUCKET_NAME 格式(必须使用 gs:// 前缀)。

将用于存储备份归档的现有 Google Cloud Storage 存储桶的名称。如果您需要创建存储桶,请参阅创建存储桶

cassandra.backup.enabled 高级 在以下版本中引入:1.0.0

默认值:false

默认情况下,数据备份未启用。 要启用该功能,请设置为 true

请参阅 Cassandra 备份和恢复

cassandra.backup.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

cassandra.backup.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

cassandra.backup.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

cassandra.backup.keyfile 高级 在以下版本中引入:1.3.0

默认值:None

如果已启用备份且 cassandra.backup.cloudProvider 设置为 HYBRID,则为必需。

SSH 私钥文件在本地文件系统中的路径。

cassandra.backup.schedule 高级 在以下版本中引入:1.0.0

默认值:0 2 * * *

备份 Cron 作业的时间表。

请参阅 Cassandra 备份和恢复

cassandra.backup.server 高级 在以下版本中引入:1.3.0

默认值:None

如果已启用备份且 cassandra.backup.cloudProvider 设置为 HYBRID,则为必需。

远程 SSH 备份服务器的 IP 地址。

cassandra.backup.serviceAccountPath 高级 在以下版本中引入:1.0.0

默认值:None

具有 Storage Object Admin (roles/storage.objectAdmin) 角色的 Google 服务账号密钥文件的路径。此 Google 服务账号将会用于将备份归档上传到指定的 cassandra.backup.dbStorageBucket

如果已启用备份并将 cassandra.backup.cloudProvider 设置为 GCP,则需要执行以下操作之一才能确保 Apigee Hybrid 可以访问 Google Cloud Storage 存储桶以上传备份归档

cassandra.backup.serviceAccountRef 高级 在以下版本中引入:1.2.0

默认值:None

现有 Kubernetes Secret 的名称,该 Secret 用于存储具有 Storage Object Admin (roles/storage.objectAdmin) 角色的 Google 服务账号密钥文件的内容。此 Google 服务账号将会用于将备份归档上传到指定的 cassandra.backup.dbStorageBucket

如果已启用备份并将 cassandra.backup.cloudProvider 设置为 GCP,则需要执行以下操作之一才能确保 Apigee Hybrid 可以访问 Google Cloud Storage 存储桶以上传备份归档

cassandra.backup.storageDirectory 高级 在以下版本中引入:1.3.0

默认值:None

如果已启用备份且 cassandra.backup.cloudProvider 设置为 HYBRID,则为必需。

可以是指向 apigee 用户主目录的绝对路径或相对路径。

备份 SSH 服务器上备份目录的名称。

cassandra.clusterName 基础 在以下版本中引入:1.0.0

默认值:apigeecluster

指定 Cassandra 集群的名称。

cassandra.datacenter 基本 在以下版本中引入:1.0.0

默认值:dc-1

指定 Cassandra 节点的数据中心。

cassandra.dnsPolicy 基本 在以下版本中引入:1.1.1

默认值:None

hostNetwork 设置为 true 时,DNS 政策会设置为 ClusterFirstWithHostNet

cassandra.externalSeedHost 基本 在以下版本中引入:1.0.0

默认值:None

Cassandra 集群节点的主机名或 IP。如果未设置,则使用 Kubernetes 本地服务。

cassandra.heapNewSize 基本 在以下版本中引入:1.0.0

默认值:100M

分配给较新对象的 JVM 系统内存量,以兆字节为单位。

cassandra.hostNetwork 基本 在以下版本中引入:1.1.1

默认值:false

启用 Kubernetes hostNetwork 功能。如果集群之间的 pod 网络命名空间没有连接(集群在“孤岛网络模式”下运行),则 Apigee 会在多区域安装中使用此功能在 pod 之间进行通信。前者是非 GKE 安装中的默认情况,包括 GKE On-Prem、GKE on AWS、Anthos on Bare Metal、AKS、EKS 和 OpenShift。

对于单区域安装和不同集群的 pod 间有连接的多区域安装(例如 GKE 安装),将 cassandra.hostNetwork 设置为 false

对于不同集群的 pod 之间没有通信的多区域安装(例如 GKE On-Prem、GKE on AWS、Anthos on Bare Metal、AKS、EKS 和 OpenShift 安装),将 cassandra.hostNetwork 设置为 true。请参阅多区域部署:前提条件

true 时,DNS 政策会自动设置为 ClusterFirstWithHostNet

cassandra.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

cassandra.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

cassandra.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

cassandra.maxHeapSize 高级 在以下版本中引入:1.0.0

默认值:512M

可用于 Cassandra 操作的 JVM 系统内存的上限(以 MB 为单位)。

cassandra.multiRegionSeedHost 基本 在以下版本中引入:1.0.0

默认值:None

现有 Cassandra 集群的 IP 地址,用于将现有集群扩展到新地区。请参阅配置多区域种子主机

cassandra.nodeSelector.key 高级 在以下版本中引入:1.0.0

默认值:None

必需

节点选择器标签键,用于定位 cassandra 数据服务的专用 Kubernetes 节点。

请参阅配置专用节点池

cassandra.nodeSelector.value 高级 在以下版本中引入:1.0.0

默认值:None

可选的节点选择器标签值,用于定位 cassandra 数据服务的专用 Kubernetes 节点并替换 nodeSelector.apigeeData 设置。

请参阅 nodeSelector

cassandra.port 高级 在以下版本中引入:1.0.0

默认值:9042

用于连接到 Cassandra 的端口号。

cassandra.rack 基本 在以下版本中引入:1.0.0

默认值:ra-1

指定 Cassandra 节点的 Rack。

cassandra.readinessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证将 Pod 标记为“未就绪”前,就绪探测失败的次数。最小值为 1。

cassandra.readinessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:0

就绪探测启动前,容易开始后经过的秒数。

cassandra.readinessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:10

确定执行就绪探测的频率,以秒为单位。最小值为 1。

cassandra.readinessProbe.successThreshold 高级 在以下版本中引入:1.0.0

默认值:1

在失败后,被认为成功就绪探测需要的最小持续成功次数。最小值为 1。

cassandra.readinessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:5

活跃探测超时后的秒数。最小值为 1。

cassandra.replicaCount 基础 在以下版本中引入:1.0.0

默认值:1

Cassandra 是一个副本数据库。此属性用于指定用作 StatefulSet 的 Cassandra 节点的数量。

cassandra.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:500m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

cassandra.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值:1Gi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

cassandra.restore.cloudProvider 高级 在以下版本中引入:1.0.0

默认值:GCP

恢复提供方的名称。支持的值:GCPHYBRIDCSI。将值设置为:

  • GCP 用于从存储在 Google Cloud Storage 中的备份恢复数据。
  • HYBRID,用于从存储在远程 SSH 服务器上的备份恢复数据。
  • CSI(推荐),用于利用 Kubernetes CSI 卷快照进行恢复。如需了解适用于 Google Cloud、AWS 和 Azure 等云平台的 CSI 备份和恢复,请参阅 CSI 备份和恢复
cassandra.restore.dbStorageBucket 高级 在以下版本中引入:1.0.0

默认值:None

如果已启用恢复且 cassandra.restore.cloudProvider 设置为 GCP,则为必需。

必须采用 gs://BUCKET_NAME 格式(必须使用 gs:// 前缀)。

存储要用于数据恢复的备份归档的 Google Cloud Storage 存储桶的名称。

cassandra.restore.enabled 高级 在以下版本中引入:1.0.0

默认值:false

数据恢复功能默认未启用。要启用该功能,请设置为 true

请参阅 Cassandra 备份和恢复

cassandra.restore.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

cassandra.restore.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

cassandra.restore.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

cassandra.restore.serviceAccountPath 高级 在以下版本中引入:1.0.0

默认值:None

具有 Storage Object Admin (roles/storage.objectAdmin) 角色的 Google 服务账号密钥文件的路径。此 Google 服务账号将会用于从指定的 cassandra.restore.dbStorageBucket 下载备份归档。

如果已启用恢复功能,并且 cassandra.restore.cloudProvider 已设为 GCP,则必须满足以下条件之一,以确保 Apigee Hybrid 能够访问 Google Cloud Storage 存储桶以下载备份归档进行恢复:

cassandra.restore.serviceAccountRef 高级 在以下版本中引入:1.2.0

默认值:None

现有 Kubernetes Secret 的名称,该 Secret 用于存储具有 Storage Object Admin (roles/storage.objectAdmin) 角色的 Google 服务账号密钥文件的内容。此 Google 服务账号将会用于从指定的 cassandra.restore.dbStorageBucket 下载备份归档。

如果已启用恢复功能,并且 cassandra.restore.cloudProvider 已设为 GCP,则必须满足以下条件之一,以确保 Apigee Hybrid 能够访问 Google Cloud Storage 存储桶以下载备份归档进行恢复:

cassandra.restore.snapshotTimestamp 高级 在以下版本中引入:1.0.0

默认值:None

如果恢复已启用,则必须提供。

应恢复的备份的时间戳。

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

默认值:10Gi

如果指定了 storage.storageclass,则必须使用此属性

指定所需的磁盘大小,以兆比字节 (Mi) 或吉比字节 (Gi) 为单位。

cassandra.storage.storageclass 基本 在以下版本中引入:1.0.0

默认值:None

指定正在使用的本地存储空间类别。

cassandra.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:300

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

cassandra.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

cassandra.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

cassandra.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

cassandra.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

cassandra.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

certManager

Apigee 使用 cert-manager 进行证书验证。

下表介绍了 certManager 对象的属性:

属性 类型 说明
certManager.namespace 高级 在以下版本中引入:1.9.0

默认值:cert-manager

cert-manager 的命名空间。

请参阅在自定义命名空间中运行 cert-manager

connectAgent

Apigee Connect 让 Apigee Hybrid 管理平面可安全地连接到运行时平面中的 MART 服务,而无需在互联网上公开 MART 端点。

请参阅 Apigee Connect

下表介绍了 connectAgent 对象的属性:

属性 类型 说明
connectAgent.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

connectAgent.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,connectAgent 用于与相应的 Kubernetes 服务账号关联的 Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

connectAgent.logLevel 高级 在以下版本中引入:1.2.0

默认值:INFO

日志报告的级别。包含以下值:

  • INFO:除了警告、错误和严重消息之外的参考消息。最适用于调试。
  • WARNING:除错误消息和严重消息外的非严重警告。
  • ERROR:除了严重消息外,不会返回给用户的内部错误和错误。
  • FATAL:可能会导致 Apigee Connect 崩溃且不可恢复的错误和事件。
connectAgent.image.pullPolicy 高级 在以下版本中引入:1.2.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

connectAgent.image.tag 高级 在以下版本中引入:1.2.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

connectAgent.image.url 高级 在以下版本中引入:1.2.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

connectAgent.replicaCountMax 基本 在以下版本中引入:1.2.0

默认值:5

可用于自动扩缩的副本数上限。

connectAgent.replicaCountMin 基本 在以下版本中引入:1.2.0

默认值:1

可自动扩缩的副本数下限。

在生产环境中,您可能需要将 replicaCountMin 增加到 1,以便增加与控制平面的连接数量,从而实现可靠性和可伸缩性。

connectAgent.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:512m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

connectAgent.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:512Mi

Kubernetes 容器中资源的内存限制,以字节为单位。

connectAgent.resources.requests.cpu 高级 在以下版本中引入:1.11.0

默认值:100m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

connectAgent.resources.requests.memory 高级 在以下版本中引入:1.2.0

默认值:30Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

connectAgent.server 高级 在以下版本中引入:1.2.0

默认值:apigeeconnect.googleapis.com:443

此服务的服务器和端口的位置。

connectAgent.serviceAccountPath 基本 在以下版本中引入:1.1.1

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

apigee-mart 服务账号的 Google 服务账号密钥文件的路径。

在大多数安装中,connectAgent.serviceAccountPath 的值必须与 mart.serviceAccountPath 的值匹配。

connectAgent.serviceAccountRef 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

在大多数安装中,connectAgent.serviceAccountRef 的值必须与 mart.serviceAccountRef 的值匹配。

connectAgent.targetCPUUtilizationPercentage 高级 在以下版本中引入:1.2.0

默认值:75

pod 上 Apigee Connect 代理的目标 CPU 利用率。在 CPU 利用率达到此值(最多 replicaCountMax)时,此字段值启用 Apigee Connect 以自动扩缩。

connectAgent.terminationGracePeriodSeconds 高级 在以下版本中引入:1.2.0

默认值:600

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

connectAgent.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

connectAgent.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

connectAgent.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

connectAgent.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

connectAgent.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

defaults

Apigee Hybrid 安装的默认加密密钥。

下表介绍了 defaults 对象的属性:

属性 类型 说明
defaults.org.kmsEncryptionKey 基本 在以下版本中引入:1.0.0

默认值:aWxvdmVhcGlzMTIzNDU2Nw==

KMS 中组织的默认加密密钥。

defaults.org.kvmEncryptionKey 基本 在以下版本中引入:1.0.0

默认值:aWxvdmVhcGlzMTIzNDU2Nw==

KVM 中组织的默认加密密钥。

defaults.env.kmsEncryptionKey 基本 在以下版本中引入:1.0.0

默认值:aWxvdmVhcGlzMTIzNDU2Nw==

KMS 中环境 (env) 的默认加密密钥。

defaults.env.kvmEncryptionKey 基本 在以下版本中引入:1.0.0

默认值:aWxvdmVhcGlzMTIzNDU2Nw==

KVM 中环境(env)的默认加密密钥。

defaults.env.cacheEncryptionKey 基本 在以下版本中引入:1.0.0

默认值:aWxvdmVhcGlzMTIzNDU2Nw==

环境 (env) 的默认缓存加密密钥。

diagnostic

诊断收集器工具的设置。

请参阅使用诊断收集器

下表介绍了 diagnostic 对象的属性:

属性 类型 说明
diagnostic.bucket 基本 在以下版本中引入:1.6.0

默认值:None

必需

用于存储诊断数据的 Google Cloud 存储桶的名称。

请参阅创建存储桶

diagnostic.container 基本 在以下版本中引入:1.6.0

默认值:None

必需

这用于指定要从中捕获数据的 pod 类型。这些值可以是以下值之一:

  • "apigee-cassandra" 会捕获 Cassandra 数据存储库的数据。istio-cassandra pod 在 apigee 命名空间中运行。
  • "apigee-mart-server" 会捕获有关 MART 的数据。apigee-mart-server pod 在 apigee 命名空间中运行。
  • "apigee-runtime" 会捕获有关消息处理器的数据。apigee-runtime pod 在 apigee 命名空间中运行。
  • "apigee-synchronizer" 会捕获有关同步器的数据。apigee-synchronizer pod 在 apigee 命名空间中运行。
  • "apigee-udca" 会捕获有关 UDCA 的数据。apigee-udca pod 在 apigee 命名空间中运行。
  • "apigee-watcher" 捕获有关 Watcher 的数据。apigee-watcher pod 在 apigee 命名空间中运行。
  • "istio-proxy" 会捕获有关 Istio 入站流量网关的数据。istio-proxy pod 在 istio-system 命名空间中运行。
diagnostic.loggingDetails.logDuration 基本 在以下版本中引入:1.6.0

默认值:None

如果诊断收集操作为“LOGGING”(使用 operation: "LOGGING" 设置)时为必需

收集的日志数据的时长(以毫秒为单位)。典型值为 30000

参见diagnostic.operation

diagnostic.loggingDetails.loggerNames[] 基本 在以下版本中引入:1.6.0

默认值:None

如果诊断收集操作为“LOGGING”(使用 operation: "LOGGING" 设置)时为必需

按名称指定从哪个日志记录器收集数据。对于 Apigee Hybrid 1.6.0 版,唯一支持的值是 ALL,即所有记录器。例如:

diagnostic:
 loggingDetails:
   loggerNames:
   - ALL
diagnostic.loggingDetails.logLevel 基本 在以下版本中引入:1.6.0

默认值:None

如果诊断收集操作为“LOGGING”(使用 operation: "LOGGING" 设置)时为必需

指定要收集的日志记录数据的粒度。在 Apigee Hybrid 1.6 中,仅支持 FINE

diagnostic.namespace 基本 在以下版本中引入:1.6.0

默认值:None

必需

您从中收集数据的 pod 所在的 Kubernetes 命名空间。命名空间必须是您使用 diagnostic.container 指定的容器的正确命名空间:

apigee

  • apigee-runtime
  • apigee-synchronizer
  • apigee-udca
  • apigee-watcher
  • apigee-cassandra
  • apigee-mart-server

istio-system

  • istio-proxy
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 角色 (roles/storage.admin) 的服务账号的密钥文件 (.json) 的路径。在大多数 Apigee Hybrid 安装中,这是 apigee-cassandra 服务账号。

请参阅服务账号简介

diagnostic.tcpDumpDetails.maxMsgs 基本 在以下版本中引入:1.6.0

默认值:None

如果使用 diagnostic.tcpDumpDetails,则必需选择diagnostic.tcpDumpDetails.maxMsgsdiagnostic.tcpDumpDetails.timeoutInSeconds

设置要收集的最大 tcpDump 消息数。Apigee 建议的最大值不超过 1000

diagnostic.tcpDumpDetails.timeoutInSeconds 基本 在以下版本中引入:1.6.0

默认值:None

如果使用 diagnostic.tcpDumpDetails,则必需选择diagnostic.tcpDumpDetails.maxMsgsdiagnostic.tcpDumpDetails.timeoutInSeconds

设置等待 tcpDump 返回消息的时间(以秒为单位)。

diagnostic.threadDumpDetails.delayInSeconds 基本 在以下版本中引入:1.6.0

默认值:None

如果您使用的是 diagnostic.threadDumpDetails,则 diagnostic.threadDumpDetails.delayInSecondsdiagnostic.threadDumpDetails.iterations必需的

收集每个线程转储之间的延迟时间(以秒为单位)。

diagnostic.threadDumpDetails.iterations 基本 在以下版本中引入:1.6.0

默认值:None

如果您使用的是 diagnostic.threadDumpDetails,则 diagnostic.threadDumpDetails.delayInSecondsdiagnostic.threadDumpDetails.iterations必需的

要收集的 jstack 线程转储迭代的次数。

envs

定义您可以部署 API 代理的环境数组。每个环境为运行 API 代理提供隔离上下文或沙盒

您的混合启用组织必须至少包含一个环境。

如需了解详情,请参阅环境简介

下表介绍了 envs 对象的属性:

属性 类型 说明
envs[].cacheEncryptionKey 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 之一。

base64 编码的加密密钥。请参阅数据加密

envs[].cacheEncryptionPath 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 之一。

包含 base64 编码的加密密钥的文件的路径。请参阅数据加密

envs[].cacheEncryptionSecret.key 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 之一。

包含 base64 编码的加密密钥的 Kubernetes Secret 的密钥。请参阅数据加密

envs[].cacheEncryptionSecret.name 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 之一。

包含 base64 编码的加密密钥的 Kubernetes Secret 的名称。请参阅数据加密

envs[].components.runtime.replicaCountMax 基本 在以下版本中引入:1.9.3

默认值:4

自动扩缩的副本数上限。 如果指定,则替换 runtime.replicaCountMax

envs[].components.runtime.replicaCountMin 基本 在以下版本中引入:1.9.3

默认值:1

自动扩缩的副本数下限。 如果指定,则替换 runtime.replicaCountMin

envs[].components.synchronizer.replicaCountMax 基本 在以下版本中引入:1.9.3

默认值:4

自动扩缩的副本数上限。 如果指定,则替换 synchronizer.replicaCountMax

envs[].components.synchronizer.replicaCountMin 基本 在以下版本中引入:1.9.3

默认值:1

自动扩缩的副本数下限。 如果指定,则替换 synchronizer.replicaCountMin

envs[].components.udca.replicaCountMax 基本 在以下版本中引入:1.9.3

默认值:4

自动扩缩的副本数上限。 如果指定,则替换 udca.replicaCountMax

envs[].components.udca.replicaCountMin 基本 在以下版本中引入:1.9.3

默认值:1

自动扩缩的副本数下限。 如果指定,则替换 udca.replicaCountMin

envs.gsa.runtime 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的运行时 Google IAM 服务账号的电子邮件地址。

请参阅 Enabling Workload Identity with Helm charts

envs.gsa.synchronizer 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的同步器 Google IAM 服务账号的电子邮件地址。

请参阅 Enabling Workload Identity with Helm charts

envs.gsa.udca 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,env 范围的 udca 用于与相应的 Kubernetes 服务账号关联的 udca Google IAM 服务账号的电子邮件地址。

请参阅 Enabling Workload Identity with Helm charts

envs[].hostAliases[] 基本 在以下版本中引入:1.2.0

默认值:None

Deprecated:从 Hybrid 1.4 版开始,运行时平面会从管理平面接收此信息。请参阅环境和环境组简介

envs[].httpProxy.host 基本 在以下版本中引入:1.2.0

默认值:None

指定运行 HTTP 代理的主机名或 IP 地址。

schemehostport 的顺序列出 httpProxy 属性。例如:

envs:
  - name: test
    httpProxy:
      scheme: HTTP
      host: 10.12.0.47
      port: 3128
      ...

另请参阅:为 API 代理配置转发代理

envs[].httpProxy.port 基本 在以下版本中引入:1.2.0

默认值:None

指定运行 HTTP 代理的端口。如果省略此属性,默认情况下,它将使用端口 80(用于 HTTP)和端口 443(用于 HTTPS)。

envs[].httpProxy.scheme 基本 在以下版本中引入:1.2.0

默认值:HTTPS

将 HTTP 代理的类型指定为 HTTP 或 HTTPS。默认情况下,它使用 HTTPS

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 服务账号(通常是 apigee-runtime 服务账号)密钥的本地系统文件路径。请参阅关于服务账号,了解服务账号的默认名称及其分配的角色。

envs[].serviceAccountPaths.synchronizer 基本 在以下版本中引入:1.0

默认值:None

具有 Apigee Synchronizer Manager 角色的 Google 服务账号密钥本地系统文件的路径。

envs[].serviceAccountPaths.udca 基本 在以下版本中引入:1.0

默认值:None

具有 Apigee Analytic Agent 角色的 Google 服务账号密钥本地系统文件的路径。

仅当 orgScopedUDCA 设置为 false 时才设置此属性。

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

仅当 orgScopedUDCA 设置为 false 时才设置此属性。

envs[].sslCertPath 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

系统上指向 TLS 证书文件的路径。

envs[].sslKeyPath 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

在系统上指向 TLS 私钥文件的路径。

envs[].sslSecret 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。

另请参阅:

gcp

标识 apigee-loggerapigee-metrics 推送其数据的 Google Cloud 项目 ID 和区域。

下表介绍了 gcp 对象的属性:

属性 类型 说明
gcp.region 基本 在以下版本中引入:1.2.0

默认值:us-central1

必需

标识 apigee-loggerapigee-metrics 推送其数据的 Google Cloud 区域

gcp.projectID 基本 在以下版本中引入:1.2.0

默认值:None

必需

标识 apigee-loggerapigee-metrics 推送其数据的 Google Cloud 项目。

gcp.projectIDRuntime 基本 在以下版本中引入:1.2.0

默认值:None

标识运行时 Kubernetes 集群项目。

projectIDRuntime 是可选属性。如果不使用此属性,则假定 Apigee 组织的 Google Cloud 项目和运行时 K8S 集群的项目均使用 projectID 值。

gcp.workloadIdentity.enabled 基本 在以下版本中引入:1.10.0

默认值:false

仅限 Helm:使用 Workload Identity 启用。Workload Identity 允许 GKE 集群中的工作负载模拟 Identity and Access Management (IAM) 服务账号来访问 Google Cloud 服务。

enabledfalse(即默认值)时,Apigee 会为每个 Apigee Hybrid 组件使用 IAM 服务账号。请参阅服务账号简介

workloadIdentityEnabledtrue 时,Apigee 会使用 Kubernetes 服务账号并将其映射到每个组件的相应 IAM 服务账号。 使用以下项指定要映射到 Kubernetes 服务账号的 IAM 服务账号:

gcp.workloadIdentity.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,所有组件用于与相应的 Kubernetes 服务账号关联的 Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

gcp.workloadIdentity.gsa 适用于所有 Hybrid 组件。如果您为 gcp.workloadIdentity.gsa 指定了值,则无需为任何单个 Hybrid 组件提供 GSA。如果您为单个组件提供了 GSA,则该组件的 GSA 将仅为该组件替换 gcp.workloadIdentity.gsa

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-non-prod@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

gcp.workloadIdentityEnabled 基本 在以下版本中引入:1.4.0

默认值:false

仅限 apigeectl:使用 Workload Identity 启用。Workload Identity 允许 GKE 集群中的工作负载模拟 Identity and Access Management (IAM) 服务账号来访问 Google Cloud 服务。

workloadIdentityEnabledfalse(即默认值)时,Apigee 会为每个 Apigee Hybrid 组件使用 IAM 服务账号。请参阅服务账号简介

workloadIdentityEnabledtrue 时,Apigee 会使用 Kubernetes 服务账号而不是 IAM 服务账号,并忽略以下配置属性:

httpProxy

httpProxy 为 HTTP 转接代理服务器提供配置参数。在 overrides.yaml 中配置时,MART、Synchronizer 和 UDCA 组件的所有互联网通信都会通过代理服务器发送。

另请参阅:LoggerMARTMetricsSynchronizerUDCA

下表介绍了 httpProxy 对象的属性:

属性 类型 说明
httpProxy.host 基本 在以下版本中引入:1.1.1

默认值:None

HTTP 代理的主机名。

httpProxy.port 基本 在以下版本中引入:1.1.1

默认值:None

HTTP 代理的端口。

httpProxy.scheme 基本 在以下版本中引入:1.1.1

默认值:HTTPS

代理使用的方案。值可以是 HTTPHTTPS。值只能为大写。

httpProxy.username 基本 在以下版本中引入:1.1.1

默认值:None

如果 HTTP 代理需要基本身份验证,则使用此属性提供用户名。

httpProxy.password 基本 在以下版本中引入:1.1.1

默认值:None

如果 HTTP 代理需要基本身份验证,则使用此属性提供密码。

ingressGateways

配置 Apigee 入站流量网关的各个实例。如果您想要按 ingressGateways[].name 分别管理各个实例,请使用这些属性。

如需将通用配置应用于 Apigee 入站流量网关的所有实例,请参阅 apigeeIngressGateway

如果您使用 Helm 管理 Apigee Hybrid,请使用 apigee-org 图表将更改应用于 ingressGateways 属性。

下表介绍了 ingressGateways 对象的属性:

属性 类型 说明
ingressGateways[].name 基本 在以下版本中引入:1.8.0

默认值:None

必需

入站流量网关的名称。其他服务将使用此名称来访问网关的流量。名称必须符合以下要求:

  • 长度不得超过 17 个字符
  • 只能包含小写字母数字字符、'-' 或 '.'。
  • 以字母数字字符开头
  • 以字母数字字符结尾

如需了解详情,请参阅 Kubernetes 文档中的 DNS 子网域名称

ingressGateways[].resources.limits.cpu 高级 在以下版本中引入:1.8.0

默认值:2000m

资源的 CPU 限制,以毫核为单位。

ingressGateways[].resources.limits.memory 高级 在以下版本中引入:1.8.0

默认值:1Gi

资源的内存限制,以兆比字节 (MiB) 为单位。

ingressGateways[].resources.requests.cpu 高级 在以下版本中引入:1.8.0

默认值:300m

资源正常运行所需的 CPU,以毫核为单位。

ingressGateways[].resources.requests.memory 高级 在以下版本中引入:1.8.0

默认值:128Mi

资源的正常操作所需的内存,以兆比字节为单位。

ingressGateways[].replicaCountMax 基本 在以下版本中引入:1.8.0

默认值:10

Hybrid 可以为可用于自动缩放的入口流量网关自动添加的最大 Pod 数量。

ingressGateways[].replicaCountMin 基本 在以下版本中引入:1.8.0

默认值:2

可用于自动扩缩的入站流量网关的 Pod 数下限。

ingressGateways[].svcAnnotations 基本 在以下版本中引入:1.8.0

默认值:None

可选键值对映射,用于在支持注释的平台上为入站流量网关添加注释。例如:

ingressGateways:
  svcAnnotations:
    networking.gke.io/load-balancer-type: "Internal"
ingressGateways[].svcLoadBalancerIP 基本 在以下版本中引入:1.8.0

默认值:None

在支持指定负载均衡器 IP 地址的平台上,将使用此 IP 地址创建负载均衡器。在不允许指定负载均衡器 IP 地址的平台上,系统会忽略此属性。

ingressGateways[].svcType 基本 在以下版本中引入:1.8.1

默认值:LoadBalancer

用于更改入站流量部署的默认 k8s 服务的类型。如果要停用创建默认负载均衡器的功能,请将值设置为 ClusterIP。可能的值:

  • ClusterIP
  • LoadBalancer
ingressGateways[].targetCPUUtilizationPercentage 高级 在以下版本中引入: 1.10.5, 1.11.2

默认值:75

用于扩缩 ReplicaSet 中 pod 数量的 CPU 使用率的阈值,表示为占可用 CPU 资源的百分比。

当 CPU 使用率超过此值时,混合将逐步增加 ReplicaSet 中的 pod 数,最高可达 ingressGateways[].replicaCountMax

如需详细了解如何在 Kubernetes 中进行扩缩,请参阅 Kubernetes 文档中的 Pod 横向自动扩缩部分。

ingressGateways[].tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

ingressGateways[].tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

ingressGateways[].tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

ingressGateways[].tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

ingressGateways[].tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

istiod

配置 Apigee 入站流量。

下表介绍了 istiod 对象的属性:

属性 类型 说明
istiod.accessLogFile 高级 在以下版本中引入:1.8.0

默认值:/dev/stdout

入站流量访问日志的文件地址,例如 /dev/stdout

保留此值未定义,将停用访问日志记录。

istiod.accessLogFormat 高级 在以下版本中引入:1.8.0

入站流量访问日志的格式。

保留此值未定义,将导致使用代理的默认访问日志格式。

默认访问日志格式:

'{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}'

以下是默认访问日志格式的副本,添加了换行符以提高可读性。

'{"start_time":"%START_TIME%",
  "remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%",
  "user_agent":"%REQ(USER-AGENT)%",
  "host":"%REQ(:AUTHORITY)%",
  "request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%",
  "request_time":"%DURATION%",
  "status":"%RESPONSE_CODE%",
  "status_details":"%RESPONSE_CODE_DETAILS%",
  "bytes_received":"%BYTES_RECEIVED%",
  "bytes_sent":"%BYTES_SENT%",
  "upstream_address":"%UPSTREAM_HOST%",
  "upstream_response_flags":"%RESPONSE_FLAGS%",
  "upstream_response_time":"%RESPONSE_DURATION%",
  "upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%",
  "upstream_cluster":"%UPSTREAM_CLUSTER%",
  "x_forwarded_for":"%REQ(X-FORWARDED-FOR)%",
  "request_method":"%REQ(:METHOD)%",
  "request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%",
  "request_protocol":"%PROTOCOL%",
  "tls_protocol":"%DOWNSTREAM_TLS_VERSION%",
  "request_id":"%REQ(X-REQUEST-ID)%",
  "sni_host":"%REQUESTED_SERVER_NAME%",
  "apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}'
istiod.forwardClientCertDetails 高级 在以下版本中引入:1.9.2

默认值:SANITIZE_SET

确定 Envoy 代理(用于 Apigee 入站流量网关)如何处理 x-forwarded-client-cert (XFCC) HTTP 标头。

可能的值包括:

  • SANITIZE_SET:(默认值)当客户端连接是 mTLS 时,使用客户端证书信息重置 XFCC 标头,并将其发送到下一个跃点。
  • FORWARD_ONLY:当客户端连接是 mTLS(双向 TLS)时,仅转发请求中的 XFCC 标头。
  • APPEND_FORWARD:当客户端连接是 mTLS 时,将客户端证书信息附加到请求的 XFCC 标头并转发。
  • SANITIZE:不转发 XFCC 标头。
  • ALWAYS_FORWARD_ONLY:无论客户端连接是否是 mTLS,都始终转发请求中的 XFCC 标头。

如需详细了解这些值,请查看 Envoy 文档中的 Enum extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails

如果您在安装 Hybrid 后更改此设置,请使用 apigeectl init 应用此设置,然后重启 Apigee 入站流量网关 pod。

istiod.image.pullPolicy 高级 在以下版本中引入:1.8.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

istiod.image.tag 高级 在以下版本中引入:1.8.0

默认值:1.18.7-asm.26-distroless

此服务 Docker 映像的版本标签。

istiod.image.url 高级 在以下版本中引入:1.8.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

istiod.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

istiod.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

istiod.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

istiod.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

istiod.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

k8sCluster

确定安装了混合运行时的 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

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

kubeRBACProxy.image.tag 高级 在以下版本中引入1.2.0

默认值:v0.14.2

此服务 Docker 映像的版本标签。

kubeRBACProxy.image.url 高级 在以下版本中引入:1.2.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

kubeRBACProxy.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:500m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

kubeRBACProxy.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:128Mi

Kubernetes 容器中资源的内存限制,以字节为单位。

kubeRBACProxy.resources.requests.cpu 高级 在以下版本中引入:1.11.0

默认值:5m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

kubeRBACProxy.resources.requests.memory 高级 在以下版本中引入:1.11.0

默认值:64Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

logger

定义管理运营日志的服务。Kubernetes 集群中运行的所有 Apigee 混合服务都会输出此信息。

如需了解详情,请参阅 Logging 概览

下表介绍了 logger 对象的属性:

属性 类型 说明
logger.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

logger.enabled 基本 在以下版本中引入:1.0.0

默认值:false

启用或停用集群上的日志记录功能。对于设置为 true 的非 GKE,Anthos 或 GKE 设置为 false

logger.envVars 基本 在以下版本中引入:1.8.5

默认值:None

可让您添加 NO_PROXY Fluent Bit 环境变量,该变量指定未通过 HTTP 代理路由流量的网址。NO_PROXY 变量应定义为以英文逗号分隔的主机名字符串,格式如下:

logger:
  ...
  envVars:
    NO_PROXY: '<comma-separated-values>'

例如:

  envVars:
    NO_PROXY: 'kubernetes.default.svc,oauth2.googleapis.com,logging.googleapis.com'

启用 HTTP 转发代理后,可以选择使用 envVars: NO_PROXY

请参阅 Fluent Bit 文档中的 NO_PROXY

logger.fluentd.buffer_chunk_limit 高级 在以下版本中引入:1.0.0

默认值:512k

允许的缓冲区区块的大小上限,以千字节为单位。超出限制的区块将自动进入输出队列。

logger.fluentd.buffer_queue_limit 高级 在以下版本中引入:1.0.0

默认值:6

输出队列的最大长度。默认限制为 256 个区块。

logger.fluentd.flush_interval 高级 在以下版本中引入:1.0.0

默认值:5s

调用下一个缓冲区刷新前等待的时间间隔,以秒为单位。

logger.fluentd.max_retry_wait 高级 在以下版本中引入:1.0.0

默认值:30

写入操作之间的最大时间间隔,以秒为单位。

logger.fluentd.num_threads 高级 在以下版本中引入:1.0.0

默认值:2

用于刷新缓冲区的线程数。默认值为 1。

logger.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

logger.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的 apigee-logger Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-logger@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

logger.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.9.9

此服务 Docker 映像的版本标签。

logger.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

logger.livenessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:3

Kubernetes 将验证重启容器前,活跃探测失败的次数。最小值为 1。

logger.livenessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:0

活跃探测启动前,容易开始后经过的秒数。

logger.livenessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:60

确定执行活跃探测的频率,以秒为单位。最小值为 1。

logger.livenessProbe.successThreshold 高级 在以下版本中引入:1.0.0

默认值:1

在失败后,被认为成功活跃性探测需要的最小持续成功次数。最小值为 1。

logger.livenessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

logger.nodeSelector.key 基础 在以下版本中引入:1.0.0

默认值:apigee.com/apigee-logger-enabled

必需

节点选择器标签键,用于定位 logger 运行时服务的专用 Kubernetes 节点。

请参阅配置专用节点池

logger.nodeSelector.value 基础 在以下版本中引入:1.0.0

默认值:true

必需

节点选择器标签值,用于定位 logger 运行时服务的专用 Kubernetes 节点。

请参阅配置专用节点池

logger.proxyURL 基础 在以下版本中引入:1.0.0

默认值:None

客户代理服务器的网址。

logger.resources.limits.cpu 高级 在以下版本中引入:1.0.0

默认值:200m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

logger.resources.limits.memory 高级 在以下版本中引入:1.0.0

默认值:500Mi

Kubernetes 容器中资源的内存限制,以字节为单位。

logger.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:100m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

logger.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值:250Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

logger.serviceAccountPath 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

具有 Logs Writer 角色的 Google 服务账号密钥文件的路径。

logger.serviceAccountRef 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

logger.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:30

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

logger.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

logger.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

logger.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

logger.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

logger.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

mart

定义 MART(运行时数据的 Management API)服务,它充当公开 Apigee API 的 API 提供商,以便您可以访问和管理运行时数据实体,例如 KMS(API 密钥和 OAuth 令牌)、KVM、配额和 API 产品。

下表介绍了 mart 对象的属性:

属性 类型 说明
mart.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

mart.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的 apigee-mart Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

mart.hostAlias 基本 在以下版本中引入:1.0.0

默认值:None

指向 MART 对象的主机别名。您可以将此属性设置为 * 或完全限定域名。

mart.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

mart.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

mart.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

mart.initCheckCF.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:10m

分配给 Cloud Foundry 进程初始化检查的 CPU 资源量。

mart.livenessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:12

Kubernetes 将验证重启容器前,活跃探测失败的次数。最小值为 1。

mart.livenessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:15

活跃探测启动前,容易开始后经过的秒数。

mart.livenessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行活跃探测的频率,以秒为单位。最小值为 1。

mart.livenessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

mart.metricsURL 基础 在以下版本中引入:1.0.0

默认值:/v1/server/metrics

mart.nodeSelector.key 基本 在以下版本中引入:1.0.0

默认值:None

可选节点选择器标签键,用于定位 mart 运行时服务的 Kubernetes 节点。如果您没有为 mart.nodeselector 指定键,则您的运行时将使用 nodeSelector 对象中指定的节点。

请参阅配置专用节点池

mart.nodeSelector.value 基础 在以下版本中引入:1.0.0

默认值:None

可选节点选择器标签值,用于定位 mart 运行时服务的 Kubernetes 节点。另请参阅 nodeSelector 对象。

请参阅配置专用节点池

mart.readinessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证将 Pod 标记为“未就绪”前,就绪探测失败的次数。最小值为 1。

mart.readinessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:15

就绪探测启动前,容易开始后经过的秒数。

mart.readinessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行就绪探测的频率,以秒为单位。最小值为 1。

mart.readinessProbe.successThreshold 高级 在以下版本中引入:1.0.0

默认值:1

在失败后,被认为成功就绪探测需要的最小持续成功次数。最小值为 1。

mart.readinessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

mart.replicaCountMax 基础 在以下版本中引入:1.0.0

默认值:5

可用于自动扩缩的副本数上限。

mart.replicaCountMin 基本 在以下版本中引入:1.0.0

默认值:1

可自动扩缩的副本数下限。

mart.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:2000m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

mart.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:5Gi

Kubernetes 容器中资源的内存限制,以字节为单位。

mart.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:500m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

mart.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值:512Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

mart.serviceAccountPath 基本 在以下版本中引入:1.1.1

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

无角色的 Google 服务账号密钥文件的路径。

mart.serviceAccountRef 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

mart.sslCertPath 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

将 SSL 证书加载和编码到 Secret 的本地文件系统路径。

mart.sslKeyPath 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

将 SSL 密钥加载和编码到 Secret 的本地文件系统路径。

mart.sslSecret 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。

另请参阅:

mart.targetCPUUtilizationPercentage 高级 在以下版本中引入:1.0.0

默认值:75

Pod 上 MART 进程的目标 CPU 利用率。在 CPU 利用率达到此值(最多 replicaCountMax)时,此字段值启用 MART 以自动扩缩。

mart.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:30

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

mart.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

mart.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

mart.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

mart.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

mart.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

metrics

定义收集操作指标的服务。您可以使用指标数据来监控混合服务的运行状况、设置提醒等。

如需了解详情,请参阅指标集合概览

下表介绍了 metrics 对象的属性:

属性 类型 说明
metrics.adapter.image.pullPolicy 高级 在以下版本中引入:1.8.1

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

metrics.adapter.image.tag 高级 在以下版本中引入:1.8.1

默认值:v0.11.0

此服务 Docker 映像的版本标签。

metrics.adapter.image.url 高级 在以下版本中引入:1.8.1

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

metrics.aggregator.resources.requests.cpu 高级 在以下版本中引入:1.4.0

默认值:500m

Kubernetes 容器中聚合器正常运行所需的 CPU(以毫核为单位)。

metrics.aggregator.resources.requests.memory 高级 在以下版本中引入:1.4.0

默认值:512Mi

Kubernetes 容器中聚合器正常运行所需的内存(以 MiB 为单位)。

metrics.aggregator.resources.limits.cpu 高级 在以下版本中引入:1.4.0

默认值:500m

Kubernetes 容器中聚合器资源的 CPU 限制(以毫核为单位)。

metrics.aggregator.resources.limits.memory 高级 在以下版本中引入:1.4.0

默认值:3Gi

Kubernetes 容器中聚合器资源的内存限制(以 GiB 为单位)。

metrics.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

metrics.app.resources.requests.cpu 高级 在以下版本中引入:1.4.0

默认值:500m

Kubernetes 容器中应用正常运行所需的 CPU(以毫核为单位)。

metrics.app.resources.requests.memory 高级 在以下版本中引入:1.4.0

默认值:512Mi

Kubernetes 容器中应用正常运行所需的内存(以 MiB 为单位)。

metrics.app.resources.limits.cpu 高级 在以下版本中引入:1.4.0

默认值:500m

Kubernetes 容器中应用资源的 CPU 限制(以毫核为单位)。

metrics.app.resources.limits.memory 高级 在以下版本中引入:1.4.0

默认值:1Gi

Kubernetes 容器中应用资源的内存限制(以 GiB 为单位)。

metrics.appStackdriverExporter.resources.requests.cpu 高级 在以下版本中引入:1.7.0

默认值:128m

Kubernetes 容器中 stackdriverExporter 正常运行所需的 CPU(以毫核为单位)。

metrics.appStackdriverExporter.resources.requests.memory 高级 在以下版本中引入:1.7.0

默认值:512Mi

Kubernetes 容器中 stackdriverExporter 正常运行所需的内存(以 MiB 为单位)。

metrics.appStackdriverExporter.resources.limits.cpu 高级 在以下版本中引入:1.7.0

默认值:500m

Kubernetes 容器中 stackdriverExporter 资源的 CPU 限制(以毫核为单位)。

metrics.appStackdriverExporter.resources.limits.memory 高级 在以下版本中引入:1.7.0

默认值:1Gi

Kubernetes 容器中 stackdriverExporter 资源的内存限制(以 GiB 为单位)。

metrics.enabled 基本 在以下版本中引入:1.0.0

默认值:true

启用 Apigee 指标。设置为 true 可启用指标。设置为 false 可停用指标。

metrics.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的 apigee-metrics Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-metrics@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

metrics.nodeSelector.key 基本 在以下版本中引入:1.0.0

默认值:None

必需

节点选择器标签键,用于定位 metrics 运行时服务的专用 Kubernetes 节点。

请参阅配置专用节点池

metrics.nodeSelector.value 基础 在以下版本中引入:1.0.0

默认值:None

必需

节点选择器标签值,用于定位 metrics 运行时服务的专用 Kubernetes 节点。

请参阅配置专用节点池

metrics.prometheus.args.storage_tsdb_retention 高级 在以下版本中引入:1.0.0

默认值:48h

Prometheus 从本地存储空间中移除旧数据之前等待的时间,以小时为单位。

metrics.prometheus.containerPort 高级 在以下版本中引入:1.0.0

默认值:9090

连接到 Prometheus 指标服务的端口。

metrics.prometheus.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

metrics.prometheus.image.tag 高级 在以下版本中引入:1.0.0

默认值:v2.45.0

此服务 Docker 映像的版本标签。

metrics.prometheus.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

metrics.prometheus.livenessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:6

Kubernetes 将验证重启容器前,活跃探测失败的次数。最小值为 1。

metrics.prometheus.livenessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行活跃探测的频率,以秒为单位。最小值为 1。

metrics.prometheus.livenessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:3

活跃探测超时后的秒数。最小值为 1。

metrics.prometheus.readinessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:120

Kubernetes 将验证将 Pod 标记为“未就绪”前,就绪探测失败的次数。最小值为 1。

metrics.prometheus.readinessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行就绪探测的频率,以秒为单位。最小值为 1。

metrics.prometheus.readinessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:3

活跃探测超时后的秒数。最小值为 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

默认值:500m

Kubernetes 容器中代理正常运行所需的 CPU(以毫核为单位)。

metrics.proxy.resources.requests.memory 高级 在以下版本中引入:1.4.0

默认值:512Mi

Kubernetes 容器中代理正常运行所需的内存(以 MiB 为单位)。

metrics.proxy.resources.limits.cpu 高级 在以下版本中引入:1.4.0

默认值:500m

Kubernetes 容器中代理资源的 CPU 限制(以毫核为单位)。

metrics.proxy.resources.limits.memory 高级 在以下版本中引入:1.4.0

默认值:1Gi

Kubernetes 容器中代理资源的内存限制(以 GiB 为单位)。

metrics.proxyStackdriverExporter.resources.requests.cpu 高级 在以下版本中引入:1.7.0

默认值:128m

Kubernetes 容器中 stackdriverExporter 正常运行所需的 CPU(以毫核为单位)。

metrics.proxyStackdriverExporter.resources.requests.memory 高级 在以下版本中引入:1.7.0

默认值:512Mi

Kubernetes 容器中 stackdriverExporter 正常运行所需的内存(以 MiB 为单位)。

metrics.proxyStackdriverExporter.resources.limits.cpu 高级 在以下版本中引入:1.7.0

默认值:500m

Kubernetes 容器中 stackdriverExporter 资源的 CPU 限制(以毫核为单位)。

metrics.proxyStackdriverExporter.resources.limits.memory 高级 在以下版本中引入:1.7.0

默认值:1Gi

Kubernetes 容器中 stackdriverExporter 资源的内存限制(以 GiB 为单位)。

metrics.proxyURL 基本 在以下版本中引入:1.0.0

默认值:None

Kubernetes 集群中的指标进程 Sidecar 代理的网址。

metrics.sdSidecar.containerPort 高级 在以下版本中引入:1.0.0

默认值:9091

用于连接到 Cloud Monitoring 指标服务的端口。

metrics.sdSidecar.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 Kubelet 何时提取此服务的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,请勿提取它
  • Always:始终提取政策,即使它已存在

    如需了解详情,请参阅更新映像

metrics.sdSidecar.image.tag 高级 在以下版本中引入:1.0.0

默认值:v0.9.0

此服务 Docker 映像的版本标签。

metrics.sdSidecar.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

metrics.serviceAccountPath 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

具有 Monitoring Metric Writer 角色的 Google 服务账号密钥文件的路径。

metrics.serviceAccountRef 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

metrics.stackdriverExporter.resources.requests.cpu 高级 在以下版本中引入:1.4.0

Deprecated:从 Hybrid 1.8 版开始,metrics:stackdriverExporter 已被替换为 metrics:appStackdriverExportermetrics:proxyStackdriverExporter。请参阅:

metrics.stackdriverExporter.resources.requests.memory 高级 在以下版本中引入:1.4.0

Deprecated:从 Hybrid 1.8 版开始,metrics:stackdriverExporter 已被替换为 metrics:appStackdriverExportermetrics:proxyStackdriverExporter。请参阅:

metrics.stackdriverExporter.resources.limits.cpu 高级 在以下版本中引入:1.4.0

Deprecated:从 Hybrid 1.8 版开始,metrics:stackdriverExporter 已被替换为 metrics:appStackdriverExportermetrics:proxyStackdriverExporter。请参阅:

metrics.stackdriverExporter.resources.limits.memory 高级 在以下版本中引入:1.4.0

Deprecated:从 Hybrid 1.8 版开始,metrics:stackdriverExporter 已被替换为 metrics:appStackdriverExportermetrics:proxyStackdriverExporter。请参阅:

metrics.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:300

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

metrics.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

metrics.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

metrics.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

metrics.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

metrics.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

mintTaskScheduler

mintTaskScheduler 是 Cron 作业,用于安排创收任务(例如定期计算费用)。

下表介绍了 mintTaskScheduler 对象的属性:

属性 类型 说明
mintTaskScheduler.image.pullPolicy 高级 在以下版本中引入:1.7.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

mintTaskScheduler.image.tag 高级 在以下版本中引入:1.7.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

mintTaskScheduler.image.url 高级 在以下版本中引入:1.7.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

mintTaskScheduler.resources.limits.cpu 高级 在以下版本中引入:1.1.0

默认值:2000m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

mintTaskScheduler.resources.limits.memory 高级 在以下版本中引入:1.1.0

默认值:4Gi

Kubernetes 容器中资源的内存限制,以字节为单位。

mintTaskScheduler.resources.requests.cpu 高级 在以下版本中引入:1.7.0

默认值:500m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

mintTaskScheduler.resources.requests.memory 高级 在以下版本中引入:1.7.0

默认值:512Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

mintTaskScheduler.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

mintTaskScheduler.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

mintTaskScheduler.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

mintTaskScheduler.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

mintTaskScheduler.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

nodeSelector

nodeSelector 对象用于定义 Apigee 实例的节点。apigeectl 运行时场景的背后,应为 apigeeRuntimeapigeeData 将标签键/值映射到单个 Istio 和 MART 组件。您可以为 mart:nodeSelector 属性中的各个对象替换此设置。

下表介绍了 nodeSelector 对象的属性:

属性 类型 说明
nodeSelector.apigeeData.key 高级 在以下版本中引入:1.0.0

默认值:cloud.google.com/gke-nodepool

ApigeeData 是 Cassandra 数据库的节点。节点选择器标签键,用于定位 Kubernetes 节点以与 Apigee 服务数据配合使用。

请参阅配置专用节点池

nodeSelector.apigeeData.value 高级 在以下版本中引入:1.0.0

默认值:apigee-data

apigee-data 是 Cassandra 数据库的节点。节点选择器标签值,用于定位 Kubernetes 节点以与 Apigee 服务数据配合使用。

请参阅配置专用节点池

nodeSelector.apigeeRuntime.key 高级 在以下版本中引入:1.0.0

默认值:cloud.google.com/gke-nodepool

Apigee Runtime 是项目的运行时环境的节点。节点选择器标签键,用于定位 Apigee 运行时服务的 Kubernetes 节点。

请参阅配置专用节点池

nodeSelector.apigeeRuntime.value 高级 在以下版本中引入:1.0.0

默认值:apigee-runtime

apigee-runtime 是项目的运行时环境的节点。节点选择器标签值,用于定位 Apigee 运行时服务的 Kubernetes 节点。

请参阅配置专用节点池

nodeSelector.requiredForScheduling 高级 在以下版本中引入:1.0.0

默认值:false

requiredForScheduling 属性默认为 false。如果此值被替换为 true,则意味着,如果 Kubernetes 找不到配置了标签键/值的节点,则将不会在虚拟机工作器节点上安排底层 Pod。

对于生产环境,nodeSelector.requiredForScheduling 应设置为 true。

请参阅配置专用节点池

redis

下表介绍了 redis 对象的属性:

属性 类型 说明
redis.auth.password 基本 在以下版本中引入:1.6.0

默认值:iloveapis123

必需

Redis 管理员的密码。管理员用户用于在 Redis 集群上执行的任何管理活动。

redis.auth.secret 基本 在以下版本中引入:1.9.1

默认值:None

文件的名称,存储在包含 Redis 管理员密码的 Kubernetes Secret 中。Secret 文件应包含密钥:

data:
    redis.auth.password: encoded_value

另请参阅:

redis.envoy.image.pullPolicy 高级 在以下版本中引入:1.6.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

redis.envoy.image.tag 高级 在以下版本中引入:1.6.0

默认值:v1.27.0

此服务 Docker 映像的版本标签。

redis.envoy.image.url 高级 在以下版本中引入:1.6.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

redis.image.pullPolicy 高级 在以下版本中引入:1.6.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

redis.image.tag 高级 在以下版本中引入:1.6.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

redis.image.url 高级 在以下版本中引入:1.6.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

redis.replicaCount 基本 在以下版本中引入:1.6.0

默认值:2

Redis 是复制的存储空间。此属性用于指定用作 StatefulSet 的 Redis 节点的数量。

redis.resources.requests.cpu 高级 在以下版本中引入:1.6.0

默认值:500m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

redis.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

redis.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

redis.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

redis.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

redis.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

runtime

下表介绍了 runtime 对象的属性:

属性 类型 说明
runtime.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

runtime.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

runtime.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

runtime.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

runtime.livenessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证重启容器前,活跃探测失败的次数。最小值为 1。

runtime.livenessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:60

活跃探测启动前,容易开始后经过的秒数。

runtime.livenessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行活跃探测的频率,以秒为单位。最小值为 1。

runtime.livenessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

runtime.nodeSelector.key 基础 在以下版本中引入:1.0.0

默认值:None

可选节点选择器标签键,用于定位 runtime 服务的 Kubernetes 节点。

请参阅 nodeSelector 属性

runtime.nodeSelector.value 基本 在以下版本中引入:1.0.0

默认值:None

节点选择器标签值,用于定位 runtime 服务的 Kubernetes 节点。

请参阅配置专用节点池

runtime.readinessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证将 Pod 标记为“未就绪”前,就绪探测失败的次数。最小值为 1。

runtime.readinessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:60

就绪探测启动前,容易开始后经过的秒数。

runtime.readinessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行就绪探测的频率,以秒为单位。最小值为 1。

runtime.readinessProbe.successThreshold 高级 在以下版本中引入:1.0.0

默认值:1

在失败后,被认为成功就绪探测需要的最小持续成功次数。最小值为 1。

runtime.readinessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

runtime.replicaCountMax 基础 在以下版本中引入:1.0.0

默认值:4

可用于自动扩缩的副本数上限。

runtime.replicaCountMin 基本 在以下版本中引入:1.0.0

默认值:1

可自动扩缩的副本数下限。

runtime.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:4000m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

runtime.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:6Gi

Kubernetes 容器中资源的内存限制,以字节为单位。

runtime.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:500m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

runtime.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值512Mi(请参阅下面的“注意”部分)

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节 (Mi) 或吉比字节 (Gi) 为单位。

runtime.service.type 高级 在以下版本中引入:1.0.0

默认值:ClusterIP

服务类型。您可以将此设置为 ClusterIP 以外的服务;例如 LoadBalancer

runtime.targetCPUUtilizationPercentage 高级 在以下版本中引入:1.0.0

默认值:75

Pod 上运行时进程的目标 CPU 利用率。在 CPU 利用率达到此值(最多 replicaCountMax)时,此字段值启用运行时以自动扩缩。

runtime.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:180

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

runtime.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

runtime.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

runtime.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

runtime.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

runtime.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

synchronizer

确保消息处理器与最新部署的 API 代理软件包保持同步。为此,Synchronizer 会轮询管理平面;检测到新合同时,Synchronizer 会将其发送到运行时平面。默认情况下,Synchronizer 将环境配置数据存储在 Cassandra 中。

如需了解详情,请参阅配置 Synchronizer

下表介绍了 synchronizer 对象的属性:

属性 类型 说明
synchronizer.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

synchronizer.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

synchronizer.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

synchronizer.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

synchronizer.livenessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证重启容器前,活跃探测失败的次数。最小值为 1。

synchronizer.livenessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:0

活跃探测启动前,容易开始后经过的秒数。

synchronizer.livenessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行活跃探测的频率,以秒为单位。最小值为 1。

synchronizer.livenessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

synchronizer.nodeSelector.key 基础 在以下版本中引入:1.0.0

默认值:None

必需

可选节点选择器标签键,用于定位 synchronizer 运行时服务的 Kubernetes 节点。

请参阅 nodeSelector

synchronizer.nodeSelector.value 基本 在以下版本中引入:1.0.0

默认值:None

可选节点选择器标签值,用于定位 synchronizer 运行时服务的 Kubernetes 节点。

请参阅 nodeSelector

synchronizer.pollInterval 高级 在以下版本中引入:1.0.0

默认值:60

Synchronizer 在轮询操作之间等待的时长。Synchronizer 轮询 Apigee 控制平面服务,以检测并提取新的运行时合同。

synchronizer.readinessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证将 Pod 标记为“未就绪”前,就绪探测失败的次数。最小值为 1。

synchronizer.readinessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:0

就绪探测启动前,容易开始后经过的秒数。

synchronizer.readinessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行就绪探测的频率,以秒为单位。最小值为 1。

synchronizer.readinessProbe.successThreshold 高级 在以下版本中引入:1.0.0

默认值:1

在失败后,被认为成功就绪探测需要的最小持续成功次数。最小值为 1。

synchronizer.readinessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

synchronizer.replicaCount 基础 在以下版本中引入:1.0.0

Deprecated:从 Hybrid 1.2 版开始,使用 synchronizer.replicaCountMaxsynchronizer.replicaCountMin 管理 Synchronizer 副本数量

synchronizer.replicaCountMax 基本 在以下版本中引入:1.2.0

默认值:4

自动扩缩的副本数上限。

synchronizer.replicaCountMin 基本 在以下版本中引入:1.2.0

默认值:1

自动扩缩的副本数下限。

synchronizer.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:2000m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

synchronizer.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:5Gi

Kubernetes 容器中资源的内存限制,以字节为单位。

synchronizer.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:100m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

synchronizer.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值:1Gi

在 Kubernetes 容器中资源正常运行所需的内存,以千兆字节为单位。

synchronizer.serviceAccountPath 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

具有 Apigee Synchronizer Manager 角色的 Google 服务账号密钥文件的路径。

synchronizer.serviceAccountRef 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

synchronizer.serviceAccountSecret 基础 在以下版本中引入:1.2.0

默认值:None

Kubernetes Secret 的名称。您必须使用具有 Apigee Synchronizer Manager 角色的 Google 服务账号密钥作为输入来创建 Secret。

synchronizer.targetCPUUtilizationPercentage 高级 在以下版本中引入:1.0.0

默认值:75

Pod 上 Synchronizer 进程的目标 CPU 利用率。在 CPU 利用率达到此值(最多 replicaCountMax)时,此字段值启用 Synchronizer 以自动扩缩。

synchronizer.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:30

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

synchronizer.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

synchronizer.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

synchronizer.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

synchronizer.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

synchronizer.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

udca

(通用数据收集代理)定义在运行时平面的数据收集 pod 中运行的服务。此服务会提取分析和部署状态数据并将其发送到统一分析平台 (UAP)。

如需了解详情,请参阅分析和部署状态数据收集

下表介绍了 udca 对象的属性:

属性 类型 说明
udca.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注释

udca.fluentd.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

udca.fluentd.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.9.12-2

此服务 Docker 映像的版本标签。

udca.fluentd.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

udca.fluentd.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:1000m

Kubernetes 容器中资源的内存限制,以字节为单位。

udca.fluentd.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:500Mi

Kubernetes 容器中资源的内存限制,以字节为单位。

udca.fluentd.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:500m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

udca.fluentd.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值:250Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

udca.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的 apigee-udca Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-udca@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

udca.image.pullPolicy 高级 在以下版本中引入:1.0.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

udca.image.tag 高级 在以下版本中引入:1.0.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

udca.image.url 高级 在以下版本中引入:1.0.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

udca.jvmXms 高级 在以下版本中引入:1.0.0

Deprecated:从 Hybrid 1.8 版开始,不再使用 udca.jvmXms

udca.jvmXmx 高级 在以下版本中引入:1.0.0

Deprecated:从 Hybrid 1.8 版开始,不再使用 udca.jvmXmx

udca.livenessProbe.failureThreshold 高级 在以下版本中引入:1.0.0

默认值:2

Kubernetes 将验证重启容器前,活跃探测失败的次数。最小值为 1。

udca.livenessProbe.initialDelaySeconds 高级 在以下版本中引入:1.0.0

默认值:0

活跃探测启动前,容易开始后经过的秒数。

udca.livenessProbe.periodSeconds 高级 在以下版本中引入:1.0.0

默认值:5

确定执行活跃探测的频率,以秒为单位。最小值为 1。

udca.livenessProbe.timeoutSeconds 高级 在以下版本中引入:1.0.0

默认值:1

活跃探测超时后的秒数。最小值为 1。

udca.nodeSelector.key 基础 在以下版本中引入:1.0.0

默认值:None

必需

节点选择器标签键,用于定位 udca 运行时服务的专用 Kubernetes 节点。

请参阅配置专用节点池

udca.nodeSelector.value 基础 在以下版本中引入:1.0.0

默认值:None

必需

节点选择器标签值,用于定位 udca 运行时服务的专用 Kubernetes 节点。

请参阅配置专用节点池

udca.pollingIntervalInSec 高级 在以下版本中引入:1.0.0

默认值:1

UDCA 轮询操作之间等待的时长,以秒为单位。UDCA 轮询数据收集 pod 文件系统上的数据目录,以检测要上传的新文件。

udca.replicaCountMax 基础 在以下版本中引入:1.0.0

默认值:4

混合可为 UDCA 部署自动添加的 Pod 数上限。由于 UDCA 是作为 ReplicaSet 实现的,因此 Pod 是副本。

建议将 udca.replicaCountMax 设置为每个环境的副本数上限,乘以 Apigee 组织中的环境数量。例如,如果您希望每个环境最多允许 4 个副本,并且有 3 个环境,请设置 udca.replicaCountMax: 12

udca.replicaCountMin 基础 在以下版本中引入:1.0.0

默认值:1

UDCA 部署的 pod 数下限。由于 UDCA 是作为 ReplicaSet 实现的,因此 pod 是副本。

如果 CPU 使用率高于 udca.targetCPUUtilizationPercentage,则混合将逐步增加 pod 数,最高可达 udca.replicaCountMax

udca.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:1000m

Kubernetes 容器中资源的内存限制,以字节为单位。

udca.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:2Gi

Kubernetes 容器中资源的内存限制,以字节为单位。

udca.resources.requests.cpu 高级 在以下版本中引入:1.0.0

默认值:250m

Kubernetes 容器中资源正常运行所需的 CPU,以毫秒为单位。

udca.resources.requests.memory 高级 在以下版本中引入:1.0.0

默认值:250Mi

在 Kubernetes 容器中资源正常运行所需的内存,以兆比字节为单位。

udca.revision 高级 在以下版本中引入:1.0.0

默认值:v1

填充到标签页中可启用 Canary 部署的静态值。

udca.serviceAccountPath 基本 在以下版本中引入:1.0.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

具有 Apigee Analytics Agent 角色的 Google 服务账号密钥文件的路径。

udca.serviceAccountRef 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 serviceAccountPathserviceAccountRef 之一。

udca.targetCPUUtilizationPercentage 高级 在以下版本中引入:1.0.0

默认值:75

用于扩缩 ReplicaSet 中 pod 数量的 CPU 使用率的阈值,表示为占可用 CPU 资源的百分比。混合使用数据收集 pod(fluentd 和 UDCA)中所有容器的组合利用率来计算当前利用率。

当 CPU 使用率超过此值时,混合将逐步增加 ReplicaSet 中的 pod 数,最高可达 udca.replicaCountMax

udca.terminationGracePeriodSeconds 高级 在以下版本中引入:1.0.0

默认值:600

请求删除 Pod 与终止 Pod 之间的时间,以秒为单位。在此期间,将执行任何预停止钩子,并且所有正在运行的进程都应正常终止。

udca.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

udca.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

udca.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

udca.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

udca.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念

virtualhosts

virtualhosts 属性是必需的配置属性。虚拟主机可让 Apigee Hybrid 处理向指定环境组发送的 API 请求。

如需了解详情,请参阅配置虚拟主机

下表介绍了 virtualhosts 对象的属性:

属性 类型 说明
virtualhosts[].additionalGateways 基本 在以下版本中引入:1.2.0

默认值:None

要将流量路由到的 Istio Gateway 列表。

virtualhosts[].cipherSuites[] 高级 在以下版本中引入:1.9.2

默认值:None

此属性配置在入站流量网关中使用的 TLS 加密。下面列出了默认启用的加密方式,采用 OpenSSL 格式。如需详细了解受支持的加密方式,请参阅 Envoy 的 Boring FIPS 构建文档。空白值默认为 Envoy 的 Boring FIPS 构建支持的加密套件。

默认为 TLS v.1.3 启用(您无法替换 TLS 1.3 加密套件):

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256

默认为 TLS v.1.2 启用:

  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES256-GCM-SHA384

如果要在 Apigee 入站流量网关部署中启用旧版 TLS,请使用 virtualhosts.minTLSProtocolVersionvirtualhosts.cipherSuites 属性。

例如,如需启用 TLS v.1.1:

virtualhosts:
- name: ENV_GROUP_NAME
  minTLSProtocolVersion: "1.1"
  cipherSuites:
  - "ECDHE-ECDSA-AES128-GCM-SHA256"
  - "ECDHE-RSA-AES128-GCM-SHA256"
  - "ECDHE-ECDSA-AES256-GCM-SHA384"
  - "ECDHE-RSA-AES256-GCM-SHA384"
  - "ECDHE-ECDSA-CHACHA20-POLY1305"
  - "ECDHE-RSA-CHACHA20-POLY1305"
  - "ECDHE-ECDSA-AES128-SHA"
  - "ECDHE-RSA-AES128-SHA"
  - "ECDHE-ECDSA-AES256-SHA"
  - "ECDHE-RSA-AES256-SHA"
...
virtualhosts[].name 基本 在以下版本中引入:1.2.0

默认值:None

必需

虚拟主机的名称。

virtualhosts[].maxTLSProtocolVersion 基本 在以下版本中引入:1.3.0

默认值:None

Envoy 可以选择的 TLS 协议的最高版本。Envoy 自动使用 virtualhosts[].minTLSProtocolVersionvirtualhosts[].maxTLSProtocolVersion 之间的最佳 TLS 协议版本。 Apigee Hybrid 支持 TLSv1.0 到 TLSv1.3。

该值必须采用数字形式。例如:

virtualhosts:
  - name: default
    maxTLSProtocolVersion: "1.3"

其中数字表示 TLS 版本号,格式为 #.#。在上面的示例中,"1.3" 表示 Istio TLS 版本 TLSV1_3

另请参阅 Istio 文档中的 ServerTLSSettings.TLSProtocol

virtualhosts[].minTLSProtocolVersion 基本 在以下版本中引入:1.3.0

默认值:None

Envoy 可以选择的 TLS 协议的最低版本。Envoy 自动使用 virtualhosts[].minTLSProtocolVersionvirtualhosts[].maxTLSProtocolVersion 之间的最佳 TLS 协议版本。 Apigee Hybrid 支持 TLSv1.0 到 TLSv1.3。

该值必须采用数字形式。例如:

virtualhosts:
  - name: default
    minTLSProtocolVersion: "1.2"

其中数字表示 TLS 版本号,格式为 #.#。在上面的示例中,1.2 表示 Istio TLS 版本 TLSV1_2

另请参阅 Istio 文档中的 ServerTLSSettings.TLSProtocol

virtualhosts[].selector 基本 在以下版本中引入:1.2.0

默认值:app: apigee-ingressgateway

必需

指向不同入站流量选择器的键值选择器值对。

  • apigee-ingressgateway:对于使用 Apigee 入站流量网关的 Apigee Hybrid 安装。
  • istio-ingressgateway:对于使用 Anthos Service Mesh 的 Apigee Hybrid 安装(Apigee Hybrid 1.8 版及更早版本)。

如果未提供选择器标签,则系统会向 Apigee 入站流量网关提供配置。

virtualhosts[].sslCertPath 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

系统上指向 TLS 证书文件的路径。

virtualhosts[].sslKeyPath 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

在系统上指向 TLS 私钥文件的路径。

virtualhosts[].sslSecret 基本 在以下版本中引入:1.2.0

默认值:None

必须提供 sslCertPath/sslKeyPathsslSecret

包含 TLS 证书和私钥的 Kubernetes Secret 中存储的文件的名称。您必须使用 TLS 证书和密钥数据作为输入来创建 Secret。

另请参阅:

watcher

watcher 属性是必需的配置属性。watcher 是一个监视配置更改并触发将更改应用到运行时平面的进程。

下表介绍了 watcher 对象的属性:

属性 类型 说明
watcher.annotations 高级 在以下版本中引入:1.5.0

默认值:None

用于为 pod 添加注释的可选键值对映射。如需了解详情,请参阅自定义注解

watcher.args.enableIssueScanning 高级 在以下版本中引入:1.10.0

默认值:true

启用或停用自动显示问题。如果为 true,Watcher 会自动扫描控制平面和 Kubernetes API 服务器状态,以确定是否存在任何配置问题。

设置为 false 可停用自动显示问题。如需了解详情,请参阅自动显示问题

watcher.args.issueScanInterval 高级 在以下版本中引入:1.10.0

默认值:60

Watcher 扫描运行时平面以自动显示问题的频率的间隔(以秒为单位)。如需了解详情,请参阅自动显示问题

watcher.gsa 高级 在以下版本中引入:1.10.0

默认值:None

仅限 Helm:使用 Helm 图表在 GKE 集群上启用 Workload Identity 时,与相应的 Kubernetes 服务账号关联的 apigee-watcher Google IAM 服务账号 (GSA) 的电子邮件地址。将 gcp.workloadIdentity.enabled 设置为 true 时设置此项。

GSA 电子邮件地址通常采用以下格式:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

apigee-watcher@my-hybrid-project.iam.gserviceaccount.com

请参阅 Enabling Workload Identity with Helm charts

watcher.image.pullPolicy 高级 在以下版本中引入:1.4.0

默认值:IfNotPresent

确定 kubelet 何时提取 pod 的 Docker 映像。可能的值包括:

  • IfNotPresent:如果新映像已存在,则请勿提取它。
  • Always:始终提取映像,无论它是否已经存在。

如需了解详情,请参阅更新映像

watcher.image.tag 高级 在以下版本中引入:1.4.0

默认值:1.11.2

此服务 Docker 映像的版本标签。

watcher.image.url 高级 在以下版本中引入:1.4.0

默认值:None

此服务的 Docker 映像的位置。

使用 apigee-pull-push --list 查看此组件的当前仓库网址。

watcher.replicaCountMax 基本 在以下版本中引入:1.3.0

默认值:1

watcher 副本数上限。为避免冲突,应将此文件保留在 1 中。

watcher.replicaCountMin 基本 在以下版本中引入:1.3.0

默认值:1

watcher 副本数下限。

watcher.resources.limits.cpu 高级 在以下版本中引入:1.11.0

默认值:1000m

Kubernetes 容器中资源的 CPU 限制,以毫米为单位。

watcher.resources.limits.memory 高级 在以下版本中引入:1.11.0

默认值:2Gi

Kubernetes 容器中资源的内存限制,以字节为单位。

watcher.serviceAccountPath 基本 在以下版本中引入:1.3.0

默认值:None

必填。

具有 Apigee Runtime Agent 角色的 Google 服务账号密钥文件的路径。

watcher.serviceAccountRef 高级 在以下版本中引入:1.3.0

默认值:None

必须提供 serviceAccountPath 或 serviceAccountRef。

watcher.tolerations.effect 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

effect 指定将容忍与污点匹配的影响。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

如需了解详情,请参阅污点和容忍:概念

watcher.tolerations.key 高级 在以下版本中引入:1.10.1

默认值:None

使用 Kubernetes 的污点和容忍功能所必需的属性。

key 标识可以应用容忍的 Pod。

如需了解详情,请参阅污点和容忍:概念

watcher.tolerations.operator 高级 在以下版本中引入:1.10.1

默认值:"Equal"

使用 Kubernetes 的污点和容忍功能所必需的属性。

operator 指定用于触发 effect 的操作。operator 的值可以是:

  • Equal 匹配 value 中设置的值。
  • Exists 忽略 value 中设置的值。

如需了解详情,请参阅污点和容忍:概念

watcher.tolerations.tolerationSeconds 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

tolerationSeconds 定义 Pod 与故障节点或无响应节点绑定的时长,以秒为单位。

如需了解详情,请参阅污点和容忍:概念

watcher.tolerations.value 高级 在以下版本中引入:1.10.1

默认值:None

Kubernetes 的污点和容忍功能使用。

value 是在 operator 设置为 Equal 时触发 effect 的值。

如需了解详情,请参阅污点和容忍:概念