設定屬性參考資料

本節列出可用來自訂 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
customAutoscaling.enabled 基本 這項功能已在以下版本推出:1.14.0

預設值: true

將其設為 true (預設值) 時,即可啟用 Apigee 的以指標為依據的自動調度資源。設為 false 可停用自訂自動調度資源功能。

更新 apigee-telemetry 圖表,將變更套用至 customAutoscaling.enabled

enhanceProxyLimits 進階 這項功能已在以下版本推出:1.14.0

預設值: false

必要

enhanceProxyLimits 是 Apigee 強化的個別環境 Proxy 限制功能的必要條件。如果混合式機構有權使用強化的個別環境 Proxy 限制,請將這個值設為 enhanceProxyLimits: true

請參閱:

設定 enhanceProxyLimits: true 是設定 Proxy Chaining、Endpoint Chaining 和 ServiceCallout Chaining 的必要條件。詳情請參閱:

更新每個環境群組的 apigee-org 圖表和 apigee-virtualhost 圖表,將變更套用至 enhanceProxyLimits

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

為:

containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.15.0
  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 其中一個。

包含 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

預設值: "1150" (您的 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.15.0

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

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

這項服務 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,則為必填欄位。

現有 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.15.0

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

預設值:

具有 Storage 物件管理員 (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,例如 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.15.0

這項服務 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,則為必填屬性。

用來儲存備份封存檔案的 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.15.0

這項服務 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.storage.capacity 基本 這項元素已在以下版本推出:1.0.0

預設值: 10Gi

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

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

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

預設值:

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

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

預設值: 10Gi

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

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

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

預設值: 300

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),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.15.0

這項服務 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 使用率。這個欄位的值可讓 Apigee Connect 在 CPU 使用率達到這個值 (最多 replicaCountMax) 時自動調度資源。

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

預設值: 600

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

預設值:

必要

診斷資料的儲存位置,即 Google Cloud 儲存空間值區名稱。

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

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 容器,例如:

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 混合式安裝作業中,這會是 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 其中一個。

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

envs[].cacheEncryptionSecret.name 基本 這項功能已在以下版本推出:1.2.0

預設值:

必須提供 cacheEncryptionKeycacheEncryptionPathcacheEncryptionSecret 其中一個。

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

envs[].components.runtime.replicaCountMax 基本 推出版本:1.9.3

預設值:4

自動調度資源的備用資源數量上限。如果已指定,則會覆寫 runtime.replicaCountMax

envs[].components.runtime.replicaCountMin 基本 推出版本:1.9.3

預設值:1

自動調整資源配置的備用資源數量下限。如果已指定,則會覆寫 runtime.replicaCountMin

envs[].components.runtime.resources.limits.memory 進階 這項功能已在以下版本推出:1.15.0

預設值:

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

envs[].components.runtime.resources.requests.memory 進階 這項功能已在以下版本推出:1.15.0

預設值:

在 Kubernetes 容器中,資源正常運作所需的記憶體,以 MiB (Mi) 或 GiB (Gi) 為單位。

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:在使用 Helm 圖表在 GKE 叢集中啟用 Workload Identity 時,與對應 Kubernetes 服務帳戶建立關聯的 Google IAM 服務帳戶執行階段電子郵件地址。

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

envs.gsa.synchronizer 進階 這項功能已在以下版本推出:1.10.0

預設值:

僅限 Helm:使用 Helm 資訊套件在 GKE 叢集中啟用 Workload Identity 時,要與對應 Kubernetes 服務帳戶建立關聯的同步器 Google IAM 服務帳戶電子郵件地址。

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

envs.gsa.udca 進階 這項功能已在以下版本推出:1.10.0

預設值:

僅限 Helm:當您使用 Helm 圖表在 GKE 叢集中啟用 Workload Identity 時,環境範圍 udca 會與對應的 Kubernetes 服務帳戶建立關聯,此時 udca Google IAM 服務帳戶的電子郵件地址。

請參閱「在 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 位址。

依序列出 httpProxy 屬性 schemehostport。例如:

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

預設值:

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

envs[].serviceAccountPaths.synchronizer 基本 這項功能已在以下版本推出:1.0

預設值:

本機系統中檔案的路徑,可用於具有 Apigee Synchronizer Manager 角色的 Google 服務帳戶金鑰。

envs[].serviceAccountPaths.udca 基本 這項功能已在以下版本推出:1.0

預設值:

本機系統中檔案的路徑,可用於取得具有 Apigee Analytic Agent 角色的 Google 服務帳戶金鑰。

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

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

預設值:

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

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

envs[].serviceAccountSecretRefs.runtime 基本 這項功能已在以下版本推出:1.4.0

預設值:

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

envs[].serviceAccountSecretRefs.synchronizer 基本 這項功能已在以下版本推出:1.2.0

預設值:

Kubernetes 密鑰的名稱。您必須使用 Google 服務帳戶金鑰建立密鑰,並將 Apigee Synchronizer Manager 角色做為輸入內容。

envs[].serviceAccountSecretRefs.udca 基本 這項功能已在以下版本推出:1.2.0

預設值:

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

只有在 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 密鑰中,且包含 Cassandra 使用者和密碼,則為該檔案的名稱。您可以按照下列操作說明建立密鑰:建立密鑰

另請參閱:

gcp

識別 Google Cloud 專案 ID (所有混合式安裝作業都需要)、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 聯盟時,為 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 聯盟」。

gcp.federatedWorkloadIdentity.tokenExpiration 基本 這項功能已在以下版本推出:1.12.0

預設值: 3600

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

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

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

預設值:

必要

指出 apigee-loggerapigee-metrics 推送資料的 Google Cloud 專案。

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

預設值:

指出要執行的 Kubernetes 叢集專案。

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

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

預設值: us-central1

必要

指出 apigee-loggerapigee-metrics 推送資料的 Google Cloud 區域

gcp.workloadIdentity.enabled 基本 這項功能已在以下版本推出:1.10.0

預設值:false

僅限 Helm:啟用在 GKE 上使用 Workload Identity。Workload Identity 可讓 GKE 叢集中的工作負載模擬身分與存取權管理 (IAM) 服務帳戶,以便存取 Google Cloud 服務。

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

enabled 為預設值 false 時,Apigee 會使用每個 Apigee 混合元件的 IAM 服務帳戶。請參閱「服務帳戶簡介」。

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

gcp.workloadIdentity.gsa 進階 這項功能已在以下版本推出:1.10.0

預設值:

僅限 Helm:在使用 Helm 圖表在 GKE 叢集中啟用 Workload Identity 時,所有元件要與對應的 Kubernetes 服務帳戶建立關聯的 Google IAM 服務帳戶 (GSA) 電子郵件地址。將 gcp.workloadIdentity.enabled 設為 true 時,請設定此值。

gcp.workloadIdentity.gsa 適用於所有混合式元件。如果您為 gcp.workloadIdentity.gsa 指定值,就不需要為任何個別混合型元件提供 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 on GKE

gcp.workloadIdentityEnabled 基本 這項功能已在以下版本推出:1.4.0

預設值:false

apigeectl 專用:啟用 Workload Identity。Workload Identity 可讓 GKE 叢集中的工作負載模擬身分與存取權管理 (IAM) 服務帳戶,以便存取 Google Cloud 服務。

workloadIdentityEnabled 為預設值 false 時,Apigee 會使用每個 Apigee 混合元件的 IAM 服務帳戶。請參閱「服務帳戶簡介」。

workloadIdentityEnabledtrue 時,Apigee 會使用 Kubernetes 服務帳戶而非 IAM 服務帳戶,並忽略下列設定屬性:

httpProxy

httpProxy 提供 HTTP 轉送 Proxy 伺服器的設定參數。在 overrides.yaml 中設定後,Apigee Connect、Logger、MART、Metrics、Synchronizer 和 UDCA 元件的所有網路通訊都會經過 Proxy 伺服器。

另請參閱:connectAgentloggermartmetricssynchronizerudca

下表說明 httpProxy 物件的屬性:

屬性 類型 說明
httpProxy.host 基本 推出版本:1.1.1

預設值:

HTTP Proxy 的主機名稱。

httpProxy.port 基本 推出版本:1.1.1

預設值:

HTTP Proxy 的通訊埠。

httpProxy.scheme 基本 推出版本:1.1.1

預設值: HTTPS

Proxy 使用的配置。值可以是 HTTPHTTPS。值必須為大寫。

httpProxy.username 基本 推出版本:1.1.1

預設值:

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

httpProxy.password 基本 推出版本:1.1.1

預設值:

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

ingressGateways

設定 Apigee 入口閘道的各個個別執行個體。如要依據 ingressGateways[].name 個別管理個別執行個體,請使用這些屬性。

請參閱 apigeeIngressGateway,瞭解如何在所有 Apigee 入口閘道例項中套用通用設定。

使用 apigee-org 圖表將變更套用至 ingressGateways 屬性。

下表說明 ingressGateways 物件的屬性:

屬性 類型 說明
ingressGateways[].name 基本 這項功能已在以下版本推出:1.8.0

預設值:

必要

入口閘道的名稱。其他服務會使用這個名稱,將流量轉送至閘道。名稱必須符合下列條件:

  • 長度上限為 17 個半形字元
  • 只能包含小寫英數字元、- 或 .
  • 開頭必須是英數字元
  • 結尾須為英數字元

詳情請參閱 Kubernetes 說明文件中的「DNS 子網域名稱」。

ingressGateways[].resources.limits.cpu 進階 這項功能已在以下版本推出:1.8.0

預設值: 2000m

資源的 CPU 限制值,以毫核為單位。

ingressGateways[].resources.limits.memory 進階 這項功能已在以下版本推出:1.8.0

預設值: 1Gi

資源的記憶體限制,以 mebibyte 為單位。

ingressGateways[].resources.requests.cpu 進階 這項功能已在以下版本推出:1.8.0

預設值: 300m

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

ingressGateways[].resources.requests.memory 進階 這項功能已在以下版本推出:1.8.0

預設值: 128Mi

資源正常運作所需的記憶體大小 (以 MiB 為單位)。

ingressGateways[].replicaCountMax 基本 這項功能已在以下版本推出:1.8.0

預設值: 10

hybrid 可自動新增的入口網關 Pod 數量上限,可用於自動調度資源。

ingressGateways[].replicaCountMin 基本 這項功能已在以下版本推出:1.8.0

預設值: 2

可用於自動調整資源配置的入口網關 Pod 數量下限。

ingressGateways[].svcAnnotations 基本 這項功能已在以下版本推出:1.8.0

預設值:

可選的鍵/值對應,用於在支援註解的平台上註解入口閘道。例如:

ingressGateways:
  svcAnnotations:
    networking.gke.io/load-balancer-type: "Internal"
ingressGateways[].svcLoadBalancerIP 基本 這項功能已在以下版本推出:1.8.0

預設值:

在支援指定負載平衡器 IP 位址的平台上,負載平衡器會使用這個 IP 位址建立。如果平台不允許您指定負載平衡器 IP 位址,系統會忽略這個屬性。

ingressGateways[].svcType 基本 推出版本:1.8.1

預設值:LoadBalancer

用於變更用於入口部署作業的預設 k8s 服務類型。如果您想停用預設負載平衡器的建立作業,請將值設為 ClusterIP。可能的值包括:

  • ClusterIP
  • LoadBalancer
ingressGateways[].targetCPUUtilizationPercentage 進階 推出版本:1.10.5、1.11.2、1.12.1

預設值: 75

在 ReplicaSet 中,CPU 使用率的臨界值,以可用 CPU 資源總數的百分比表示。

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

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

ingressGateways[].tolerations.effect 進階 推出版本:1.10.1

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

ingressGateways[].tolerations.key 進階 推出版本:1.10.1

預設值:

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

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

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

ingressGateways[].tolerations.operator 進階 推出版本:1.10.1

預設值: "Equal"

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

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

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

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

ingressGateways[].tolerations.tolerationSeconds 進階 推出版本:1.10.1

預設值:

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

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

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

ingressGateways[].tolerations.value 進階 推出版本:1.10.1

預設值:

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

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

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

istiod

設定 Apigee 入口。

下表說明 istiod 物件的屬性:

屬性 類型 說明
istiod.accessLogFile 進階 這項功能已在以下版本推出:1.8.0

預設值: /dev/stdout

入站存取記錄的檔案路徑,例如 /dev/stdout

如果未定義這個值,系統就會停用存取記錄功能。

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

ingress 存取記錄的格式。

如果未定義這個值,系統會使用 Proxy 的預設存取記錄格式。

預設存取記錄格式:

'{"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 Proxy (Apigee 入口閘道) 如何處理 x-forwarded-client-cert (XFCC) HTTP 標頭。

可能的值包括:

  • SANITIZE_SET (預設) 當用戶端連線為 mTLS 時,請使用用戶端憑證資訊重設 XFCC 標頭,並將其傳送至下一個節點。
  • FORWARD_ONLY 如果用戶端連線為 mTLS (互相傳輸層安全標準),請只在要求中轉送 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 ingress gateway 容器。

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

預設值:

- "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring)"
- "Edge Health Probe"

讓非Google Cloud 負載均衡器透過覆寫混合式中的預設使用者代理程式許可清單,檢查 ingress 閘道的健康狀態檢查端點 (/healthz/ingress/healthz)。

如要覆寫指定的預設使用者代理程式,請使用下列語法,插入自訂使用者代理程式:

istiod:
  healthCheckUserAgents:
  - "CUSTOM_USER_AGENT_1"
  - "CUSTOM_USER_AGENT_2"

如要移除使用者代理程式規定,請使用以下內容:

istiod:
  healthCheckUserAgents: []

istiod.image.pullPolicy 進階 這項功能已在以下版本推出:1.8.0

預設值: IfNotPresent

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

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

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

istiod.image.tag 進階 這項功能已在以下版本推出:1.8.0

預設值: 1.15.0

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

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

預設值:

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

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

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

k8sCluster

指出安裝混合型執行階段的 Kubernetes 叢集。

下表說明 k8sCluster 物件的屬性:

屬性 類型 說明
k8sCluster.name 基本 這項功能已在以下版本推出:1.2.0

預設值:

安裝 Hybrid 執行階段的 Kubernetes 叢集名稱。

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

預設值:

指出 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

預設值: 1.15.0

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

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

預設值:

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

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

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

預設值: 500m

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

kubeRBACProxy.resources.limits.memory 進階 推出版本:1.11.0

預設值: 128Mi

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

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

預設值: 5m

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

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

預設值: 64Mi

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

logger

定義管理作業記錄的服務。在 Kubernetes 叢集中執行的所有 Apigee 混合服務都會輸出這項資訊。

詳情請參閱「記錄總覽」。

下表說明 logger 物件的屬性:

屬性 類型 說明
logger.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

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

預設值:256k

讀取記錄檔時的初始緩衝區大小。

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

預設值:104857600

每個監控檔案的緩衝區大小限制。超出此限制的檔案會從監控的檔案清單中移除。

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

預設值:150 MB

記錄器可使用的記憶體上限。如果達到上限,記錄器會暫時停止讀取更多資料,直到現有資料在記憶體中刷新為止。

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

預設值: false

啟用或停用叢集中的記錄功能。如非 GKE,請將其設為 true;如為 Google Cloud 或 Google Distributed Cloud 上的 GKE,請將其設為 false

logger.envVars 基本 推出版本:1.8.5

預設值:

可讓您加入 NO_PROXY Fluent Bit 環境變數,該變數會指定不透過 HTTP Proxy 轉送流量的網址。NO_PROXY 變數應定義為以逗號分隔的主機名稱字串,格式如下:

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

例如:

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

如果已啟用 HTTP 轉送 Proxy,請視需要使用 envVars: NO_PROXY

請參閱 Fluent Bit 說明文件中的 NO_PROXY

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

預設值:1

在叫用下一個緩衝區刷新前等待的間隔時間 (以秒為單位)。

logger.gsa 進階 這項功能已在以下版本推出:1.10.0

預設值:

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

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

logger.image.pullPolicy 進階 這項元素已在以下版本推出:1.0.0

預設值: IfNotPresent

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

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

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

logger.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 1.15.0

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

logger.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 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.resources.limits.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 200m

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

logger.resources.limits.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 500Mi

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

logger.resources.requests.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 100m

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

logger.resources.requests.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 250Mi

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

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

具有「Logs Writer」角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

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

預設值:128

記憶體中可用的區塊數量上限。超過限制的區塊會儲存在檔案系統中。

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

預設值: 30

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

mart

定義 MART (執行階段資料管理 API) 服務,該服務可做為公開 Apigee API 的 API 供應器,讓您存取及管理 KMS (API 金鑰和 OAuth 權杖)、KVM、配額和 API 產品等執行階段資料實體。

下表說明 mart 物件的屬性:

屬性 類型 說明
mart.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

mart.gsa 進階 這項功能已在以下版本推出:1.10.0

預設值:

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

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

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

預設值:

主機別名,指向 MART 物件。您可以將這個屬性設為 * 或完整的網域名稱。

mart.image.pullPolicy 進階 這項元素已在以下版本推出:1.0.0

預設值: IfNotPresent

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

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

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

mart.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 1.15.0

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

mart.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 1。

mart.livenessProbe.timeoutSeconds 進階 這項元素已在以下版本推出:1.0.0

預設值: 1

在這個秒數過後,連線探測就會逾時。最小值為 1。

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

預設值: /v1/server/metrics

mart.nodeSelector.key 基本 這項元素已在以下版本推出:1.0.0

預設值:

選用的節點選取器標籤鍵,用於指定 mart 執行階段服務的 Kubernetes 節點。如果您未為 mart.nodeselector 指定鍵,執行階段會使用 nodeSelector 物件中指定的節點。

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

mart.nodeSelector.value 基本 這項元素已在以下版本推出:1.0.0

預設值:

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

mart.resources.requests.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 500m

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

mart.resources.requests.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 512Mi

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

mart.serviceAccountPath 基本 推出版本:1.1.1

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

沒有角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

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

預設值:

您必須使用 sslCertPath/sslKeyPathsslSecret 其中之一。

用於將 SSL 憑證載入及編碼至密鑰的本機檔案系統路徑。

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

預設值:

必須提供 sslCertPath/sslKeyPathsslSecret

用於將 SSL 金鑰載入至密鑰並編碼的本機檔案系統路徑。

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

預設值:

您必須使用 sslCertPath/sslKeyPathsslSecret 其中之一。

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

另請參閱:

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

預設值: 75

Pod 中 MART 程序的目標 CPU 使用率。這個欄位的值可讓 MART 在 CPU 使用率達到這個值時自動調整,最高可達 replicaCountMax

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

預設值: 30

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可為:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

metrics

定義收集作業指標的服務。您可以使用指標資料監控 Hybrid 服務的健康狀態、設定快訊等。

詳情請參閱「指標收集總覽」。

下表說明 metrics 物件的屬性:

屬性 類型 說明
metrics.adapter.image.pullPolicy 進階 推出版本:1.8.1

預設值: IfNotPresent

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

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

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

metrics.adapter.image.tag 進階 推出版本:1.8.1

預設值: 1.15.0

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

metrics.adapter.image.url 進階 推出版本:1.8.1

預設值:

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

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

metrics.adapter.resources.limits.cpu 進階 推出版本:1.14.1

預設值: 500m

Kubernetes 容器中適配器資源的 CPU 限制 (以毫核為單位)。

metrics.adapter.resources.limits.memory 進階 推出版本:1.14.1

預設值: 4Gi

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

metrics.adapter.resources.requests.cpu 進階 推出版本:1.14.1

預設值: 100m

Kubernetes 容器中轉接程式正常運作所需的 CPU,以毫核為單位。

metrics.adapter.resources.requests.memory 進階 推出版本:1.14.1

預設值: 128Mi

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

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 容器中匯總器資源的記憶體限制,以 GB 為單位。

metrics.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

metrics.app.resources.requests.cpu 進階 這項功能已在以下版本推出:1.4.0

預設值: 500m

應用程式在 Kubernetes 容器中正常運作所需的 CPU,以毫核為單位。

metrics.app.resources.requests.memory 進階 這項元素已在以下版本推出:1.4.0

預設值: 512Mi

應用程式在 Kubernetes 容器中正常運作所需的記憶體,以 Mebibyte 為單位。

metrics.app.resources.limits.cpu 進階 這項功能已在以下版本推出:1.4.0

預設值: 500m

Kubernetes 容器中應用程式資源的 CPU 限制 (以毫核為單位)。

metrics.app.resources.limits.memory 進階 這項功能已在以下版本推出:1.4.0

預設值: 1Gi

Kubernetes 容器中應用程式資源的記憶體限制,以 GB 為單位。

metrics.appStackdriverExporter.resources.limits.cpu 進階 這項功能已在以下版本推出:1.7.0

預設值: 500m

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

metrics.appStackdriverExporter.resources.limits.memory 進階 這項功能已在以下版本推出:1.7.0

預設值: 1Gi

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

metrics.appStackdriverExporter.resources.requests.cpu 進階 這項功能已在以下版本推出:1.7.0

預設值: 128m

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

metrics.appStackdriverExporter.resources.requests.memory 進階 這項功能已在以下版本推出:1.7.0

預設值: 512Mi

Kubernetes 容器中 stackdriverExporter 正常運作所需的記憶體,以位元組為單位。

metrics.collector.envVars 基本 推出版本:1.13

預設值:

可讓您在 OpenTelemetry 中傳入及覆寫環境變數。舉例來說,您可以定義 HTTP_PROXYHTTPS_PROXYNO_PROXY,讓要求經過 Proxy 伺服器。

HTTP_PROXY 變數可定義為包含主機名稱的字串,格式如下:

metrics:
...
  envVars:
    HTTP_PROXY: '<host-name>'

例如:

  envVars:
    HTTP_PROXY: 'http://1.1.1.1:80'

HTTPS_PROXY 變數可定義為包含主機名稱的字串,格式如下:

metrics:
...
  envVars:
    HTTPS_PROXY: '<host-name>'

例如:

  envVars:
    HTTPS_PROXY: 'https://1.1.1.1:80'

NO_PROXY 變數應定義為以逗號分隔的主機名稱字串,格式如下:

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

例如:

envVars:
  NO_PROXY: 'https://1.1.1.1:80, https://1.1.1.1:81'

如果已啟用 HTTP 轉送 Proxy,請視需要使用 envVars: HTTP_PROXYenvVars: HTTPS_PROXYenvVars: NO_PROXY

請參閱 OpenTelemetry 說明文件中的「Proxy 支援」一節。

metrics.collector.imagePullPolicy 進階 這項功能已在以下版本推出:1.12.0

預設值: IfNotPresent

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

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

詳情請參閱「使用私人圖像存放區搭配 Apigee hybrid 」。

metrics.collector.image.tag 基本 這項功能已在以下版本推出:1.12.0

預設值: 1.15.0

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

metrics.collector.image.url 基本 這項功能已在以下版本推出:1.12.0

預設值:

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

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

metrics.collector.resources.requests.cpu 進階 這項功能已在以下版本推出:1.12.0

預設值: 500m

在 Kubernetes 容器中,應用程式正常運作所需的 CPU 數量,以毫核為單位。

metrics.collector.resources.requests.memory 進階 這項功能已在以下版本推出:1.12.0

預設值: 512Mi

應用程式在 Kubernetes 容器中正常運作所需的記憶體,以 MiB 為單位。

metrics.collector.resources.limits.cpu 進階 這項功能已在以下版本推出:1.12.0

預設值: 500m

Kubernetes 容器中應用程式資源的 CPU 限制 (以毫核為單位)。

metrics.collector.resources.limits.memory 進階 這項功能已在以下版本推出:1.12.0

預設值: 1Gi

Kubernetes 容器中應用程式資源的記憶體限制,以 GB 為單位。

metrics.collector.livenessProbe.failureThreshold 進階 這項功能已在以下版本推出:1.12.0

預設值: 5

Kubernetes 會在重新啟動容器前,驗證有效性探針失敗的次數。最小值為 1。

metrics.collector.livenessProbe.initialDelaySeconds 進階 這項功能已在以下版本推出:1.12.0

預設值: 30

在容器啟動後,等待啟動有效性探測作業的秒數。

metrics.collector.livenessProbe.periodSeconds 進階 這項功能已在以下版本推出:1.12.0

預設值: 10

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 1。

metrics.collector.livenessProbe.successThreshold 進階 這項功能已在以下版本推出:1.12.0

預設值: 1

連續成功次數下限,連續成功次數達到這個數量後,系統才會將生命徵候探測結果視為成功。最小值為 1。

metrics.collector.livenessProbe.timeoutSeconds 進階 這項功能已在以下版本推出:1.12.0

預設值: 5

在這個秒數過後,生命力探測就會逾時。最小值為 1。

metrics.collector.readinessProbe.failureThreshold 進階 這項功能已在以下版本推出:1.12.0

預設值: 3

Kubernetes 會在確認 Pod 未準備就緒前,驗證完備性探測失敗的次數。最小值為 1。

metrics.collector.readinessProbe.initialDelaySeconds 進階 這項功能已在以下版本推出:1.12.0

預設值: 30

容器啟動後,啟動就緒探測作業前所需的秒數。

metrics.collector.readinessProbe.periodSeconds 進階 這項功能已在以下版本推出:1.12.0

預設值: 10

決定執行就緒性探測的頻率 (以秒為單位)。最小值為 1。

metrics.collector.readinessProbe.successThreshold 進階 這項功能已在以下版本推出:1.12.0

預設值: 1

連續成功次數下限,以便系統在失敗後將就緒性探測視為成功。最小值為 1。

metrics.collector.readinessProbe.timeoutSeconds 進階 這項功能已在以下版本推出:1.12.0

預設值: 5

在這個秒數過後,連線探測就會逾時。最小值為 1。

metrics.disablePrometheusPipeline 基本 這項功能已在以下版本推出:1.12.0

預設值: true

ProxyV2TargetV2 監控資源的指標設為 true 時,系統不會發出這些指標。請改用 ProxyTarget 受控資源的指標。

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

預設值: true

啟用 Apigee 指標。設為 true 即可啟用指標。設為 false 即可停用指標。

metrics.gsa 進階 這項功能已在以下版本推出:1.10.0

預設值:

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

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

metrics.nodeSelector.key 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

節點選取器標籤鍵,用於指定 metrics 執行階段服務的專屬 Kubernetes 節點。

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

metrics.nodeSelector.value 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

節點選取器標籤值,用於指定 metrics 執行階段服務的專屬 Kubernetes 節點。

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

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

預設值: 1.15.0

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

metrics.prometheus.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

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

metrics.prometheus.livenessProbe.failureThreshold 進階 這項元素已在以下版本推出:1.0.0

預設值: 6

Kubernetes 會在重新啟動容器前,驗證有效性探針失敗的次數。最小值為 1。

metrics.prometheus.livenessProbe.periodSeconds 進階 這項元素已在以下版本推出:1.0.0

預設值: 5

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 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.resources.limits.cpu 進階 推出版本:1.14.1

預設值: 500m

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

metrics.prometheus.resources.limits.memory 進階 推出版本:1.14.1

預設值: 4Gi

Kubernetes 容器中 Prometheus 資源的記憶體限制 (以 GB 為單位)。

metrics.prometheus.resources.requests.cpu 進階 推出版本:1.14.1

預設值: 128m

在 Kubernetes 容器中,Prometheus 正常運作所需的 CPU 數量 (以毫核為單位)。

metrics.prometheus.resources.requests.memory 進階 推出版本:1.14.1

預設值: 512Mi

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

metrics.prometheus.sslCertPath 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

Prometheus 指標收集程序的 SSL 憑證路徑。Prometheus 是 Apigee 可用來收集及處理指標的工具。

請參閱:

metrics.prometheus.sslKeyPath 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

Prometheus 指標收集程序的 SSL 金鑰路徑。Prometheus 是 Apigee 可用來收集及處理指標的工具。

請參閱:

metrics.proxy.resources.requests.cpu 進階 這項功能已在以下版本推出:1.4.0

預設值: 500m

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

metrics.proxy.resources.requests.memory 進階 這項元素已在以下版本推出:1.4.0

預設值: 512Mi

Kubernetes 容器中代理程式正常運作所需的記憶體,以 mebibyte 為單位。

metrics.proxy.resources.limits.cpu 進階 這項功能已在以下版本推出:1.4.0

預設值: 500m

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

metrics.proxy.resources.limits.memory 進階 這項功能已在以下版本推出:1.4.0

預設值: 1Gi

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

metrics.proxyStackdriverExporter.resources.requests.cpu 進階 這項功能已在以下版本推出:1.7.0

預設值: 128m

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

metrics.proxyStackdriverExporter.resources.requests.memory 進階 這項功能已在以下版本推出:1.7.0

預設值: 512Mi

Kubernetes 容器中 stackdriverExporter 正常運作所需的記憶體,以位元組為單位。

metrics.proxyStackdriverExporter.resources.limits.cpu 進階 這項功能已在以下版本推出:1.7.0

預設值: 500m

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

metrics.proxyStackdriverExporter.resources.limits.memory 進階 這項功能已在以下版本推出:1.7.0

預設值: 1Gi

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

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

預設值:

Kubernetes 叢集中指標處理程序附加 Proxy 的網址。

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

預設值: 1.15.0

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

metrics.sdSidecar.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

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

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

具備 Monitoring Metric Writer 角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

必須使用 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 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

mintTaskScheduler.resources.limits.cpu 進階 新功能:1.1.0 版

預設值: 2000m

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

mintTaskScheduler.resources.limits.memory 進階 新功能:1.1.0 版

預設值: 4Gi

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

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

預設值: 500m

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

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

預設值: 512Mi

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

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

newDataPipeline

newDataPipeline 會判斷 Apigee hybrid 是否使用 Pub/Sub 資料管道,讓執行階段元件直接將資料寫入控制平面。

下表說明 newDataPipeline 物件的屬性:

屬性 類型 說明
newDataPipeline.debugSession 進階 這項功能已在以下版本推出:1.13.1

預設值: true

判斷是否已啟用 Pub/Sub 資料管道。

newDataPipeline.analytics 進階 這項功能已在以下版本推出:1.13.1

預設值: true

判斷分析是否使用 Pub/Sub 資料管道。

nodeSelector

nodeSelector 物件會定義 Apigee 執行個體的節點。在您安裝或升級 apigee-orgapigee-ingress-manager 圖表時,Apigee hybrid 會在幕後將 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

預設值:true

requiredForScheduling 屬性預設為 true。當 true 時,表示如果 Kubernetes 找不到具有已設定標籤鍵/值的節點,則底層 Pod 不會在 VM 工作站節點上排程。

在正式版中,nodeSelector.requiredForScheduling 應設為 true。

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

redis

下表說明 redis 物件的屬性:

屬性 類型 說明
redis.auth.password 基本 這項功能已在以下版本推出:1.6.0

預設值: iloveapis123

必要

Redis 管理員的密碼。管理員使用者可用於在 Redis 叢集中執行的任何管理活動。

redis.auth.secret 基本 推出版本:1.9.1

預設值:

儲存在 Kubernetes 密鑰中的檔案名稱,其中包含 Redis 管理員的密碼。密鑰檔案應包含以下金鑰:

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

預設值: 1.15.0

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

redis.envoy.image.url 進階 這項功能已在以下版本推出:1.6.0

預設值:

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

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

redis.image.pullPolicy 進階 這項功能已在以下版本推出:1.6.0

預設值: IfNotPresent

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

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

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

redis.image.tag 進階 這項功能已在以下版本推出:1.6.0

預設值: 1.15.0

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

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

預設值:

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

runtime

下表說明 runtime 物件的屬性:

屬性 類型 說明
runtime.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

runtime.envVars 基本 推出版本:1.13.1

預設值:

可讓您透過鍵/值組合,向執行階段元件提供其他環境變數:

runtime:
  envVars:
    KEY_1: VALUE_N
    ... ...
    KEY_N: VALUE_N

例如:

runtime:
  envVars:
    RUNTIME_ENV_VAR1: "value of runtime env-var 1"
    RUNTIME_ENV_VAR2: "value of runtime env-var 2"
runtime.image.pullPolicy 進階 這項元素已在以下版本推出:1.0.0

預設值: IfNotPresent

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

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

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

runtime.hpaBehavior.scaleDown.percent.periodSeconds 進階 這項功能已在以下版本推出:1.7.0

預設值:60

縮減執行階段執行個體百分比時,政策應維持有效的時間範圍。

runtime.hpaBehavior.scaleDown.percent.value 進階 這項功能已在以下版本推出:1.7.0

預設值:20

縮減執行階段執行個體百分比時,政策允許的變更量。

runtime.hpaBehavior.scaleDown.pods.periodSeconds 進階 這項功能已在以下版本推出:1.7.0

預設值:60

在縮減執行階段執行個體數量時,政策應維持有效的時間範圍。

runtime.hpaBehavior.scaleDown.pods.value 進階 這項功能已在以下版本推出:1.7.0

預設值:20

政策在縮減執行階段執行個體數量時,允許的變更量。

runtime.hpaBehavior.scaleDown.selectPolicy 進階 這項功能已在以下版本推出:1.7.0

預設值:Min

自動配置器在多項自動調度資源政策之間做出的決定。將值設為「最小」可讓您在縮減執行階段執行個體時,盡可能減少變更。將值設為「Max」可讓您在縮減執行階段執行個體時,進行最大的變更。

runtime.hpaBehavior.scaleDown.stabilizationWindowSeconds 進階 這項功能已在以下版本推出:1.7.0

預設值:120

縮減時應考慮過去最佳化建議的秒數。

runtime.hpaBehavior.scaleUp.percent.periodSeconds 進階 這項功能已在以下版本推出:1.7.0

預設值:60

在調整執行階段執行個體百分比時,政策應維持有效的時間範圍。

runtime.hpaBehavior.scaleUp.percent.value 進階 這項功能已在以下版本推出:1.7.0

預設值:20

在調整執行階段執行個體百分比時,政策應維持有效的時間範圍。

runtime.hpaBehavior.scaleUp.pods.periodSeconds 進階 這項功能已在以下版本推出:1.7.0

預設值:60

在擴充執行階段執行個體數量時,政策應維持有效的時間範圍。

runtime.hpaBehavior.scaleUp.pods.value 進階 這項功能已在以下版本推出:1.7.0

預設值:4

在擴充執行階段執行個體數量時,政策允許的變更量。

runtime.hpaBehavior.scaleUp.selectPolicy 進階 這項功能已在以下版本推出:1.7.0

預設值:Max

自動配置器在多項自動調度資源政策之間做出的決定。將值設為「Min」可讓您在調高執行階段執行個體時,進行最小變更。將值設為「Max」可讓您在調整執行階段執行個體時,進行最大的變更。

runtime.hpaBehavior.scaleUp.stabilizationWindowSeconds 進階 這項功能已在以下版本推出:1.7.0

預設值:30

在擴充執行階段執行個體時,應考慮過去建議的秒數。

runtime.hpaMetrics.serverMainTaskWaitTime 進階 這項功能已在以下版本推出:1.7.0

預設值:400M

在 HTTP 層級,代理要求在執行階段執行個體中處理佇列的平均等待時間 (以毫秒為單位)。

runtime.hpaMetrics.serverNioTaskWaitTime 進階 這項功能已在以下版本推出:1.7.0

預設值:400M

代理要求處理政策的執行階段執行個體中處理佇列的平均等待時間 (以毫秒為單位)。

runtime.hpaMetrics.targetCPUUtilizationPercentage 進階 這項功能已在以下版本推出:1.7.0

預設值:75

所有執行階段執行個體的理想 CPU 使用率百分比。

runtime.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 1.15.0

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

runtime.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 1。

runtime.livenessProbe.timeoutSeconds 進階 這項元素已在以下版本推出:1.0.0

預設值: 1

在這個秒數過後,連線探測就會逾時。最小值為 1。

runtime.nodeSelector.key 基本 這項元素已在以下版本推出:1.0.0

預設值:

用於指定 runtime 服務的 Kubernetes 節點的選用節點選取器標籤鍵。

請參閱「nodeSelector 屬性」。

runtime.nodeSelector.value 基本 這項元素已在以下版本推出:1.0.0

預設值:

指定 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

可用於自動調整資源配置的備用資源數量上限。

如果使用強化的每個環境 Proxy 限制,這項限制會套用至該環境的所有複本集。每個複本集仍會個別自動調整。

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

預設值: 1

可用於自動調整資源配置的備用資源數量下限。

如果使用強化的每個環境 Proxy 限制,這項限制會套用至該環境的所有複本集。每個複本集仍會獨立進行自動調整。

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

預設值: 4000m

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

runtime.resources.limits.memory 進階 推出版本:1.11.0

預設值: 6Gi

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

runtime.resources.requests.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 500m

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

runtime.resources.requests.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 512Mi (請參閱下方附註)

在 Kubernetes 容器中,資源正常運作所需的記憶體,以 MiB (Mi) 或 GiB (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

預設值: 3600

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或是寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

synchronizer

確保訊息處理器與最新部署的 API Proxy 套件保持同步。為此,Synchronizer 會輪詢管理層,並在偵測到新合約時,將合約傳送至執行階段層。根據預設,Synchronizer 會將環境設定資料儲存在 Cassandra 中。

詳情請參閱「設定 Synchronizer」。

下表說明 synchronizer 物件的屬性:

屬性 類型 說明
synchronizer.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

synchronizer.image.pullPolicy 進階 這項元素已在以下版本推出:1.0.0

預設值: IfNotPresent

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

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

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

synchronizer.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 1.15.0

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

synchronizer.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 1。

synchronizer.livenessProbe.timeoutSeconds 進階 這項元素已在以下版本推出:1.0.0

預設值: 1

在這個秒數過後,連線探測就會逾時。最小值為 1。

synchronizer.nodeSelector.key 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

用於指定 synchronizer 執行階段服務的 Kubernetes 節點的選用節點選取器標籤鍵。

請參閱 nodeSelector

synchronizer.nodeSelector.value 基本 這項元素已在以下版本推出:1.0.0

預設值:

用於指定 synchronizer 執行階段服務的 Kubernetes 節點的選用節點選取器標籤值。

請參閱 nodeSelector

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

預設值: 60

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 備份副本數量:synchronizer.replicaCountMaxsynchronizer.replicaCountMin

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

synchronizer.resources.requests.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 100m

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

synchronizer.resources.requests.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 1Gi

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

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

具有 Apigee Synchronizer Manager 角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

synchronizer.serviceAccountSecret 基本 這項功能已在以下版本推出:1.1.0

預設值:

Kubernetes 密鑰的名稱。您必須使用 Google 服務帳戶金鑰建立密鑰,並將 Apigee Synchronizer Manager 角色做為輸入內容。

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

預設值: 75

Pod 上 Synchronizer 程序的目標 CPU 使用率。這個欄位的值可讓 Synchronizer 在 CPU 使用率達到這個值 (上限為 replicaCountMax) 時自動調度資源。

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

預設值: 30

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

udca

(通用資料收集代理程式) 定義在執行階段平面中資料收集 Pod 中執行的服務。這項服務會擷取數據分析和部署狀態資料,並傳送至統一數據分析平台 (UAP)。

詳情請參閱「數據分析和部署狀態資料收集」。

下表說明 udca 物件的屬性:

屬性 類型 說明
udca.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

udca.fluentd.image.pullPolicy 進階 這項元素已在以下版本推出:1.0.0

預設值: IfNotPresent

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

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

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

udca.fluentd.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 1.15.0

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

udca.fluentd.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值: gcr.io/apigee-release/hybrid/apigee-stackdriver-logging-agent

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

udca.fluentd.resources.limits.cpu 進階 這項功能已在以下版本推出:1.11.0

預設值: 1000m

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

udca.fluentd.resources.limits.memory 進階 這項功能已在以下版本推出:1.11.0

預設值: 500Mi

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

udca.fluentd.resources.requests.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 500m

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

udca.fluentd.resources.requests.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 250Mi

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

udca.gsa 進階 這項功能已在以下版本推出:1.10.0

預設值:

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

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

udca.image.pullPolicy 進階 這項功能已在以下版本推出:1.0.0

預設值:IfNotPresent

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

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

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

udca.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 1.15.0

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

udca.image.url 進階 這項元素已在以下版本推出:1.0.0

預設值:

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

決定執行 liveness 探測的頻率 (以秒為單位)。最小值為 1。

udca.livenessProbe.timeoutSeconds 進階 這項元素已在以下版本推出:1.0.0

預設值: 1

在這個秒數過後,連線探測就會逾時。最小值為 1。

udca.nodeSelector.key 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

節點選取器標籤鍵,用於指定 udca 執行階段服務的專屬 Kubernetes 節點。

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

udca.nodeSelector.value 基本 這項元素已在以下版本推出:1.0.0

預設值:

必要

節點選取器標籤值,用於指定 udca 執行階段服務的專屬 Kubernetes 節點。

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

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

預設值: 1

UDCA 在兩次輪詢作業之間等待的時間長度 (以秒為單位)。UDCA 會輪詢資料收集 pod 的檔案系統資料目錄,偵測要上傳的新檔案。

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

預設值: 4

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

udca.resources.limits.memory 進階 推出版本:1.11.0

預設值: 2Gi

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

udca.resources.requests.cpu 進階 這項元素已在以下版本推出:1.0.0

預設值: 250m

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

udca.resources.requests.memory 進階 這項元素已在以下版本推出:1.0.0

預設值: 250Mi

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

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

預設值: v1

在標籤中填入的靜態值,可用於啟用 Canary 部署。

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

具有 Apigee Analytics Agent 角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

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

預設值: 75

在 ReplicaSet 中,CPU 使用率的門檻 (以可用的 CPU 資源總數百分比表示)。Hybrid 會使用資料收集 pod 中所有容器 (包括 fluentd 和 UDCA) 的總使用率,計算目前的使用率。

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

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

預設值: 600

從要求刪除 Pod 到 Pod 遭到終止之間的時間上限 (以秒為單位)。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。當所有執行中的程序終止,或寬限期結束時 (以先發生者為準),Pod 就會遭到終止。如果沒有任何執行中的程序,系統會立即終止 Pod。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

virtualhosts

virtualhosts 屬性是必要的設定屬性。虛擬主機可讓 Apigee Hybrid 處理指定環境群組的 API 要求。

詳情請參閱「設定虛擬主機」。

下表說明 virtualhosts 物件的屬性:

屬性 類型 說明
virtualhosts[].additionalGateways 基本 這項功能已在以下版本推出:1.2.0

預設值:

要將流量轉送至的 Istio 閘道清單。

virtualhosts[].cipherSuites[] 進階 推出版本:1.9.2

預設值:

這個屬性可設定輸入閘道中使用的 TLS 加密法。以下是預設以 OpenSSL 格式啟用的加密編碼清單。如要進一步瞭解支援的加密編碼,請參閱 Boring FIPS 版本的 Envoy 說明文件。空白值預設為 Boring FIPS 版本的 Envoy 支援的加密套件。

預設為 TLS 1.3 啟用 (您無法覆寫 TLS 1.3 加密套件):

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256

預設為 TLS 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.minTLSProtocolVersion 搭配 virtualhosts.cipherSuites 屬性。

舉例來說,如要啟用 TLS 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

預設值:

必要

虛擬主機的名稱。

virtualhosts[].maxTLSProtocolVersion 基本 這項元素已在以下版本推出:1.3.0

預設值:

Envoy 可選取的 TLS 通訊協定最高版本。Envoy 會自動使用 virtualhosts[].minTLSProtocolVersionvirtualhosts[].maxTLSProtocolVersion 之間的最佳 TLS 通訊協定版本。

值必須為數字格式。例如:

virtualhosts:
  - name: default
    maxTLSProtocolVersion: "1.3"

其中數字代表 TLS 版本號碼,格式為 #.#。在上述範例中,"1.3" 代表 Istio TLS 版本 TLSV1_3

另請參閱 Istio 說明文件中的 ServerTLSSettings.TLSProtocol

virtualhosts[].minTLSProtocolVersion 基本 這項元素已在以下版本推出:1.3.0

預設值:

Envoy 可選取的 TLS 通訊協定最低版本。Envoy 會自動使用 virtualhosts[].minTLSProtocolVersionvirtualhosts[].maxTLSProtocolVersion 之間的最佳 TLS 通訊協定版本。

值必須為數字格式。例如:

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:適用於使用 Cloud Service Mesh 的 Apigee Hybrid 安裝作業 (Apigee Hybrid 版本 1.8 及更早版本)。

如果未提供選取器標籤,系統會將設定提供給 Apigee 入口閘道。

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

預設值:

您必須使用 sslCertPath/sslKeyPathsslSecret 其中之一。

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

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

預設值:

必須使用 sslCertPath/sslKeyPathsslSecret

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

virtualhosts[].sslSecret 基本 這項功能已在以下版本推出:1.2.0

預設值:

必須提供 sslCertPath/sslKeyPathsslSecret

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

另請參閱:

watcher

watcher 屬性是必要的設定屬性。監視器是一種程序,可監控設定變更,並觸發對執行階段平面的應用。

下表說明 watcher 物件的屬性:

屬性 類型 說明
watcher.annotations 進階 這項功能已在以下版本推出:1.5.0

預設值:

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

watcher.args.enableIssueScanning 進階 這項功能已在以下版本推出:1.10.0

預設值: true

啟用或停用自動顯示問題功能。當 true 時,Watcher 會自動掃描控制層和 Kubernetes API 伺服器狀態,判斷是否有任何設定問題。

將其設為 false 可停用自動顯示問題功能。詳情請參閱「自動顯示問題」。

watcher.args.enableLeaderElect 進階 這項功能已在以下版本推出:1.13.0

預設值: true

true (預設) watcher.args.enableLeaderElect 選取單一監控員 Pod 來管理及回報路由資訊時,為避免升級或回溯期間發生停機問題,請將此值限制為單一 Pod。在這些事件期間,可以同時執行多個版本的監控器。每個 Watcher 例項可能都有不同的路徑建立邏輯,這可能會導致服務中斷。watcher.replicaCountMax

watcher.args.issueScanInterval 進階 這項功能已在以下版本推出:1.10.0

預設值: 60

Watcher 掃描執行階段平面以自動顯示問題的頻率,以秒為單位。詳情請參閱「自動顯示問題」。

watcher.gsa 進階 推出版本:1.10.0

預設值:

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

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

watcher.image.pullPolicy 進階 這項功能已在以下版本推出:1.4.0

預設值: IfNotPresent

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

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

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

watcher.image.tag 進階 這項功能已在以下版本推出:1.4.0

預設值: 1.15.0

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

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

預設值:

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

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

watcher.replicaCountMax 基本 這項元素已在以下版本推出:1.3.0

預設值: 1

監控備用資源的數量上限。為避免衝突,請將這個值保持在 1

Apigee hybrid 會為每個安裝項目使用一個監控員 Pod。領袖選舉會自動選取一個監控員 Pod。其他監控器 Pod 副本將被迫進入不穩定狀態。請參閱 watcher.args.enableLeaderElect

watcher.replicaCountMin 基本 這項元素已在以下版本推出:1.3.0

預設值: 1

監控備用資源的數量下限。

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

預設值: 1000m

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

watcher.resources.limits.memory 進階 推出版本:1.11.0

預設值: 2Gi

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

watcher.serviceAccountPath 基本 這項元素已在以下版本推出:1.3.0

預設值:

必要。

具有 Apigee 執行階段代理人角色的 Google 服務帳戶金鑰檔案路徑。

watcher.serviceAccountRef 進階 這項元素已在以下版本推出:1.3.0

預設值:

必須指定 serviceAccountPath 或 serviceAccountRef 其中一個。

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

預設值:

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

effect 會指定將容許值與污點比對後的效果。effect 的值可以是:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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