設定屬性參考資料

本節列出可用來自訂 Apigee 混合部署作業的執行階段平面設定屬性。

篩選這個頁面

如要篩選這個頁面顯示的屬性,請選取「基本」(最常見的屬性) 或「進階」 (很少需要變更的屬性):

螢幕   本頁的設定屬性。

頂層屬性

下表說明 overrides.yaml 檔案中的頂層屬性。以下是不會屬於其他物件的屬性,並在機構或環境層級套用:

屬性 類型 說明
axHashSalt 進階

這項元素已在以下版本推出:1.3.0

預設值: iloveapis123

選用

Kubernetes 密鑰的名稱,其中包含用於計算雜湊值的鹽值,可在將使用者資料傳送至 Apigee Analytics 前進行模糊處理。如果您未指定鹽值,系統會預設使用 iloveapis123建立密鑰,並將鹽值做為輸入值。您可以在多個叢集中使用相同的鹽值,確保叢集之間的雜湊結果一致。

Apigee 會先使用 SHA512 雜湊處理原始值,再將資料從執行階段傳送至控制層。

請參閱「模糊處理使用者資料以進行數據分析」。

contractProvider 進階 這項元素已在以下版本推出:1.0.0

預設值: https://apigee.googleapis.com

定義安裝項目中所有 API 的 API 路徑。

如果混合式安裝作業使用以下格式的資料居住地,則必須使用此屬性:

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

其中 CONTROL_PLANE_LOCATION 是用來儲存控制平面資料 (例如 Proxy 套件) 的位置。如需清單,請參閱「可用的 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

預設值:

私人映像檔容器存放區的網址,用於從私人存放區提取所有 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

預設值:

已將 Kubernetes 密值名稱設為 docker-registry 類型,用於從私人存放區提取映像檔。

instanceID 基本 這項元素已在以下版本推出:1.3.0

預設值:

必要

此安裝作業的專屬 ID。

用於識別這個執行個體的專屬字串。可以是任意英文字母和數字的組合,長度上限為 63 個半形字元。

k8sClusterName 進階 Deprecated: 如果是 1.2.0 以上版本,請改用 k8sCluster.namek8sCluster.region

這項元素已在以下版本推出:1.0.0

預設值:

混合專案執行所在的 Kubernetes (K8S) 專用叢集名稱。可搭配 gcpProjectID (已淘汰) 和 gcpRegion (已淘汰) 使用,用於識別專案,並決定 apigee-loggerapigee-metrics 將資料推送至何處。

kmsEncryptionKey 進階 這項元素已在以下版本推出:1.0.0

預設值: defaults.org.kmsEncryptionKey

選填。請只使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 其中一個。

Apigee KMS 資料加密金鑰的本機檔案系統路徑。

kmsEncryptionPath 進階 這項功能已在以下版本推出:1.2.0

預設值:

選填。請只使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 其中一個。

包含以 Base64 編碼的加密金鑰檔案路徑。請參閱「資料加密」一節。

kmsEncryptionSecret.key 進階 這項功能已在以下版本推出:1.2.0

預設值:

選填。請只使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 其中一個。

包含 Base64 編碼加密金鑰的 Kubernetes 密鑰。請參閱「資料加密」一節。

kmsEncryptionSecret.name 進階 這項功能已在以下版本推出:1.2.0

預設值:

選填。請只使用 kmsEncryptionKeykmsEncryptionPathkmsEncryptionSecret 其中一個。

包含 Base64 編碼加密金鑰的 Kubernetes 密鑰名稱。請參閱「資料加密」一節。

kvmEncryptionKey 進階 這項元素已在以下版本推出:1.0.0

預設值: defaults.org.kmsEncryptionKey

選填。請只使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 其中一個。

Apigee KVM 資料加密金鑰的本機檔案系統路徑。

kvmEncryptionPath 進階 這項功能已在以下版本推出:1.2.0

預設值:

選填。請只使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 其中一個。

包含以 Base64 編碼的加密金鑰檔案路徑。請參閱「資料加密」一節。

kvmEncryptionSecret.key 進階 這項功能已在以下版本推出:1.2.0

預設值:

選填。請只使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 其中一個。

包含 Base64 編碼加密金鑰的 Kubernetes 密鑰。請參閱「資料加密」一節。

kvmEncryptionSecret.name 進階 這項功能已在以下版本推出:1.2.0

預設值:

選填。請只使用 kvmEncryptionKeykvmEncryptionPathkvmEncryptionSecret 其中一個。

包含 Base64 編碼加密金鑰的 Kubernetes 密鑰名稱。請參閱「資料加密」一節。

multiOrgCluster 進階 推出版本:1.10.0

預設值: false

對於多機構叢集,這個屬性可讓機構的評估指標匯出至 gcp.projectID 屬性中列出的專案。在多機構叢集中,為每個機構在覆寫檔案中套用這項設定。詳情請參閱「將多個混合式機構新增至叢集」。

namespace 基本 這項元素已在以下版本推出:1.0.0

預設值: apigee

要安裝 Apigee 元件的 Kubernetes 叢集命名空間。

org 基本

這項元素已在以下版本推出:1.0.0

預設值:

必要

在混合型安裝期間,Apigee 為您佈建的支援混合型機構。機構是 Apigee 中的頂層容器,其中包含所有 API 代理程式和相關資源。如果值為空白,請在建立後立即更新為貴機構名稱。

orgScopedUDCA 進階 這項功能已在以下版本推出:1.8.0

預設值: true

在機構層級啟用通用資料收集代理人服務 (UDCA),用於擷取數據分析、營利和偵錯 (追蹤) 資料,並將這些資料傳送至位於控制平面的統一數據分析平台 (UAP)。

機構層級 UDCA 會為所有 Apigee 環境使用單一 Google 服務帳戶。服務帳戶必須具備 Apigee Analytics 代理人 (roles/apigee.analyticsAgent) 角色。

使用 udca.serviceAccountPath 屬性指定服務帳戶金鑰檔案的路徑,或是在 overrides.yaml 設定檔中使用 udca.serviceAccountRef 屬性,在 Kubernetes 密鑰中提供金鑰。

如果您偏好為每個環境使用個別的 UDCA 代理程式,請設定 orgScopedUDCA: false,並設定 envs[].serviceAccountPaths.udcaenvs[].serviceAccountSecretRefs.udca 的值。

另請參閱:udca

revision 進階 這項元素已在以下版本推出:1.0.0

預設值: "1124" (您的 Apigee Hybrid 版本,不含句點。例如,版本 1.12.0 的預設值為 "1120")。

Apigee hybrid 支援滾動式 Kubernetes 更新,可透過逐步更新 Pod 執行個體,讓部署作業更新作業在無停機的情況下進行。

更新特定 YAML 覆寫值導致底層 Kubernetes PodTemplateSpec 變更時,客戶的 override.yaml 中也必須變更 revision 覆寫屬性。這是必要步驟,可讓基礎 Kubernetes ApigeeDeployment (AD) 控制器安全地進行從舊版到新版的滾動更新。您可以使用任何小寫文字值,例如:bluea1.0.0

變更並套用 revision 屬性後,所有元件都會進行逐步更新。

如要變更下列物件的屬性,就必須更新 revision

詳情請參閱「逐步更新」。

serviceAccountSecretProviderClass 進階 這項功能已在以下版本推出:1.12.0

預設值:

用於在 Vault 中儲存服務帳戶金鑰的機構專屬密鑰提供者類別名稱 (SecretProviderClass)。

請參閱「在 Hashicorp Vault 中儲存服務帳戶金鑰」。

validateOrg 進階 這項功能已在以下版本推出:1.8.0

預設值: true

啟用嚴格驗證 Apigee 機構與 Google Cloud 專案之間的連結,並檢查環境群組是否存在。

另請參閱 org

validateServiceAccounts 進階 這項元素已在以下版本推出:1.0.0

預設值: true

啟用服務帳戶權限的嚴格驗證。這會使用 Cloud Resource Manager API 方法 testIamPermissions,驗證提供的服務帳戶是否具備必要權限。如果是 Apigee 機構的服務帳戶,專案 ID 檢查項目就是對應至機構的專案 ID。對於指標和記錄器,系統會根據 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 入口閘道進行混合式安裝,請將此值設為 true
  • 如果是使用 Cloud Service Mesh 的混合式安裝作業 (Apigee 混合式版本 1.8 以下),請將這個值設為 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

預設值:

這項服務的 Docker 映像檔位置。

使用 apigee-pull-push --list 即可查看這個元件的目前存放區網址。

ao.resources.limits.cpu 進階 這項功能已在以下版本推出:1.2.0

預設值: 250m

Kubernetes 容器中資源的 CPU 限制,以毫核為單位。

ao.resources.limits.memory 進階 這項功能已在以下版本推出:1.2.0

預設值: 256Mi

Kubernetes 容器中資源的記憶體限制,以 MiB 為單位。

ao.resources.requests.cpu 進階 這項功能已在以下版本推出:1.2.0

預設值: 250m

Kubernetes 容器中資源正常運作所需的 CPU,以毫核為單位。

ao.resources.requests.memory 進階 這項功能已在以下版本推出:1.2.0

預設值: 256Mi

Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。

ao.tolerations.effect 進階 推出版本:1.10.1

預設值:

必須使用 Kubernetes 的 Taint 和容許條件功能

effect 會指定將容忍度與污點配對的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「污點和容許值:概念」。

ao.tolerations.key 進階 推出版本:1.10.1

預設值:

必須使用 Kubernetes 的 Taint 和容許條件功能

key 會指出可套用容許值的 Pod。

詳情請參閱「污點和容許值:概念」。

ao.tolerations.operator 進階 推出版本:1.10.1

預設值: "Equal"

必須使用 Kubernetes 的 Taint 和容許條件功能

operator 會指定用於觸發 effect 的作業。operator 的值可以是:

  • Equal 會與 value 中設定的值相符。
  • Exists 會忽略 value 中設定的值。

詳情請參閱「污點和容許值:概念」。

ao.tolerations.tolerationSeconds 進階 推出版本:1.10.1

預設值:

Kubernetes 的 Taint 和容許條件功能使用。

tolerationSeconds 以秒為單位定義 pod 與失敗或無回應節點繫結的時間長度。

詳情請參閱「污點和容許值:概念」。

ao.tolerations.value 進階 推出版本:1.10.1

預設值:

Kubernetes 的 Taint 和容許條件功能使用。

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

預設值:

這項服務的 Docker 映像檔位置。

使用 apigee-pull-push --list 即可查看這個元件的目前存放區網址。

apigeeIngressGateway.nodeSelector.key 進階 這項功能已在以下版本推出:1.11.0

預設值:

必要

用於指定輸入閘道服務專屬 Kubernetes 節點的節點選取器標籤鍵。

請參閱「 設定專屬節點集區」。

apigeeIngressGateway.nodeSelector.value 進階 這項功能已在以下版本推出:1.11.0

預設值:

用於指定輸入閘道服務的專屬 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 中,CPU 使用率的臨界值 (以可用的 CPU 資源總數百分比表示)。

當 CPU 使用率超過這個值時,混合型會逐漸增加 ReplicaSet 中的 Pod 數量,最多可達 apigeeIngressGateway.replicaCountMax

如要進一步瞭解 Kubernetes 中的資源調度功能,請參閱 Kubernetes 說明文件中的「水平 Pod 自動調度」一節。

apigeeIngressGateway.tolerations.effect 進階 這項功能已在以下版本推出:1.11.0

預設值:

必須使用 Kubernetes 的 Taint 和容許條件功能

effect 會指定將容忍度與污點配對的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「污點和容許值:概念」。

apigeeIngressGateway.tolerations.key 進階 這項功能已在以下版本推出:1.11.0

預設值:

必須使用 Kubernetes 的 Taint 和容許條件功能

key 會指出可套用容許值的 Pod。

詳情請參閱「污點和容許值:概念」。

apigeeIngressGateway.tolerations.operator 進階 這項功能已在以下版本推出:1.11.0

預設值: "Equal"

必須使用 Kubernetes 的 Taint 和容許條件功能

operator 會指定用於觸發 effect 的作業。operator 的值可以是:

  • Equal 會與 value 中設定的值相符。
  • Exists 會忽略 value 中設定的值。

詳情請參閱「污點和容許值:概念」。

apigeeIngressGateway.tolerations.tolerationSeconds 進階 這項功能已在以下版本推出:1.11.0

預設值:

Kubernetes 的 Taint 和容許條件功能使用。

tolerationSeconds 以秒為單位定義 pod 與失敗或無回應節點繫結的時間長度。

詳情請參閱「污點和容許值:概念」。

apigeeIngressGateway.tolerations.value 進階 這項功能已在以下版本推出:1.11.0

預設值:

Kubernetes 的 Taint 和容許條件功能使用。

value 是當 operator 設為 Equal 時,會觸發 effect 的值。

詳情請參閱「污點和容許值:概念」。

cassandra

定義管理執行階段資料存放區的混合服務。這個存放區會為在閘道上執行的應用程式,儲存應用程式設定、分散式配額計數器、API 金鑰和 OAuth 權杖。

詳情請參閱「StorageClass 設定」。

下表說明 cassandra 物件的屬性:

屬性 類型 說明
cassandra.annotations 進階 引入版本:1.5.0

預設值:

用於註解 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

預設值:

這項服務的 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

預設值:

儲存在 Kubernetes 機密中,包含 Cassandra 使用者和密碼的檔案名稱。您可以按照下列操作說明建立密鑰:建立密鑰

另請參閱:

cassandra.auth.secretProviderClass 進階 推出版本:1.10.3

預設值:

Cassandra 機密資料儲存空間政策。設定時,必須與參照外部密鑰提供者的 SecretProviderClass 相符,例如 Hashicorp Vault。如果未設定,Apigee Hybrid 會使用以下位置儲存的使用者名稱和密碼:

或儲存在下列位置的 Kubernetes 密鑰:

如需建立政策的操作說明,請參閱「在 Hashicorp Vault 中儲存 Cassandra 密鑰」。

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

預設值:

如果已啟用備份功能,且 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

預設值:

這項服務的 Docker 映像檔位置。

使用 apigee-pull-push --list 即可查看這個元件的目前存放區網址。

cassandra.backup.keyfile 進階 這項元素已在以下版本推出:1.3.0

預設值:

如果已啟用備份功能,且 cassandra.backup.cloudProvider 設為 HYBRID,則為必填屬性。

本機檔案系統中 SSH 私密金鑰檔案的路徑。

cassandra.backup.schedule 進階 這項元素已在以下版本推出:1.0.0

預設值: 0 2 * * *

備份 Cron 工作的排程。

請參閱「Cassandra 備份與復原」。

cassandra.backup.server 進階 這項元素已在以下版本推出:1.3.0

預設值:

如果已啟用備份功能,且 cassandra.backup.cloudProvider 設為 HYBRID,則為必填屬性。

遠端 SSH 備份伺服器的 IP 位址。

cassandra.backup.serviceAccountPath 進階 這項元素已在以下版本推出:1.0.0

預設值:

具有「儲存空間物件管理員」 (roles/storage.objectAdmin) 角色的 Google 服務帳戶金鑰檔案路徑。這個 Google 服務帳戶會用來將備份封存檔上傳至指定的 cassandra.backup.dbStorageBucket

如果已啟用備份功能,且 cassandra.backup.cloudProvider 已設為 GCP,則必須執行下列任一操作,確保 Apigee Hybrid 可存取 Google Cloud Storage 值區,以便上傳備份檔案:

cassandra.backup.serviceAccountRef 進階 這項功能已在以下版本推出:1.2.0

預設值:

現有 Kubernetes 密鑰的名稱,用於儲存具有 Storage 物件管理員 (roles/storage.objectAdmin) 角色的 Google 服務帳戶金鑰檔案內容。這個 Google 服務帳戶會用來將備份封存檔案上傳至指定的 cassandra.backup.dbStorageBucket

如果已啟用備份功能,且 cassandra.backup.cloudProvider 已設為 GCP,則必須執行下列任一操作,確保 Apigee Hybrid 可存取 Google Cloud Storage 值區,以便上傳備份檔案:

cassandra.backup.storageDirectory 進階 這項元素已在以下版本推出:1.3.0

預設值:

如果已啟用備份功能,且 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

預設值:

如果將 hostNetwork 設為 true,系統會為您將 DNS 政策設為 ClusterFirstWithHostNet

cassandra.externalSeedHost 基本 這項元素已在以下版本推出:1.0.0

預設值:

Cassandra 叢集節點的主機名稱或 IP。如未設定,系統會使用 Kubernetes 本機服務。

cassandra.heapNewSize 基本 這項元素已在以下版本推出:1.0.0

預設值: 100M

系統為較新的物件分配的 JVM 記憶體量,以 MB 為單位。

cassandra.hostNetwork 基本 推出版本:1.1.1

預設值: false

啟用 Kubernetes hostNetwork 功能。如果 Pod 網路命名空間沒有叢集間的連線 (叢集會在「島嶼網路模式」中執行),Apigee 會在多區域安裝作業中使用這項功能,以便在 Pod 之間進行通訊。這是非 GKE 安裝作業的預設情況,包括 VMware 或裸機上的 Google Distributed Cloud、AWS 上的 GKE、AKS、EKS 和 OpenShift。

如果是單一區域安裝作業和多區域安裝作業,且不同叢集中的 Pod 之間有連線 (例如 GKE 安裝作業),請將 cassandra.hostNetwork 設為 false

如果是多區域安裝作業,且不同叢集的 Pod 之間沒有通訊,請將 cassandra.hostNetwork 設為 true,例如 VMware 或裸機上的 Google Distributed Cloud、AWS、AKS、EKS 和 OpenShift 安裝作業上的 GKE。請參閱「多區域部署:必要條件」一文。

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

預設值:

這項服務的 Docker 映像檔位置。

使用 apigee-pull-push --list 即可查看這個元件的目前存放區網址。

cassandra.maxHeapSize 進階 這項元素已在以下版本推出:1.0.0

預設值: 512M

可用於 Cassandra 作業的 JVM 系統記憶體上限,以 MB 為單位。

cassandra.multiRegionSeedHost 基本 這項元素已在以下版本推出:1.0.0

預設值:

現有 Cassandra 叢集的 IP 位址,用於將現有叢集擴展至新的區域。請參閱「設定多區域種子主機」。

cassandra.nodeSelector.key 進階 這項元素已在以下版本推出:1.0.0

預設值:

必要

節點選取器標籤鍵,用於指定 cassandra 資料服務的專屬 Kubernetes 節點。

請參閱「 設定專屬節點集區」。

cassandra.nodeSelector.value 進階 這項元素已在以下版本推出:1.0.0

預設值:

選用的節點選取器標籤值,用於指定 cassandra 資料服務的專屬 Kubernetes 節點,並覆寫 nodeSelector.apigeeData 設定。

請參閱 nodeSelector

cassandra.port 進階 這項元素已在以下版本推出:1.0.0

預設值: 9042

用於連線至 Cassandra 的通訊埠編號。

cassandra.rack 基本 這項元素已在以下版本推出:1.0.0

預設值: ra-1

指定 Cassandra 節點的機架。

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 容器中資源正常運作所需的記憶體,以 MiB 為單位。

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

預設值:

如果啟用復原功能,且 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

預設值:

這項服務的 Docker 映像檔位置。

使用 apigee-pull-push --list 即可查看這個元件的目前存放區網址。

cassandra.restore.serviceAccountPath 進階 這項元素已在以下版本推出:1.0.0

預設值:

具有「儲存空間物件管理員」 (roles/storage.objectAdmin) 角色的 Google 服務帳戶金鑰檔案路徑。這個 Google 服務帳戶會用來從指定的 cassandra.restore.dbStorageBucket 下載備份封存檔。

如果啟用還原功能,且 cassandra.restore.cloudProvider 已設為 GCP,則必須執行下列任一操作,確保 Apigee Hybrid 能夠存取 Google Cloud Storage 值區,以便下載備份檔案進行還原:

cassandra.restore.serviceAccountRef 進階 這項功能已在以下版本推出:1.2.0

預設值:

現有 Kubernetes 密鑰的名稱,用於儲存具有 Storage 物件管理員 (roles/storage.objectAdmin) 角色的 Google 服務帳戶金鑰檔案內容。這個 Google 服務帳戶會用來從指定的 cassandra.restore.dbStorageBucket 下載備份封存檔。

如果啟用還原功能,且 cassandra.restore.cloudProvider 已設為 GCP,則必須執行下列任一操作,確保 Apigee Hybrid 能夠存取 Google Cloud Storage 值區,以便下載備份檔案進行還原:

cassandra.restore.snapshotTimestamp 進階 這項元素已在以下版本推出:1.0.0

預設值:

如果已啟用還原功能,則為必填欄位。

應還原的備份時間戳記。

cassandra.sslCertPath 基本 這項功能已在以下版本推出:1.2.0

預設值:

系統中 TLS 憑證檔案的路徑。

cassandra.sslKeyPath 基本 這項功能已在以下版本推出:1.2.0

預設值:

系統中 TLS 私密金鑰檔案的路徑。

cassandra.sslRootCAPath 基本 這項功能已在以下版本推出:1.2.0

預設值:

根 CA (憑證授權單位) 的憑證鏈結。

cassandra.storage.capacity 基本 這項元素已在以下版本推出:1.0.0

預設值: 10Gi

如果指定 storage.storageclass,則為必要欄位

以 MiB 或 GiB 為單位指定所需的磁碟空間大小。

cassandra.storage.storageclass 基本 這項元素已在以下版本推出:1.0.0

預設值:

指定所使用的內部儲存空間級別。

cassandra.storage.storageSize 基本 這項功能已在以下版本推出:1.11.0

預設值: 10Gi

如果指定 storage.storageclass,則為必要欄位

以 MiB 或 GiB 為單位指定所需的磁碟空間大小。

cassandra.terminationGracePeriodSeconds 進階 這項元素已在以下版本推出:1.0.0

預設值: 300

提出 Pod 刪除要求與 Pod 遭到終止之間的時間,以秒為單位。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。

cassandra.tolerations.effect 進階 推出版本:1.10.1

預設值:

必須使用 Kubernetes 的 Taint 和容許條件功能

effect 會指定將容忍度與污點配對的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「污點和容許值:概念」。

cassandra.tolerations.key 進階 推出版本:1.10.1

預設值:

必須使用 Kubernetes 的 Taint 和容許條件功能

key 會指出可套用容許值的 Pod。

詳情請參閱「污點和容許值:概念」。

cassandra.tolerations.operator 進階 推出版本:1.10.1

預設值: "Equal"

必須使用 Kubernetes 的 Taint 和容許條件功能

operator 會指定用於觸發 effect 的作業。operator 的值可以是:

  • Equal 會與 value 中設定的值相符。
  • Exists 會忽略 value 中設定的值。

詳情請參閱「污點和容許值:概念」。

cassandra.tolerations.tolerationSeconds 進階 推出版本:1.10.1

預設值:

Kubernetes 的 Taint 和容許條件功能使用。

tolerationSeconds 以秒為單位定義 pod 與失敗或無回應節點繫結的時間長度。

詳情請參閱「污點和容許值:概念」。

cassandra.tolerations.value 進階 推出版本:1.10.1

預設值:

Kubernetes 的 Taint 和容許條件功能使用。

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 端點公開在網際網路上。

下表說明 connectAgent 物件的屬性:

屬性 類型 說明
connectAgent.annotations 進階 引入版本:1.5.0

預設值:

用於註解 Pod 的選用鍵/值對應。詳情請參閱「自訂註解」。

connectAgent.gsa 進階 推出版本:1.10.0

預設值:

僅限 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

請參閱「在 GKE 上啟用 Workload Identity」或「在 AKS 和 EKS 上啟用 Workload Identity Federation」。

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.12.4

這項服務 Docker 映像檔的版本標籤。

connectAgent.image.url 進階 這項功能已在以下版本推出:1.2.0

預設值:

這項服務的 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 容器中資源的記憶體限制,以 MiB 為單位。

connectAgent.resources.requests.cpu 進階 這項功能已在以下版本推出:1.11.0

預設值: 100m

Kubernetes 容器中資源正常運作所需的 CPU,以毫核為單位。

connectAgent.resources.requests.memory 進階 這項功能已在以下版本推出:1.2.0

預設值: 30Mi

Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。

connectAgent.server 進階 這項功能已在以下版本推出:1.2.0

預設值: apigeeconnect.googleapis.com:443

這項服務的伺服器和通訊埠位置。

connectAgent.serviceAccountPath 基本 推出版本:1.1.1

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

apigee-mart 服務帳戶的 Google 服務帳戶金鑰檔案路徑。

在大多數安裝作業中,connectAgent.serviceAccountPath 的值必須與 mart.serviceAccountPath 的值相符。

connectAgent.serviceAccountRef 基本 這項功能已在以下版本推出:1.2.0

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

在大多數安裝作業中,connectAgent.serviceAccountRef 的值必須與