配置属性参考文档

在以下版本中引入：1.3.0

默认值：iloveapis123

图表： apigee-org

可选

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

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

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

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

图表： apigee-operator、apigee-datastore、apigee-telemetry、apigee-redis、apigee-ingress-manager、apigee-org、apigee-env、apigee-virtualhost

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

如果 Hybrid 安装按照以下格式使用数据驻留，则是必需的：

contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

其中 CONTROL_PLANE_LOCATION 是存储代理软件包等控制平面数据的位置。如需查看列表，请参阅可用的 Apigee API 控制平面区域。

例如：

contractProvider: https://us-apigee.googleapis.com

默认值：true

图表： apigee-telemetry

设置为 true（默认值）时，可启用 Apigee 的基于指标的自动扩缩功能。设置为 false 可停用自定义自动扩缩功能。

通过更新 apigee-telemetry 图表，将更改应用于 customAutoscaling.enabled。

默认值：false

图表： apigee-org、apigee-virtualhost

必需

Apigee 增强型个别环境设置的代理限制功能需要 enhanceProxyLimits。如果您的 Hybrid 组织有权使用增强型个别环境代理限制，请将此值设置为 enhanceProxyLimits: true。

请参阅：

• API 代理限制。
• 增强型个别环境代理限制。
• 订阅权益。

代理链、端点链和 ServiceCallout 链都需要设置 enhanceProxyLimits: true。如需了解详情，请参阅以下主题：

• 将 API 代理连接到一起
• ServiceCallout 政策

通过更新每个环境组的 apigee-org 图表和 apigee-virtualhost 图表，将更改应用于 enhanceProxyLimits。

在以下版本中引入：1.0.0

默认值：none

图表： apigee-telemetry、apigee-org

必需

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

在以下版本中引入：1.0.0

默认值：us-central1

图表： apigee-telemetry、apigee-org

必需

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

默认值：None

图表： apigee-operator、apigee-datastore、apigee-telemetry、apigee-redis、apigee-ingress-manager、apigee-org、apigee-env、apigee-virtualhost

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

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

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

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

hub: private-docker-host.example.com

解析为：

containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.16.11
  imagePullPolicy: IfNotPresent

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

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

请参阅使用 Apigee Hybrid 处理私有映像仓库。

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

• ao.image.url
• apigeeIngressGateway.image.url
• cassandra.image.url
• cassandra.auth.image.url
• cassandra.backup.image.url
• cassandra.restore.image.url
• connectAgent.image.url
• guardrails.image.url
• ingressGateways[].image.url
• istiod.image.url
• kubeRBACProxy.image.url
• logger.image.url
• mart.image.url
• metrics.adapter.image.url
• metrics.prometheus.image.url
• metrics.sdSidecar.image.url
• mintTaskScheduler.image.url
• redis.image.url
• redis.envoy.image.url
• runtime.image.url
• synchronizer.image.url
• udca.image.url
• udca.fluentd.image.url
• watcher.image.url

默认值：None

图表： apigee-operator、apigee-redis、apigee-org、apigee-env

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

默认值：None

图表： apigee-org

必需

此安装的唯一标识符。

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

默认值：defaults.org.kmsEncryptionKey

图表： apigee-org、apigee-env

可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。

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

默认值：None

图表： apigee-org、apigee-env

可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。

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

默认值：None

图表： apigee-org、apigee-env

可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。

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

默认值：None

图表： apigee-org、apigee-env

可选。仅使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 之一。

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

默认值：defaults.org.kmsEncryptionKey

图表： apigee-org、apigee-env

可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。

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

默认值：None

图表： apigee-org、apigee-env

可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。

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

默认值：None

图表： apigee-org、apigee-env

可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。

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

默认值：None

图表： apigee-org、apigee-env

可选。仅使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 之一。

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

默认值：false

图表： apigee-telemetry

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

默认值：apigee

图表： apigee-datastore、apigee-env、apigee-ingress-manager、apigee-operator、apigee-org、apigee-redis、apigee-telemetry、apigee-virtualhost

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

在以下版本中引入：1.0.0

默认值：None

图表： apigee-operator、apigee-telemetry、apigee-org、apigee-env、apigee-virtualhost

必需

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

默认值："11611"（不包含句点的 Apigee Hybrid 版本）。例如，对于 1.12.0 版，默认值为 "1120"。）

图表： apigee-operator

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

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

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

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

• nodeSelector
• envs
• imagePullSecrets
• gcpProjectID
• k8sClusterName
• contractProvider
• 单位部门

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

默认值：None

图表： apigee-datastore、apigee-env、apigee-org、apigee-telemetry

在 Vault 中存储服务账号密钥的组织专属 Secret 提供方类 (SecretProviderClass) 的名称。

请参阅在 Hashicorp Vault 中存储服务账号密钥。

默认值：None

图表： apigee-datastore、apigee-env、apigee-ingress-manager、apigee-operator、apigee-org、apigee-redis、apigee-telemetry、apigee-virtualhost

为 Apigee Hybrid 组件中的 Kubernetes 污点和容忍功能设置全局默认值。

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

• NoExecute
• NoSchedule
• PreferNoSchedule

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-datastore、apigee-env、apigee-ingress-manager、apigee-operator、apigee-org、apigee-redis、apigee-telemetry、apigee-virtualhost

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值："Equal"

图表： apigee-datastore、apigee-env、apigee-ingress-manager、apigee-operator、apigee-org、apigee-redis、apigee-telemetry、apigee-virtualhost

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

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-datastore、apigee-env、apigee-ingress-manager、apigee-operator、apigee-org、apigee-redis、apigee-telemetry、apigee-virtualhost

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-datastore、apigee-env、apigee-ingress-manager、apigee-operator、apigee-org、apigee-redis、apigee-telemetry、apigee-virtualhost

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：true

图表： apigee-ingress-manager

阻止 Apigee 向客户安装的 Cloud Service Mesh 提供配置。

• 对于使用 Apigee 入站流量网关的 Hybrid 安装，设置为 true。
• 对于使用 Cloud Service Mesh（Apigee Hybrid 1.8 版及更早版本）的 Hybrid 安装，设置为 false。

默认值：true

图表： apigee-operator

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

默认值：IfNotPresent

图表： apigee-operator、apigee-ingress-manager

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

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

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

默认值：1.16.11

图表： apigee-operator、apigee-ingress-manager

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

默认值：None

图表： apigee-operator、apigee-ingress-manager

此服务的 Docker 映像的位置。

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

默认值：250m

图表： apigee-operator、apigee-ingress-manager

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

默认值：256Mi

图表： apigee-operator、apigee-ingress-manager

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

默认值：250m

图表： apigee-operator、apigee-ingress-manager

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

默认值：256Mi

图表： apigee-operator、apigee-ingress-manager

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

默认值：None

图表： apigee-operator

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

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

• NoExecute
• NoSchedule
• PreferNoSchedule

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-operator

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值："Equal"

图表： apigee-operator

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

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-operator

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-operator

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：IfNotPresent

图表： apigee-org

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

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

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

默认值：1.16.11

图表： apigee-org

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

默认值：None

图表： apigee-org

此服务的 Docker 映像的位置。

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

默认值：None

图表： apigee-org

必需

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

请参阅配置专用节点池。

默认值：None

图表： apigee-org

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

请参阅 nodeSelector。

在以下版本中引入：1.16.10

默认值：None

图表： apigee-org

在主动中断期间（例如在节点池升级或节点排空期间）必须保持可用的 Apigee 入站流量网关 Pod 的数量下限。此字段用于为这些 Pod 设置 PodDisruptionBudget 的 minAvailable 字段。它接受整数个 Pod (1) 或百分比字符串 ("50%")。

minAvailable 和 maxUnavailable 是互斥的，只能设置其中一个。Apigee Operator 会拒绝同时设置这两者。如果您未设置任何字段，Apigee Operator 仍会为这些 Pod 生成 PodDisruptionBudget，默认使用 maxUnavailable: 1。如需为特定网关设置不同的预算，请使用 ingressGateways[].podDisruptionBudget.minAvailable。

例如，在 overrides.yaml 中：

apigeeIngressGateway:
  podDisruptionBudget:
    minAvailable: "50%"

在以下版本中引入：1.16.10

默认值：None

图表： apigee-org

在主动中断（例如节点池升级或节点排空）期间，允许不可用的 Apigee 入口流量网关 Pod 数量上限。此字段用于为这些 Pod 设置 PodDisruptionBudget 的 maxUnavailable 字段。该参数可接受整数个 Pod (1) 或百分比字符串 ("50%")。

maxUnavailable 和 minAvailable 互斥；只能设置一个。Apigee Operator 会拒绝同时设置这两者。如果您未设置这两个字段，Apigee 运算符仍会为这些 pod 生成 PodDisruptionBudget，默认使用 maxUnavailable: 1。如需为特定网关设置不同的预算，请使用 ingressGateways[].podDisruptionBudget.maxUnavailable。

例如，在 overrides.yaml 中：

apigeeIngressGateway:
  podDisruptionBudget:
    maxUnavailable: 1

在以下版本中引入：1.16.6

默认值：disable

图表： apigee-org

为所有入站流量网关组件设置 HAProxy PROXY 协议解析的全局默认值。允许的值为 strict、permissive 或 disable。

您可以使用 ingressGateways[].proxyProtocol.mode 针对每个网关替换此全局默认值。

默认值：4

图表： apigee-org

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

默认值：2

图表： apigee-org

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

默认值：75

图表： apigee-org

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

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

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

默认值：None

图表： apigee-org

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

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

• NoExecute
• NoSchedule
• PreferNoSchedule

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-org

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值："Equal"

图表： apigee-org

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

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-org

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-org

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

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

如需了解详情，请参阅污点和容忍：概念。

默认值：None

图表： apigee-datastore

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

默认值：iloveapis123

图表： apigee-datastore

必需

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

默认值：iloveapis123

图表： apigee-datastore

必需

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

默认值：iloveapis123

图表： apigee-datastore

必需

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

默认值：iloveapis123

图表： apigee-datastore

必需

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

默认值：IfNotPresent

图表： apigee-datastore、apigee-org

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

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

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

默认值：1.16.11

图表： apigee-datastore、apigee-org

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

默认值：None

图表： apigee-datastore、apigee-org

此服务的 Docker 映像的位置。

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

默认值：iloveapis123

图表： apigee-datastore

必需

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

默认值：jmxuser

图表： apigee-datastore

必需

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

默认值：iloveapis123

图表： apigee-datastore

必需

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

默认值：apigee

图表： apigee-datastore

必需

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

默认值：None

图表： apigee-datastore

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

另请参阅：

• 在 Kubernetes Secret 中存储数据
• Kubernetes 文档中的 Secret
• Kubernetes 文档中的使用 kubectl 创建 Secret

默认值：None

图表： apigee-datastore、apigee-operator

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

• cassandra.auth.admin.password
• cassandra.auth.ddl.password
• cassandra.auth.default.password
• cassandra.auth.dml.password
• cassandra.auth.jmx.password
• cassandra.auth.jmx.username
• cassandra.auth.jolokia.password
• cassandra.auth.jolokia.username

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