設定屬性參考資料

本節列出所有可用於自訂 Apigee Hybrid 部署作業執行階段層的設定屬性。

篩選這個頁面

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

多媒體廣告活動   這個頁面上的設定屬性。

頂層屬性

下表說明 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

預設值:

必要

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

預設值:

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

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 其中之一。

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

kmsEncryptionSecret.name 進階 推出版本:1.2.0

預設值:

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

Kubernetes 密鑰的名稱,其中包含以 base64 編碼的加密金鑰。請參閱「資料加密」一節。

kvmEncryptionKey 進階 推出版本:1.0.0

預設值: defaults.org.kmsEncryptionKey

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

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

kvmEncryptionPath 進階 推出版本:1.2.0

預設值:

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

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

kvmEncryptionSecret.key 進階 推出版本:1.2.0

預設值:

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

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

kvmEncryptionSecret.name 進階 推出版本:1.2.0

預設值:

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

Kubernetes 密鑰的名稱,其中包含以 base64 編碼的加密金鑰。請參閱「資料加密」一節。

multiOrgCluster 進階 導入版本:1.10.0

預設值: false

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

namespace 基本 推出版本:1.0.0

預設值: apigee

Kubernetes 叢集的命名空間,Apigee 元件將安裝於此。

org 基本

推出版本:1.0.0

預設值:

必要

Apigee 在 Hybrid 安裝期間為您佈建的混合型機構。機構是 Apigee 中的頂層容器,其中包含所有 API Proxy 和相關資源。如果值為空白,您必須在建立機構後,更新機構名稱。

orgScopedUDCA 進階 推出版本:1.8.0

預設值: true

在機構層級啟用通用資料收集代理程式 (UDCA) 服務,擷取分析、營利和偵錯 (追蹤) 資料,並傳送至位於控制平面的 Unified Analytics Platform (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

預設值: "1134" (不含句點的 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 檢查會對應至該機構。如果是指標和記錄器,系統會根據 gcpProjectID overrides.yaml 設定檢查專案。

另請參閱 gcpProjectID

ao

Apigee Operators (AO) 會建立及更新部署和維護元件所需的低階 Kubernetes 和 Istio 資源。舉例來說,控制器會執行訊息處理器的發布作業。

下表說明 apigee-operators ao 物件的屬性:

屬性 類型 說明
ao.args.disableIstioConfigInAPIServer 進階 推出版本:1.8.0

預設值: true

停止向客戶安裝的 Cloud Service Mesh 提供設定。

  • 如果是使用 Apigee Ingress 閘道的混合式安裝作業,請設為 true
  • 使用 Cloud Service Mesh 進行混合式安裝時,請設為 false (適用於 Apigee Hybrid 1.8 版和更早版本)。
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.13.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 的 Taints and Tolerations 功能時,必須設定這項屬性。

effect 則指定容許值與汙點相符時的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「Taints and Tolerations: Concepts」。

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

預設值:

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

key 會識別可套用容錯的 Pod。

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值: "Equal"

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

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

value 是觸發 effect 的值,前提是 operator 設為 Equal

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

apigeeIngressGateway

設定 Apigee Hybrid 的 Apigee 進入閘道。使用 apigeeIngressGateway 屬性,將一般設定套用至所有 Apigee Ingress 閘道執行個體。

如要個別設定執行個體,請參閱 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

預設值:

必要

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

請參閱 設定專屬節點集區

apigeeIngressGateway.nodeSelector.value 進階 版本:1.11.0

預設值:

選用節點選取器標籤值,用於指定輸入閘道服務的專屬 Kubernetes 節點,並覆寫 nodeSelector.apigeeData 設定。

請參閱 nodeSelector

apigeeIngressGateway.replicaCountMax 基本 版本:1.11.0

預設值: 4

混合式可自動新增的 Pod 數量上限,適用於可自動調整資源配置的 Ingress 閘道。

apigeeIngressGateway.replicaCountMin 基本 版本:1.11.0

預設值: 2

可供自動調整資源配置的 Ingress 閘道 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

預設值:

使用 Kubernetes 的 Taints and Tolerations 功能時,必須設定這項屬性。

effect 則指定容許值與汙點相符時的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「Taints and Tolerations: Concepts」。

apigeeIngressGateway.tolerations.key 進階 版本:1.11.0

預設值:

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

key 會識別可套用容錯的 Pod。

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

apigeeIngressGateway.tolerations.operator 進階 版本:1.11.0

預設值: "Equal"

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

apigeeIngressGateway.tolerations.tolerationSeconds 進階 版本:1.11.0

預設值:

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

apigeeIngressGateway.tolerations.value 進階 版本:1.11.0

預設值:

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

value 是觸發 effect 的值,前提是 operator 設為 Equal

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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.13.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 密鑰儲存空間政策。設定後,這個值必須與參照外部密鑰提供者 (例如 Hashicorp Vault) 的 SecretProviderClass 相符。如果未設定,Apigee Hybrid 會使用儲存在下列位置的使用者名稱和密碼:

或儲存在下列位置的 Kubernetes Secret:

如需建立政策的操作說明,請參閱在 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,則為必填欄位。

現有 Google Cloud Storage 值區的名稱,用於儲存備份封存檔。如需建立 bucket,請參閱「 建立 bucket」一文。

cassandra.backup.enabled 進階 推出版本:1.0.0

預設值: false

根據預設,系統不會啟用資料備份功能。如要啟用,請設為 true

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

cassandra.backup.gsa 進階 導入版本:1.10.0

預設值:

僅限 Helmapigee-cassandra Google IAM 服務帳戶 (GSA) 的電子郵件地址,用於在 GKE 叢集上啟用 Workload Identity 時,與 Cassandra 備份 Kubernetes 服務帳戶建立關聯。當您將 gcp.workloadIdentity.enabled 設為 true,並將 cassandra.backup.enabled 設為 true 時,請設定此值。

GSA 電子郵件地址的格式通常為:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「在 GKE 上啟用 Workload Identity Federation」。

cassandra.backup.image.pullPolicy 進階 推出版本:1.0.0

預設值: IfNotPresent

決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:

  • IfNotPresent:如果已有映像檔,請勿提取新映像檔。
  • Always:一律提取映像檔,無論映像檔是否已存在。

詳情請參閱「更新圖片」。

cassandra.backup.image.tag 進階 推出版本:1.0.0

預設值: 1.13.4

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

cassandra.backup.image.url 進階 推出版本:1.0.0

預設值:

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

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

cassandra.backup.keyfile 進階 導入版本:1.3.0

預設值:

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

本機檔案系統中安全殼層私密金鑰檔案的路徑。

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

預設值:

具有「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

預設值:

現有 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) 的預設情況。

針對單一區域安裝和多區域安裝,請將 cassandra.hostNetwork 設為 false,以便在不同叢集的 Pod 之間建立連線,例如 GKE 安裝。

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

trueDNS 政策會自動設為 ClusterFirstWithHostNet

cassandra.image.pullPolicy 進階 推出版本:1.0.0

預設值: IfNotPresent

決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:

  • IfNotPresent:如果已有映像檔,請勿提取新映像檔。
  • Always:一律提取映像檔,無論映像檔是否已存在。

詳情請參閱「更新圖片」。

cassandra.image.tag 進階 推出版本:1.0.0

預設值: 1.13.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

預設值:

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

請參閱 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,則為必填

Google Cloud Storage bucket 的名稱,用於儲存備份封存檔,以供資料還原。

cassandra.restore.enabled 進階 推出版本:1.0.0

預設值: false

根據預設,系統不會啟用資料還原功能,如要啟用,請設為 true

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

cassandra.restore.gsa 進階 導入版本:1.10.0

預設值:

僅限 Helm:啟用 GKE 叢集上的 Workload Identity 時,要與 Cassandra 還原 Kubernetes 服務帳戶建立關聯的 apigee-cassandra Google IAM 服務帳戶 (GSA) 電子郵件地址。當您將 gcp.workloadIdentity.enabled 設為 true,並將 cassandra.restore.enabled 設為 true 時,請設定此值。

GSA 電子郵件地址的格式通常為:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「在 GKE 上啟用 Workload Identity Federation」。

cassandra.restore.image.pullPolicy 進階 推出版本:1.0.0

預設值: IfNotPresent

決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:

  • IfNotPresent:如果已有映像檔,請勿提取新映像檔。
  • Always:一律提取映像檔,無論映像檔是否已存在。

詳情請參閱「更新圖片」。

cassandra.restore.image.tag 進階 推出版本:1.0.0

預設值: 1.13.4

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

cassandra.restore.image.url 進階 推出版本:1.0.0

預設值:

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

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

cassandra.restore.serviceAccountPath 進階 推出版本:1.0.0

預設值:

具有「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

預設值:

現有 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 的 Taints and Tolerations 功能時,必須設定這項屬性。

effect 則指定容許值與汙點相符時的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「Taints and Tolerations: Concepts」。

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

預設值:

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

key 會識別可套用容錯的 Pod。

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值: "Equal"

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

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

value 是觸發 effect 的值,前提是 operator 設為 Equal

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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:啟用 GKE 叢集上的 Workload Identity 時,connectAgent 會使用 Helm 資訊圖表,將 Google IAM 服務帳戶 (GSA) 的電子郵件地址與對應的 Kubernetes 服務帳戶建立關聯。設定 gcp.workloadIdentity.enabledtrue 時,請設定此值。

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.13.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 的值必須與 mart.serviceAccountRef 的值相符。

connectAgent.targetCPUUtilizationPercentage 進階 推出版本:1.2.0

預設值: 75

Pod 中 Apigee Connect 代理程式的目標 CPU 使用率。當 CPU 使用率達到這個欄位的值時,Apigee Connect 就會自動調度資源,直到達到 replicaCountMax 為止。

connectAgent.terminationGracePeriodSeconds 進階 推出版本:1.2.0

預設值: 600

要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。

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

預設值:

使用 Kubernetes 的 Taints and Tolerations 功能時,必須設定這項屬性。

effect 則指定容許值與汙點相符時的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

詳情請參閱「Taints and Tolerations: Concepts」。

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

預設值:

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

key 會識別可套用容錯的 Pod。

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值: "Equal"

使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

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

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

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

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

value 是觸發 effect 的值,前提是 operator 設為 Equal

詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。

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

預設值:

必要

Google Cloud 儲存空間 bucket 的名稱,診斷資料會存放在這裡。

請參閱「建立儲存空間值區」。

diagnostic.container 基本 推出版本:1.6.0

預設值:

必要

這會指定要從哪種 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" 會擷取有關 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

預設值:

如果診斷收集作業為「LOGGING」(使用 operation: "LOGGING" 設定),則為必填

收集到的記錄資料時間長度 (以毫秒為單位)。一般值為 30000

請參閱diagnostic.operation

diagnostic.loggingDetails.loggerNames[] 基本 推出版本:1.6.0

預設值:

如果診斷收集作業為「LOGGING」(使用 operation: "LOGGING" 設定),則為必填

依名稱指定要收集資料的記錄器。如果是 Apigee Hybrid 1.6.0 版,唯一支援的值是 ALL,也就是所有記錄器。例如:

diagnostic:
 loggingDetails:
   loggerNames:
   - ALL
diagnostic.loggingDetails.logLevel 基本 推出版本:1.6.0

預設值:

如果診斷收集作業為「LOGGING」(使用 operation: "LOGGING" 設定),則為必填

指定要收集的記錄資料精細程度。在 Apigee Hybrid 1.6 中,系統僅支援 FINE

diagnostic.namespace 基本 推出版本:1.6.0

預設值:

必要

您要收集資料的 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

預設值:

必要

指定要收集所有統計資料,還是只收集記錄。

值為:

diagnostic.podNames[] 基本 推出版本:1.6.0

預設值:

必要

您要收集資料的 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

預設值:

必要

具有 Storage 管理員角色 (roles/storage.admin) 的服務帳戶,其服務帳戶金鑰檔案 (.json) 的路徑。在大多數 Apigee Hybrid 安裝作業中,這是 apigee-cassandra 服務帳戶。

請參閱「關於服務帳戶」。

diagnostic.tcpDumpDetails.maxMsgs 基本 推出版本:1.6.0

預設值:

如果您使用 diagnostic.tcpDumpDetails,則必須提供 diagnostic.tcpDumpDetails.maxMsgsdiagnostic.tcpDumpDetails.timeoutInSeconds 其中之一。

設定要收集的 tcpDump 訊息數量上限。Apigee 建議最大值不超過 1000

diagnostic.tcpDumpDetails.timeoutInSeconds 基本 推出版本:1.6.0

預設值:

如果您使用 diagnostic.tcpDumpDetails,則必須提供 diagnostic.tcpDumpDetails.maxMsgsdiagnostic.tcpDumpDetails.timeoutInSeconds 其中之一。

設定等待 tcpDump 傳回訊息的時間長度 (以秒為單位)。

diagnostic.threadDumpDetails.delayInSeconds 基本 推出版本:1.6.0

預設值:

如果您使用 diagnostic.threadDumpDetails,則必須提供 diagnostic.threadDumpDetails.delayInSecondsdiagnostic.threadDumpDetails.iterations

收集每個執行緒傾印之間的延遲時間 (以秒為單位)。

diagnostic.threadDumpDetails.iterations 基本 推出版本:1.6.0

預設值:

如果您使用 diagnostic.threadDumpDetails,則必須提供 diagnostic.threadDumpDetails.delayInSecondsdiagnostic.threadDumpDetails.iterations

要收集的 jstack 執行緒傾印疊代次數。

envs

定義可部署 API Proxy 的環境陣列。每個環境都會提供獨立的內容或沙箱,用於執行 API Proxy。

啟用混合式功能的機構必須至少有一個環境。

詳情請參閱「關於環境」一文。

下表說明 envs 物件的屬性:

屬性 類型 說明
envs[].cacheEncryptionKey 基本 推出版本:1.0.0

預設值:

必須提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 其中之一。

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

envs[].cacheEncryptionPath 基本 推出版本:1.2.0

預設值:

必須提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 其中之一。

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

envs[].cacheEncryptionSecret.key 基本 推出版本:1.2.0

預設值:

必須提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 其中之一。

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

envs[].cacheEncryptionSecret.name 基本 推出版本:1.2.0

預設值:

你必須提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 其中之一。

Kubernetes 密鑰的名稱,其中包含以 base64 編碼的加密金鑰。請參閱「資料加密」一節。

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

預設值:

僅限 Helm:執行階段 Google IAM 服務帳戶的電子郵件地址,用於在 GKE 叢集上啟用 Workload Identity 時,與對應的 Kubernetes 服務帳戶建立關聯 (使用 Helm 圖表)。

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

envs.gsa.synchronizer 進階 導入版本:1.10.0

預設值:

僅限 Helm:啟用 Workload Identity 時,同步器 Google IAM 服務帳戶的電子郵件地址會與對應的 Kubernetes 服務帳戶建立關聯。啟用方式是使用 Helm 資訊套件,

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

envs.gsa.udca 進階 導入版本:1.10.0

預設值:

僅限 Helm:udca Google IAM 服務帳戶的電子郵件地址 (適用於環境範圍的 udca),用於在 GKE 叢集上使用 Helm 資訊圖表啟用 Workload Identity 時,與對應的 Kubernetes 服務帳戶建立關聯。

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

envs[].hostAliases[] 基本 推出版本:1.2.0

預設值:

Deprecated:從 Hybrid 1.4 版開始,執行階段平面會從管理平面接收這項資訊。請參閱關於環境和環境群組

envs[].httpProxy.host 基本 推出版本:1.2.0

預設值:

指定執行 HTTP Proxy 的主機名稱或 IP 位址。

schemehostport 的順序列出 httpProxy 屬性。例如:

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

另請參閱:為 API Proxy 設定轉送 Proxy

envs[].httpProxy.port 基本 推出版本:1.2.0

預設值:

指定 HTTP Proxy 執行的通訊埠。如果省略這項屬性,系統預設會使用 HTTP 的通訊埠 80,以及 HTTPS 的通訊埠 443

envs[].httpProxy.scheme 基本 推出版本:1.2.0

預設值: HTTPS

指定 HTTP Proxy 的類型,例如 HTTP 或 HTTPS。根據預設,這項功能會使用 HTTPS

envs[].httpProxy.username 基本 推出版本:1.2.0

預設值:

如果 HTTP Proxy 需要基本驗證,請使用這個屬性提供使用者名稱。

envs[].httpProxy.password 基本 推出版本:1.2.0

預設值:

如果 HTTP Proxy 需要基本驗證,請使用這個屬性提供密碼。

envs[].name 基本 推出版本:1.0.0

預設值:

必要

要同步的 Apigee 環境名稱。

envs[].pollInterval 進階 推出版本:1.0.0

預設值:

輪詢機構和環境同步處理變更的時間間隔 (以秒為單位)。

envs[].port 進階 推出版本:1.0.0

預設值:

HTTPS 流量的 TCP 通訊埠編號。

envs[].serviceAccountPaths.runtime 基本 導入版本:1.4.0

預設值:

本機系統上檔案的路徑,該檔案是具有「Cloud Trace 代理人」角色的 Google 服務帳戶金鑰,通常是 apigee-runtime 服務帳戶。如要瞭解服務帳戶的預設名稱和指派的角色,請參閱「關於服務帳戶」一文。

envs[].serviceAccountPaths.synchronizer 基本 推出版本:1.0

預設值:

本機系統上檔案的路徑,該檔案是具有「Apigee Synchronizer Manager」角色的 Google 服務帳戶金鑰。

envs[].serviceAccountPaths.udca 基本 推出版本:1.0

預設值:

本機系統上檔案的路徑,該檔案是具有 Apigee Analytics 代理程式角色的 Google 服務帳戶金鑰。

只有在 orgScopedUDCA 設為 false 時,才需要設定這個屬性。

envs[].serviceAccountSecretProviderClass 進階 版本:1.12.0

預設值:

用於在 Vault 中儲存服務帳戶金鑰的環境專屬密鑰供應商類別名稱 (SecretProviderClass)。

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

envs[].serviceAccountSecretRefs.runtime 基本 導入版本:1.4.0

預設值:

Kubernetes 密鑰名稱。您必須使用具有 Cloud Trace 代理者角色的 Google 服務帳戶金鑰做為輸入內容,建立密鑰

envs[].serviceAccountSecretRefs.synchronizer 基本 推出版本:1.2.0

預設值:

Kubernetes 密鑰名稱。您必須使用具有「Apigee Synchronizer Manager」角色的 Google 服務帳戶金鑰建立密鑰

envs[].serviceAccountSecretRefs.udca 基本 推出版本:1.2.0

預設值:

Kubernetes 密鑰名稱。您必須使用具有「Apigee Analytic Agent」角色的 Google 服務帳戶金鑰做為輸入內容,建立密鑰

只有在 orgScopedUDCA 設為 false 時,才需要設定這個屬性。

envs[].sslCertPath 基本 推出版本:1.2.0

預設值:

請提供 sslCertPath/sslKeyPathsslSecret

系統中傳輸層安全標準 (TLS) 憑證檔案的路徑。

envs[].sslKeyPath 基本 推出版本:1.2.0

預設值:

必須提供 sslCertPath/sslKeyPathsslSecret

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

envs[].sslSecret 基本 推出版本:1.2.0

預設值:

請提供 sslCertPath/sslKeyPathsslSecret

儲存在 Kubernetes 密鑰中的檔案名稱,該檔案包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。

另請參閱:

gcp

識別 Google Cloud 專案 ID (所有混合式安裝作業都必須提供)、Workload Identity 和聯盟 Workload Identity 設定,以及 apigee-loggerapigee-metrics 推送資料的區域。

下表說明 gcp 物件的屬性:

屬性 類型 說明
gcp.federatedWorkloadIdentity.audience 基本 版本:1.12.0

預設值:

非 GKE 平台上的 Workload Identity 提供者允許的對象。

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

gcp.federatedWorkloadIdentity.credentialSourceFile 基本 版本:1.12.0

預設值:

Workload Identity Federation 用來取得服務帳戶憑證的憑證來源檔案名稱和路徑。使用 create-cred-config 指令設定 Workload Identity Federation 時,您為 credential-source-file 提供的值。

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

gcp.federatedWorkloadIdentity.enabled 基本 版本:1.12.0

預設值: false

在非 GKE 平台上啟用 Workload Identity Federation。如果 gcp.workloadIdentity.enabled 在同一個叢集中設為 true,則不得設定 true

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

gcp.federatedWorkloadIdentity.tokenExpiration 基本 版本:1.12.0

預設值: 3600

權杖的生命週期 (以秒為單位)。

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

gcp.projectID 基本 推出版本:1.2.0

預設值:

必要

識別 Google Cloud 專案,其中 apigee-loggerapigee-metrics 會推送資料。

gcp.projectIDRuntime 基本 推出版本:1.2.0

預設值:

識別執行階段 Kubernetes 叢集專案。

projectIDRuntime 屬性為選用項目。如未使用,系統會假設 projectID 值同時用於 Apigee 機構的 Google Cloud 專案和執行階段 K8S 叢集的專案。

gcp.region 基本 推出版本:1.2.0

預設值: us-central1

必要

識別 Google Cloud 區域apigee-loggerapigee-metrics 會將資料推送至該區域。

gcp.workloadIdentity.enabled 基本 導入版本:1.10.0

預設值:false

僅限 Helm:啟用在 GKE 上使用 Workload Identity。透過 Workload Identity,GKE 叢集中的工作負載可以模擬 Identity and Access Management (IAM) 服務帳戶,存取 Google Cloud 服務。

如果 gcp.federatedWorkloadIdentity.enabled 在同一個叢集中設為 true,則不得設定 true

如果 enabled 為預設值 false,Apigee 會為每個 Apigee Hybrid 元件使用 IAM 服務帳戶。請參閱「關於服務帳戶」。

如果 workloadIdentityEnabledtrue,Apigee 會使用 Kubernetes 服務帳戶,並將這些帳戶對應至每個元件的適當 IAM 服務帳戶。使用下列指令指定要對應至 Kubernetes 服務帳戶的 IAM 服務帳戶: