配置属性参考文档

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

过滤此页面

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

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

顶层属性

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

属性 类型 说明
axHashSalt 高级

在以下版本中引入:1.3.0

默认值:iloveapis123

可选

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

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

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

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

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

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

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

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

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

例如:

contractProvider: https://us-apigee.googleapis.com
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

用于从私有仓库中拉取所有 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.12.4
  imagePullPolicy: IfNotPresent

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

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

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

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

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

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

默认值"1124"(不包含句点的 Apigee Hybrid 版本)。例如,对于 1.12.0 版,默认值为 "1120"。)

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

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

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

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

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

serviceAccountSecretProviderClass 高级 在以下版本中引入:1.12.0

默认值:None

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

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

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 向客户安装的 Cloud Service Mesh 提供配置。

  • 对于使用 Apigee 入站流量网关的 Hybrid 安装,设置为 true
  • 对于使用 Cloud 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.12.4

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

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

默认值:None

此服务的 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

使用 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.4-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、1.12.1

默认值: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.12.4

此服务 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.12.4

此服务 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 安装中的默认情况,包括 Google Distributed Cloud on VMware 或 Bare Metal、GKE on AWS、AKS、EKS 和 OpenShift。

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

对于不同集群的 pod 之间没有通信的多区域安装(例如 Google Distributed Cloud on VMware 或 bare metal、GKE on AWS、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.12.4

此服务 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.12.4

此服务 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.storage.storageSize 基本 在以下版本中引入:1.11.0

默认值:10Gi

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

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

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。

如需了解详情,请参阅