設定屬性參考資料

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

篩選這個頁面

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

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

頂層屬性

下表說明 overrides.yaml 檔案中的頂層屬性。這些屬性不屬於其他物件,適用於機構或環境層級:

屬性 類型 說明
axHashSalt 進階

導入版本:1.3.0

預設值: iloveapis123

選用

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

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

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

contractProvider 進階 版本:1.0.0

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

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

gcpProjectID 進階 Deprecated: 如果是 1.2.0 以上版本,請改用 gcp.projectID。

版本:1.0.0

預設值: 無

必要

Google Cloud 專案的 ID。與 k8sClusterName (已淘汰) 和 gcpRegion (已淘汰) 搭配使用,可識別專案並判斷 apigee-logger 和 apigee-metrics 要將資料推送至何處。

gcpRegion 進階 Deprecated: 如果是 1.2.0 以上版本,請改用 gcp.region。

版本:1.0.0

預設值: us-central1

必要

Kubernetes 叢集最接近的 Google Cloud 區域或可用區。與 gcpProjectID (已淘汰) 和 k8sClusterName (已淘汰) 搭配使用,可識別專案並判斷 apigee-logger 和 apigee-metrics 將資料推送至何處。

hub 進階 推出版本:1.11.0

預設值:無

僅限 Helm:用於從私人存放區提取所有 Apigee 元件映像檔的私人映像檔容器存放區網址。

hub 會為所有 Apigee Hybrid 元件提供預設路徑。如果您使用私有存放區,請使用 hub 為所有元件設定存放區網址,而不是為每個元件使用個別的 image.url 屬性。只有在特定元件使用獨立存放區時,才設定個別網址。

每個個別元件的圖片路徑會是 hub 的值,加上元件的圖片名稱和標記。

舉例來說,如果 hub private-docker-host.example.com 的值為,個別元件會自動解析圖片路徑:

hub: private-docker-host.example.com

如:

## an example of internal component vs 3rd party
containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.11.2
  imagePullPolicy: IfNotPresent

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

其他元件也會遵循類似模式。

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

請參閱「使用 Helm 搭配私人映像檔存放區」。

您可以使用下列屬性,個別覆寫元件的圖片網址:

imagePullSecrets.name 進階 版本:1.0.0

預設值:無

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

instanceID 基本 推出版本:1.3.0

預設值:無

必要

這個安裝項目的專屬 ID。

用來識別這個執行個體的不重複字串。可以混合使用英文字母和數字,長度上限為 63 個字元。

k8sClusterName 進階 Deprecated: 如為 1.2.0 以上版本,請改用 k8sCluster.name 和 k8sCluster.region。

版本:1.0.0

預設值:無

混合式專案執行的 Kubernetes (K8S) 叢集名稱。可與 gcpProjectID (已淘汰) 和 gcpRegion (已淘汰) 搭配使用,識別專案並判斷 apigee-logger 和 apigee-metrics 要將資料推送至何處。

kmsEncryptionKey 進階 版本:1.0.0

預設值: defaults.org.kmsEncryptionKey

選填。請只使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 其中之一。

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

kmsEncryptionPath 進階 於下列版本推出:1.2.0

預設值:無

選填。請只使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 其中之一。

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

kmsEncryptionSecret.key 進階 於下列版本推出:1.2.0

預設值:無

選填。請只使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 其中之一。

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

kmsEncryptionSecret.name 進階 於下列版本推出:1.2.0

預設值:無

選填。請只使用 kmsEncryptionKey、kmsEncryptionPath 或 kmsEncryptionSecret 其中之一。

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

kvmEncryptionKey 進階 版本:1.0.0

預設值: defaults.org.kmsEncryptionKey

選填。請只使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 其中之一。

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

kvmEncryptionPath 進階 於下列版本推出:1.2.0

預設值:無

選填。請只使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 其中之一。

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

kvmEncryptionSecret.key 進階 於下列版本推出:1.2.0

預設值:無

選填。請只使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 其中之一。

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

kvmEncryptionSecret.name 進階 於下列版本推出:1.2.0

預設值:無

選填。請只使用 kvmEncryptionKey、kvmEncryptionPath 或 kvmEncryptionSecret 其中之一。

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

multiOrgCluster 進階 推出版本:1.10.0

預設值: false

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

namespace 基本 版本:1.0.0

預設值: apigee

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

org 基本

版本:1.0.0

預設值:無

必要

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

orgScopedUDCA 進階 在版本中推出:1.8.0

預設值: true

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

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

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

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

另請參閱 udca。

revision 進階 版本:1.0.0

預設值: "1112" (不含句點的 Apigee Hybrid 版本。舉例來說,在 1.11.0 版中,預設值為 "1110"。)

Apigee Hybrid 支援 Kubernetes 滾動式更新,可透過逐步更新 Pod 執行個體,確保部署作業更新期間完全不會停機。

更新某些 YAML 覆寫項目時,如果導致基礎 Kubernetes PodTemplateSpec變更,客戶的 override.yaml中也必須變更 revision 覆寫屬性。這是因為底層 Kubernetes ApigeeDeployment (AD) 控制器必須執行安全的滾動式更新,才能從舊版升級至新版。您可以使用任何小寫文字值,例如:blue、a、1.0.0

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

變更下列物件的屬性時,必須更新 revision:

詳情請參閱「推出更新」。

validateOrg 進階 在版本中推出:1.8.0

預設值: true

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

另請參閱 org

validateServiceAccounts 進階 版本:1.0.0

預設值: true

啟用服務帳戶權限的嚴格驗證。這會使用 Cloud Resource Manager API 方法 testIamPermissions,確認提供的服務帳戶具備必要權限。如果是 Apigee 機構的服務帳戶,專案 ID 檢查會對應至該機構。如果是指標和記錄器,系統會根據 gcpProjectID overrides.yaml 設定檢查專案。

另請參閱 gcpProjectID

ao

Apigee Operators (AO) 會建立及更新部署和維護元件所需的低層級 Kubernetes 和 Istio 資源。舉例來說,控制器會釋放訊息處理器。

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

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

預設值: true

停止向客戶安裝的 ASM 提供設定。

  • 使用 Apigee Ingress 閘道進行混合式安裝時,請設為 true。
  • 使用 Anthos 服務網格進行混合式安裝時,請設為 false (Apigee Hybrid 1.8 版和更早版本)。
ao.args.disableManagedClusterRoles 進階 推出版本:1.10.0

預設值: true

當 true (預設) 時,Apigee Hybrid 不會直接管理 Kubernetes ClusterRole 和 ClursterRoleBinding。如果您有需要管理這些資源的程序,則必須由具備適當權限的使用者執行該程序。

ao.image.pullPolicy 進階 於下列版本推出:1.2.0

預設值: IfNotPresent

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

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

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

ao.image.tag 進階 於下列版本推出:1.2.0

預設值: 1.11.2

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

ao.image.url 進階 於下列版本推出:1.2.0

預設值:無

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

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

ao.installer.pullPolicy 進階 推出版本:1.3.0

預設值: IfNotPresent

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

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

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

ao.installer.tag 進階 推出版本:1.3.0

預設值: 1.11.2

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

ao.installer.url 進階 推出版本:1.3.0

預設值: gcr.io/apigee-release/hybrid/apigee-installer

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

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

ao.resources.limits.cpu 進階 於下列版本推出:1.2.0

預設值: 250m

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

ao.resources.limits.memory 進階 於下列版本推出:1.2.0

預設值: 256Mi

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

ao.resources.requests.cpu 進階 於下列版本推出:1.2.0

預設值: 250m

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

ao.resources.requests.memory 進階 於下列版本推出:1.2.0

預設值: 256Mi

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

apigeeIngressGateway

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

如要個別設定執行個體,請參閱 ingressGateways。

如果您使用 Helm 管理 Apigee Hybrid,請透過 apigee-org 圖表將變更套用至 apigeeIngressGateway 屬性。

下表說明 apigeeIngressGateway 物件的屬性:

屬性 類型 說明
apigeeIngressGateway.image.pullPolicy 進階 推出版本:1.11.0

預設值: IfNotPresent

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

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

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

apigeeIngressGateway.image.tag 進階 推出版本:1.11.0

預設值: 1.18.7-asm.26-distroless

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

apigeeIngressGateway.image.url 進階 推出版本:1.11.0

預設值:無

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

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

apigeeIngressGateway.nodeSelector.key 進階 推出版本:1.11.0

預設值:無

必要

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

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

apigeeIngressGateway.nodeSelector.value 進階 推出版本:1.11.0

預設值:無

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

請參閱「nodeSelector」。

apigeeIngressGateway.replicaCountMax 基本 推出版本:1.11.0

預設值: 4

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

apigeeIngressGateway.replicaCountMin 基本 推出版本:1.11.0

預設值: 2

可供自動調整資源配置的 Ingress 閘道 Pod 數量下限。

apigeeIngressGateway.targetCPUUtilizationPercentage 進階 推出版本:1.10.5、1.11.2

預設值: 75

ReplicaSet 中 Pod 數量的資源調度 CPU 使用率門檻,以可用 CPU 資源總數的百分比表示。

如果 CPU 使用率超過這個值,混合式系統就會逐步增加 ReplicaSet 中的 Pod 數量,最多可達 apigeeIngressGateway.replicaCountMax。

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

apigeeIngressGateway.tolerations.effect 進階 推出版本:1.11.0

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

apigeeIngressGateway.tolerations.key 進階 推出版本:1.11.0

預設值:無

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

key 會找出可套用容錯的 Pod。

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

apigeeIngressGateway.tolerations.operator 進階 推出版本:1.11.0

預設值: "Equal"

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

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

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

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

apigeeIngressGateway.tolerations.tolerationSeconds 進階 推出版本:1.11.0

預設值:無

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

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

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

apigeeIngressGateway.tolerations.value 進階 推出版本:1.11.0

預設值:無

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

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

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

cassandra

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

詳情請參閱「StorageClass 設定」。

下表說明 cassandra 物件的屬性:

屬性 類型 說明
cassandra.annotations 進階 推出版本:1.5.0

預設值:無

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

cassandra.auth.admin.password 基本 版本:1.0.0

預設值: iloveapis123

必要

Cassandra 管理員的密碼。管理員使用者可用於在 Cassandra 叢集上執行任何管理活動,例如備份和還原。

cassandra.auth.ddl.password 基本 版本:1.0.0

預設值: iloveapis123

必要

Cassandra 資料定義語言 (DDL) 使用者的密碼。MART 會使用此服務執行任何資料定義工作,例如建立、更新及刪除鍵空間。

cassandra.auth.default.password 基本 版本:1.0.0

預設值: iloveapis123

必要

啟用驗證時建立的預設 Cassandra 使用者密碼。設定 Cassandra 驗證時,必須重設這組密碼。請參閱「為 Cassandra 設定 TLS」。

cassandra.auth.dml.password 基本 版本:1.0.0

預設值: iloveapis123

必要

Cassandra 資料操縱語言 (DML) 使用者的密碼。用戶端通訊會使用 DML 使用者,從 Cassandra 讀取及寫入資料。

cassandra.auth.image.pullPolicy 進階 版本:1.0.0

預設值: IfNotPresent

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

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

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

cassandra.auth.image.tag 進階 版本:1.0.0

預設值: 1.11.2

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

cassandra.auth.image.url 進階 版本:1.0.0

預設值:無

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

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

cassandra.auth.jmx.password 基本 推出版本:1.4.0

預設值: iloveapis123

必要

Cassandra JMX 作業使用者的密碼。用於驗證及與 Cassandra JMX 介面通訊。

cassandra.auth.jmx.username 基本 推出版本:1.4.0

預設值: jmxuser

必要

Cassandra JMX 作業使用者的使用者名稱。用於驗證及與 Cassandra JMX 介面通訊。

cassandra.auth.jolokia.password 基本 推出版本:1.4.0

預設值: iloveapis123

必要

Cassandra Jolokia JMX 作業使用者的密碼。用於驗證及與 Cassandra JMX API 通訊。

cassandra.auth.jolokia.username 基本 推出版本:1.4.0

預設值: apigee

必要

Cassandra Jolokia JMX 作業的使用者名稱。用於驗證及與 Cassandra JMX API 通訊。

cassandra.auth.secret 基本 推出版本:1.3.3

預設值:無

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

另請參閱:

cassandra.auth.secretProviderClass 進階 導入版本:1.10.3

預設值:無

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

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

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

cassandra.backup.cloudProvider 進階 版本:1.0.0

預設值: GCP

備份供應商的名稱。支援的值:GCP、HYBRID 和 CSI。將值設為:

  • GCP,將備份封存檔儲存在 Google Cloud Storage。
  • HYBRID,將備份封存檔儲存在遠端 SSH 伺服器上。
  • CSI (建議) 使用 Kubernetes CSI 磁碟區快照進行備份。如要瞭解 Google Cloud、AWS 和 Azure 等雲端平台的CSI備份和還原功能,請參閱 CSI 備份和還原。
cassandra.backup.dbStorageBucket 進階 版本:1.0.0

預設值:無

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

格式必須為 gs://BUCKET_NAME (必須加上 gs:// 前置字串)。

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

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

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

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

預設值:無

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

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

cassandra.backup.keyfile 進階 推出版本:1.3.0

預設值:無

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

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

cassandra.backup.schedule 進階 版本:1.0.0

預設值: 0 2 * * *

備份 Cron 工作的排程。

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

cassandra.backup.server 進階 推出版本:1.3.0

預設值:無

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

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

cassandra.backup.serviceAccountPath 進階 版本:1.0.0

預設值:無

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

如果已啟用備份功能,且 cassandra.backup.cloudProvider 設為 GCP,您必須採取下列其中一種做法,確保 Apigee Hybrid 可以存取 Google Cloud Storage 值區,並上傳備份封存檔:

cassandra.backup.serviceAccountRef 進階 於下列版本推出:1.2.0

預設值:無

現有 Kubernetes 密鑰的名稱,用於儲存具有儲存空間物件管理員 (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 安裝 (包括 GKE On-Prem、GKE on AWS、Anthos on Bare Metal、AKS、EKS 和 OpenShift) 的預設情況。

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

將 cassandra.hostNetwork 設為 true,適用於多區域安裝,不同叢集中的 Pod 之間沒有通訊,例如 GKE On-prem、AWS 上的 GKE、Bare Metal 上的 Anthos、AKS、EKS 和 OpenShift 安裝。請參閱「多區域部署作業:必要條件」。

當 true, DNS 政策會自動設為 ClusterFirstWithHostNet。

cassandra.image.pullPolicy 進階 版本:1.0.0

預設值: IfNotPresent

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

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

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

cassandra.image.tag 進階 版本:1.0.0

預設值: 1.11.2

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

cassandra.image.url 進階 版本:1.0.0

預設值:無

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

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

cassandra.maxHeapSize 進階 版本:1.0.0

預設值: 512M

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

cassandra.multiRegionSeedHost 基本 版本:1.0.0

預設值:無

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

cassandra.nodeSelector.key 進階 版本:1.0.0

預設值:無

必要

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

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

cassandra.nodeSelector.value 進階 版本:1.0.0

預設值:無

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

請參閱「nodeSelector」。

cassandra.port 進階 版本:1.0.0

預設值: 9042

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

cassandra.rack 基本 版本:1.0.0

預設值: ra-1

指定 Cassandra 節點的機架。

cassandra.readinessProbe.failureThreshold 進階 版本:1.0.0

預設值: 2

Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。

cassandra.readinessProbe.initialDelaySeconds 進階 版本:1.0.0

預設值: 0

容器啟動後,到啟動就緒探測作業之間的時間間隔 (以秒為單位)。

cassandra.readinessProbe.periodSeconds 進階 版本:1.0.0

預設值: 10

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

cassandra.readinessProbe.successThreshold 進階 版本:1.0.0

預設值: 1

失敗後,至少要連續成功幾次,才算成功。最小值為 1。

cassandra.readinessProbe.timeoutSeconds 進階 版本:1.0.0

預設值: 5

健康狀態探測逾時的秒數。最小值為 1。

cassandra.replicaCount 基本 版本:1.0.0

預設值: 1

Cassandra 是複寫資料庫,這項屬性會指定做為 StatefulSet 的 Cassandra 節點數量。

cassandra.resources.requests.cpu 進階 版本:1.0.0

預設值: 500m

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

cassandra.resources.requests.memory 進階 版本:1.0.0

預設值: 1Gi

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

cassandra.restore.cloudProvider 進階 版本:1.0.0

預設值: GCP

還原服務供應商的名稱。支援的值:GCP、HYBRID 和 CSI。將值設為:

  • GCP,從儲存在 Google Cloud Storage 的備份還原資料。
  • HYBRID,從儲存在遠端 SSH 伺服器的備份還原資料。
  • CSI (建議) 使用 Kubernetes CSI 磁碟區快照還原資料。如要瞭解 Google Cloud、AWS 和 Azure 等雲端平台的CSI備份和還原功能,請參閱 CSI 備份和還原。
cassandra.restore.dbStorageBucket 進階 版本:1.0.0

預設值:無

如果啟用還原功能,且 cassandra.restore.cloudProvider 設為 GCP,則為必填。

格式必須為 gs://BUCKET_NAME (必須加上 gs:// 前置字串)。

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

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

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

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

預設值:無

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

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

cassandra.restore.serviceAccountPath 進階 版本:1.0.0

預設值:無

具有「Storage Object Admin」(roles/storage.objectAdmin) 角色的 Google 服務帳戶金鑰檔案路徑。這個 Google 服務帳戶會用來從指定cassandra.restore.dbStorageBucket下載備份封存檔案。

如果已啟用還原功能,且 cassandra.restore.cloudProvider 設為 GCP,則必須符合下列其中一項條件,才能確保 Apigee Hybrid 可以存取 Google Cloud Storage 值區,下載備份封存檔以進行還原:

cassandra.restore.serviceAccountRef 進階 於下列版本推出:1.2.0

預設值:無

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

如果已啟用還原功能,且 cassandra.restore.cloudProvider 設為 GCP,則必須符合下列其中一項條件,才能確保 Apigee Hybrid 可以存取 Google Cloud Storage 值區,下載備份封存檔以進行還原:

cassandra.restore.snapshotTimestamp 進階 版本:1.0.0

預設值:無

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

要還原的備份時間戳記。

cassandra.sslCertPath 基本 於下列版本推出:1.2.0

預設值:無

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

cassandra.sslKeyPath 基本 於下列版本推出:1.2.0

預設值:無

系統中傳輸層安全標準 (TLS) 私密金鑰檔案的路徑。

cassandra.sslRootCAPath 基本 於下列版本推出:1.2.0

預設值:無

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

cassandra.storage.capacity 基本 版本:1.0.0

預設值: 10Gi

如果指定 storage.storageclass,則必須提供 apigeectl 管理的安裝作業。

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

cassandra.storage.storageclass 基本 版本:1.0.0

預設值:無

指定使用的地端部署儲存空間類別。

cassandra.storage.storageSize 基本 推出版本:1.11.0

預設值: 10Gi

僅限 Helm:指定 storage.storageclass 時為必填

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

cassandra.terminationGracePeriodSeconds 進階 版本:1.0.0

預設值: 300

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

certManager

Apigee 使用 cert-manager 驗證憑證。

下表說明 certManager 物件的屬性:

屬性 類型 說明
certManager.namespace 進階 推出版本:1.9.0

預設值: cert-manager

cert-manager 的命名空間。

請參閱「在自訂命名空間中執行 cert-manager」。

connectAgent

Apigee Connect 可讓 Apigee Hybrid 管理層安全地連線至執行階段層的 MART 服務,不必將 MART 端點公開至網際網路。

請參閱「Apigee Connect」。

下表說明 connectAgent 物件的屬性:

屬性 類型 說明
connectAgent.annotations 進階 推出版本:1.5.0

預設值:無

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

connectAgent.gsa 進階 推出版本:1.10.0

預設值:無

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

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

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「Enabling Workload Identity with Helm charts」。

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

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

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

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

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

connectAgent.serviceAccountRef 基本 於下列版本推出:1.2.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

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

connectAgent.targetCPUUtilizationPercentage 進階 於下列版本推出:1.2.0

預設值: 75

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

connectAgent.terminationGracePeriodSeconds 進階 於下列版本推出:1.2.0

預設值: 600

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

defaults

Apigee Hybrid 安裝的預設加密金鑰。

下表說明 defaults 物件的屬性:

屬性 類型 說明
defaults.org.kmsEncryptionKey 基本 版本:1.0.0

預設值: aWxvdmVhcGlzMTIzNDU2Nw==

KMS 中機構的預設加密金鑰。

defaults.org.kvmEncryptionKey 基本 版本:1.0.0

預設值: aWxvdmVhcGlzMTIzNDU2Nw==

機構在 KVM 中的預設加密金鑰。

defaults.env.kmsEncryptionKey 基本 版本:1.0.0

預設值: aWxvdmVhcGlzMTIzNDU2Nw==

KMS 中環境 (env) 的預設加密金鑰。

defaults.env.kvmEncryptionKey 基本 版本:1.0.0

預設值: aWxvdmVhcGlzMTIzNDU2Nw==

KVM 中環境 (env) 的預設加密金鑰。

defaults.env.cacheEncryptionKey 基本 版本:1.0.0

預設值: aWxvdmVhcGlzMTIzNDU2Nw==

環境 (env) 的預設快取加密金鑰。

diagnostic

診斷收集器工具的設定。

請參閱「使用診斷收集器」

下表說明 diagnostic 物件的屬性:

屬性 類型 說明
diagnostic.bucket 基本 推出版本:1.6.0

預設值:無

必要

診斷資料的存放位置,也就是 Google Cloud 儲存空間 bucket 的名稱。

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

diagnostic.container 基本 推出版本:1.6.0

預設值:無

必要

這會指定要從哪種 Pod 擷取資料。可能的值如下:

  • "apigee-cassandra" 會擷取 Cassandra 資料庫的相關資料。 istio-cassandra Pod 會在 apigee 命名空間中執行。
  • "apigee-mart-server" 會擷取 MART 的相關資料。 apigee-mart-server Pod 會在 apigee 命名空間中執行。
  • "apigee-runtime" 會擷取訊息處理器相關資料。 apigee-runtime Pod 會在 apigee 命名空間中執行。
  • "apigee-synchronizer" 會擷取有關 Synchronizer 的資料。 apigee-synchronizer Pod 會在 apigee 命名空間中執行。
  • "apigee-udca" 會擷取 UDCA 的相關資料。 apigee-udca Pod 會在 apigee 命名空間中執行。
  • "apigee-watcher" 會擷取 Watcher 的相關資料。 apigee-watcher Pod 會在 apigee 命名空間中執行。
  • "istio-proxy" 會擷取 Istio 輸入閘道的相關資料。 istio-proxy Pod 會在 istio-system 命名空間中執行。
diagnostic.loggingDetails.logDuration 基本 推出版本:1.6.0

預設值:無

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

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

請參閱「diagnostic.operation」

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

預設值:無

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

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

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

預設值:無

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

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

diagnostic.namespace 基本 推出版本:1.6.0

預設值:無

必要

您要收集資料的 Pod 所在 Kubernetes 命名空間。命名空間必須與您使用 diagnostic.container 指定的容器相符:

apigee:

  • apigee-runtime
  • apigee-synchronizer
  • apigee-udca
  • apigee-watcher
  • apigee-cassandra
  • apigee-mart-server

istio-system:

  • istio-proxy
diagnostic.operation 基本 推出版本:1.6.0

預設值:無

必要

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

Values are:

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

預設值:無

必要

您要收集資料的 Kubernetes Pod 名稱。例如:

diagnostic:
 podNames:
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
diagnostic.serviceAccountPath 基本 推出版本:1.6.0

預設值:無

必要

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

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

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

預設值:無

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

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

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

預設值:無

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

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

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

預設值:無

如果您使用 diagnostic.threadDumpDetails,則必須提供 diagnostic.threadDumpDetails.delayInSeconds 和 diagnostic.threadDumpDetails.iterations。

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

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

預設值:無

如果您使用 diagnostic.threadDumpDetails,則必須提供 diagnostic.threadDumpDetails.delayInSeconds 和 diagnostic.threadDumpDetails.iterations。

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

envs

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

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

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

下表說明 envs 物件的屬性:

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

預設值:無

必須提供「cacheEncryptionKey」、「cacheEncryptionPath」或「cacheEncryptionSecret」其中一個。

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

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

預設值:無

必須提供「cacheEncryptionKey」、「cacheEncryptionPath」或「cacheEncryptionSecret」其中一個。

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

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

預設值:無

必須提供「cacheEncryptionKey」、「cacheEncryptionPath」或「cacheEncryptionSecret」其中一個。

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

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

預設值:無

你必須提供 cacheEncryptionKey、cacheEncryptionPath 或 cacheEncryptionSecret 其中之一。

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

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

預設值:4

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

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

預設值:1

自動調度資源的副本數量下限。如果指定,則會覆寫 runtime.replicaCountMin。

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

預設值:4

自動調度資源的副本數量上限。如果指定,則會覆寫 synchronizer.replicaCountMax。

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

預設值:1

自動調度資源的副本數量下限。如果指定,則會覆寫 synchronizer.replicaCountMin。

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

預設值:4

自動調度資源的副本數量上限。如果指定,則會覆寫 udca.replicaCountMax。

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

預設值:1

自動調度資源的副本數量下限。如果指定,則會覆寫 udca.replicaCountMin。

envs.gsa.runtime 進階 推出版本:1.10.0

預設值:無

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

請參閱「Enabling Workload Identity with Helm charts」。

envs.gsa.synchronizer 進階 推出版本:1.10.0

預設值:無

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

請參閱「Enabling Workload Identity with Helm charts」。

envs.gsa.udca 進階 推出版本:1.10.0

預設值:無

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

請參閱「Enabling Workload Identity with Helm charts」。

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

預設值:無

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

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

預設值:無

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

依 scheme、host、port 順序列出 httpProxy 屬性。例如:

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

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

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

預設值:無

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

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

預設值: HTTPS

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

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

預設值:無

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

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

預設值:無

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

envs[].name 基本 版本:1.0.0

預設值:無

必要

要同步的 Apigee 環境名稱。

envs[].pollInterval 進階 版本:1.0.0

預設值:無

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

envs[].port 進階 版本:1.0.0

預設值:無

HTTPS 流量的 TCP 通訊埠編號。

envs[].serviceAccountPaths.runtime 基本 推出版本:1.4.0

預設值:無

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

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

預設值:無

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

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

預設值:無

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

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

envs[].serviceAccountSecretRefs.runtime 基本 推出版本:1.4.0

預設值:無

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

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

預設值:無

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

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

預設值:無

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

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

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

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

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

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

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

系統中傳輸層安全標準 (TLS) 私密金鑰檔案的路徑。

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

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

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

另請參閱:

gcp

識別 Google Cloud 專案 ID (所有混合式安裝作業都必須提供)、工作負載身分設定,以及 apigee-logger 和 apigee-metrics 推送資料的區域。

下表說明 gcp 物件的屬性:

屬性 類型 說明
gcp.region 基本 於下列版本推出:1.2.0

預設值: us-central1

必要

識別 apigee-logger 和 apigee-metrics 推送資料的 Google Cloud 區域。

gcp.projectID 基本 於下列版本推出:1.2.0

預設值:無

必要

識別 Google Cloud 雲端專案,apigee-logger 和 apigee-metrics 會將資料推送至該專案。

gcp.projectIDRuntime 基本 於下列版本推出:1.2.0

預設值:無

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

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

gcp.workloadIdentity.enabled 基本 推出版本:1.10.0

預設值:false

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

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

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

gcp.workloadIdentity.gsa 進階 推出版本:1.10.0

預設值:無

僅限 Helm:啟用 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 with Helm charts」。

gcp.workloadIdentityEnabled 基本 推出版本:1.4.0

預設值:false

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

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

如果 workloadIdentityEnabled 為 true,Apigee 會使用 Kubernetes 服務帳戶,而非 IAM 服務帳戶,並忽略下列設定屬性:

httpProxy

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

另請參閱:connectAgent、logger、mart、metrics、 synchronizer 和 udca。

下表說明 httpProxy 物件的屬性:

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

預設值:無

HTTP Proxy 的主機名稱。

httpProxy.port 基本 推出版本:1.1.1

預設值:無

HTTP Proxy 的通訊埠。

httpProxy.scheme 基本 推出版本:1.1.1

預設值: HTTPS

Proxy 使用的配置。值可以是 HTTP 或 HTTPS。值只能是英文大寫。

httpProxy.username 基本 推出版本:1.1.1

預設值:無

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

httpProxy.password 基本 推出版本:1.1.1

預設值:無

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

ingressGateways

設定 Apigee Ingress 閘道的每個執行個體。如要透過 ingressGateways[].name 個別管理執行個體,請使用這些屬性。

如要對所有 Apigee Ingress 閘道執行個體套用通用設定,請參閱 apigeeIngressGateway。

如果您使用 Helm 管理 Apigee Hybrid,請透過 apigee-org 圖表將變更套用至 ingressGateways 屬性。

下表說明 ingressGateways 物件的屬性:

屬性 類型 說明
ingressGateways[].name 基本 在版本中推出:1.8.0

預設值:無

必要

Ingress 閘道的名稱。其他服務會使用這個名稱,將流量導向閘道。名稱必須符合下列規定:

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

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

ingressGateways[].resources.limits.cpu 進階 在版本中推出:1.8.0

預設值: 2000m

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

ingressGateways[].resources.limits.memory 進階 在版本中推出:1.8.0

預設值: 1Gi

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

ingressGateways[].resources.requests.cpu 進階 在版本中推出:1.8.0

預設值: 300m

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

ingressGateways[].resources.requests.memory 進階 在版本中推出:1.8.0

預設值: 128Mi

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

ingressGateways[].replicaCountMax 基本 在版本中推出:1.8.0

預設值: 10

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

ingressGateways[].replicaCountMin 基本 在版本中推出:1.8.0

預設值: 2

可供自動調整資源配置的 Ingress 閘道 Pod 數量下限。

ingressGateways[].svcAnnotations 基本 在版本中推出:1.8.0

預設值:無

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

ingressGateways:
  svcAnnotations:
    networking.gke.io/load-balancer-type: "Internal"
ingressGateways[].svcLoadBalancerIP 基本 在版本中推出:1.8.0

預設值:無

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

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

預設值:LoadBalancer

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

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

預設值: 75

ReplicaSet 中 Pod 數量的資源調度 CPU 使用率門檻,以可用 CPU 資源總數的百分比表示。

如果 CPU 使用率超過這個值,混合式系統就會逐步增加 ReplicaSet 中的 Pod 數量,最多可達 ingressGateways[].replicaCountMax。

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

istiod

設定 Apigee Ingress。

下表說明 istiod 物件的屬性:

屬性 類型 說明
istiod.accessLogFile 進階 推出版本:1.8.0

預設值: /dev/stdout

傳入存取記錄的檔案位址,例如 /dev/stdout。

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

istiod.accessLogFormat 進階 推出版本:1.8.0

輸入存取記錄的格式。

如果未定義這個值,系統會使用 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 Ingress 閘道) 如何處理 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 閘道 Pod。

istiod.image.pullPolicy 進階 推出版本:1.8.0

預設值: IfNotPresent

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

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

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

istiod.image.tag 進階 在版本中推出:1.8.0

預設值: 1.18.7-asm.26-distroless

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

istiod.image.url 進階 在版本中推出:1.8.0

預設值:無

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

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

k8sCluster

識別安裝 Hybrid 執行階段的 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

預設值: v0.14.2

這項服務 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 hybrid 服務都會輸出這項資訊。

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

下表說明 logger 物件的屬性:

屬性 類型 說明
logger.annotations 進階 推出版本:1.5.0

預設值:無

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

logger.enabled 基本 版本:1.0.0

預設值: false

啟用或停用叢集的記錄功能。如果不是 GKE,請設為 true;如果是 Anthos 或 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.fluentd.buffer_chunk_limit 進階 版本:1.0.0

預設值: 512k

允許的緩衝區區塊大小上限 (以 KB 為單位)。超過上限的區塊會自動排入輸出佇列。

logger.fluentd.buffer_queue_limit 進階 版本:1.0.0

預設值: 6

輸出佇列的長度上限。預設上限為 256 個區塊。

logger.fluentd.flush_interval 進階 版本:1.0.0

預設值: 5s

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

logger.fluentd.max_retry_wait 進階 版本:1.0.0

預設值: 30

寫入重試之間的時間間隔上限 (以秒為單位)。

logger.fluentd.num_threads 進階 版本:1.0.0

預設值: 2

用於排清緩衝區的執行緒數量。預設值為 1。

logger.image.pullPolicy 進階 版本:1.0.0

預設值: IfNotPresent

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

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

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

logger.gsa 進階 推出版本:1.10.0

預設值:無

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

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

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「Enabling Workload Identity with Helm charts」。

logger.image.tag 進階 版本:1.0.0

預設值: 1.9.9

這項服務 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.proxyURL 基本 版本:1.0.0

預設值:無

客戶 Proxy 伺服器的網址。

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

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

具有「記錄檔寫入者」角色的 Google 服務帳戶金鑰檔案路徑。

logger.serviceAccountRef 基本 於下列版本推出:1.2.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

logger.terminationGracePeriodSeconds 進階 版本:1.0.0

預設值: 30

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

mart

定義 MART (Management API for RunTime data) 服務,做為公開 Apigee API 的 API 供應商,方便您存取及管理執行階段資料實體,例如 KMS (API 金鑰和 OAuth 權杖)、KVM、配額和 API 產品。

下表說明 mart 物件的屬性:

屬性 類型 說明
mart.annotations 進階 推出版本:1.5.0

預設值:無

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

mart.gsa 進階 推出版本:1.10.0

預設值:無

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

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

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「Enabling Workload Identity with Helm charts」。

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

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

預設值:無

選用節點選取器標籤值,用於指定 Kubernetes 節點的 mart 執行階段服務。另請參閱 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

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

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

mart.serviceAccountRef 基本 於下列版本推出:1.2.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

mart.sslCertPath 基本 版本:1.0.0

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

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

mart.sslKeyPath 基本 版本:1.0.0

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

用於將 SSL 金鑰載入及編碼為 Secret 的本機檔案系統路徑。

mart.sslSecret 基本 於下列版本推出:1.2.0

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

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

另請參閱:

mart.targetCPUUtilizationPercentage 進階 版本:1.0.0

預設值: 75

Pod 中 MART 程序的目標 CPU 使用率。當 CPU 使用率達到這個欄位的值時,MART 會自動調度資源,最多可達 replicaCountMax。

mart.terminationGracePeriodSeconds 進階 版本:1.0.0

預設值: 30

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

metrics

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

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

下表說明 metrics 物件的屬性:

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

預設值: IfNotPresent

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

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

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

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

預設值: v0.11.0

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

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

預設值:無

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

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

metrics.aggregator.resources.requests.cpu 進階 推出版本:1.4.0

預設值: 500m

Kubernetes 容器中匯總工具正常運作所需的 CPU,以毫核心為單位。

metrics.aggregator.resources.requests.memory 進階 推出版本:1.4.0

預設值: 512Mi

Kubernetes 容器中匯總工具正常運作所需的記憶體,以 mebibytes 為單位。

metrics.aggregator.resources.limits.cpu 進階 推出版本:1.4.0

預設值: 500m

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

metrics.aggregator.resources.limits.memory 進階 推出版本:1.4.0

預設值: 3Gi

Kubernetes 容器中匯總器資源的記憶體限制 (以 GiB 為單位)。

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

metrics.app.resources.limits.cpu 進階 推出版本:1.4.0

預設值: 500m

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

metrics.app.resources.limits.memory 進階 推出版本:1.4.0

預設值: 1Gi

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

metrics.appStackdriverExporter.resources.requests.cpu 進階 導入版本:1.7.0

預設值: 128m

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

metrics.appStackdriverExporter.resources.requests.memory 進階 導入版本:1.7.0

預設值: 512Mi

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

metrics.appStackdriverExporter.resources.limits.cpu 進階 導入版本:1.7.0

預設值: 500m

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

metrics.appStackdriverExporter.resources.limits.memory 進階 導入版本:1.7.0

預設值: 1Gi

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

metrics.enabled 基本 版本:1.0.0

預設值: true

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

metrics.gsa 進階 推出版本:1.10.0

預設值:無

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

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

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「Enabling Workload Identity with Helm charts」。

metrics.nodeSelector.key 基本 版本:1.0.0

預設值:無

必要

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

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

metrics.nodeSelector.value 基本 版本:1.0.0

預設值:無

必要

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

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

metrics.prometheus.args.storage_tsdb_retention 進階 版本:1.0.0

預設值: 48h

Prometheus 從本機儲存空間移除舊資料前等待的時間量 (以小時為單位)。

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

預設值: v2.45.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.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 容器中 Proxy 正常運作所需的記憶體,以 MiB 為單位。

metrics.proxy.resources.limits.cpu 進階 推出版本:1.4.0

預設值: 500m

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

metrics.proxy.resources.limits.memory 進階 推出版本:1.4.0

預設值: 1Gi

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

metrics.proxyStackdriverExporter.resources.requests.cpu 進階 導入版本:1.7.0

預設值: 128m

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

metrics.proxyStackdriverExporter.resources.requests.memory 進階 導入版本:1.7.0

預設值: 512Mi

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

metrics.proxyStackdriverExporter.resources.limits.cpu 進階 導入版本:1.7.0

預設值: 500m

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

metrics.proxyStackdriverExporter.resources.limits.memory 進階 導入版本:1.7.0

預設值: 1Gi

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

metrics.proxyURL 基本 版本:1.0.0

預設值:無

Kubernetes 叢集中指標程序 Sidecar 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

預設值: v0.9.0

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

metrics.sdSidecar.image.url 進階 版本:1.0.0

預設值:無

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

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

metrics.serviceAccountPath 基本 版本:1.0.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

具有「監控指標寫入者」角色的 Google 服務帳戶金鑰檔案路徑。

metrics.serviceAccountRef 基本 於下列版本推出:1.2.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

metrics.stackdriverExporter.resources.requests.cpu 進階 推出版本:1.4.0

Deprecated:從 Hybrid 1.8 版開始,metrics:stackdriverExporter已替換為 metrics:appStackdriverExporter 和 metrics:proxyStackdriverExporter。請參閱:

metrics.stackdriverExporter.resources.requests.memory 進階 推出版本:1.4.0

Deprecated:從 Hybrid 1.8 版開始,metrics:stackdriverExporter已替換為 metrics:appStackdriverExporter 和 metrics:proxyStackdriverExporter。請參閱:

metrics.stackdriverExporter.resources.limits.cpu 進階 推出版本:1.4.0

Deprecated:從 Hybrid 1.8 版開始,metrics:stackdriverExporter已替換為 metrics:appStackdriverExporter 和 metrics:proxyStackdriverExporter。請參閱:

metrics.stackdriverExporter.resources.limits.memory 進階 推出版本:1.4.0

Deprecated:從 Hybrid 1.8 版開始,metrics:stackdriverExporter已替換為 metrics:appStackdriverExporter 和 metrics:proxyStackdriverExporter。請參閱:

metrics.terminationGracePeriodSeconds 進階 版本:1.0.0

預設值: 300

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

mintTaskScheduler

mintTaskScheduler 是用來排定營利工作的 Cron 工作,例如定期計算週期性費用。

下表說明 mintTaskScheduler 物件的屬性:

屬性 類型 說明
mintTaskScheduler.image.pullPolicy 進階 導入版本:1.7.0

預設值: IfNotPresent

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

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

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

mintTaskScheduler.image.tag 進階 導入版本:1.7.0

預設值: 1.11.2

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

nodeSelector

nodeSelector 物件會定義 Apigee 執行個體的節點。在幕後,apigeectl 執行時,會負責將 apigeeRuntime 和 apigeeData 的標籤鍵/值對應至個別的 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

預設值:false

requiredForScheduling 屬性預設為 false。如果這個值覆寫為 true,表示 Kubernetes 找不到設定的標籤鍵/值節點,因此不會在 VM 工作站節點上排定基礎 Pod。

在正式版中,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

預設值: v1.27.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.11.2

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

runtime

下表說明 runtime 物件的屬性:

屬性 類型 說明
runtime.annotations 進階 推出版本:1.5.0

預設值:無

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

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

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

runtime.hpaBehavior.scaleDown.stabilizationWindowSeconds 進階 導入版本:1.7.0

預設值:120

縮減規模時應考量過去建議的秒數。

runtime.hpaBehavior.scaleUp.percent.periodSeconds 進階 導入版本:1.7.0

預設值:60

在擴大執行個體百分比時,政策應保持為 true 的時間範圍。

runtime.hpaBehavior.scaleUp.percent.value 進階 導入版本:1.7.0

預設值:20

在擴大執行個體百分比時,政策應保持為 true 的時間範圍。

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 層級的 Proxy 要求在執行階段例項的處理佇列中,所需的平均等待時間 (以毫秒為單位)。

runtime.hpaMetrics.serverNioTaskWaitTime 進階 導入版本:1.7.0

預設值:400M

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

runtime.hpaMetrics.targetCPUUtilizationPercentage 進階 導入版本:1.7.0

預設值:75

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

runtime.image.pullPolicy 進階 版本:1.0.0

預設值: IfNotPresent

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

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

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

runtime.image.tag 進階 版本:1.0.0

預設值: 1.11.2

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

自動調度資源功能可用的副本數量上限。

runtime.replicaCountMin 基本 版本:1.0.0

預設值: 1

可供自動調度資源的副本數量下限。

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

預設值: 4000m

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

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

預設值: 6Gi

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

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

預設值: 180

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

synchronizer

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

詳情請參閱「設定同步器」。

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

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

預設值:無

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

請參閱「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.replicaCountMax 和 synchronizer.replicaCountMin 管理 Synchronizer 副本數量。

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

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

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

synchronizer.serviceAccountRef 基本 於下列版本推出:1.2.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

synchronizer.serviceAccountSecret 基本 推出版本:1.2.0

預設值:無

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

synchronizer.targetCPUUtilizationPercentage 進階 版本:1.0.0

預設值: 75

Pod 中 Synchronizer 程序的目標 CPU 使用率。當 CPU 使用率達到這個值時,同步器就會自動調度資源,最高可達 replicaCountMax。

synchronizer.terminationGracePeriodSeconds 進階 版本:1.0.0

預設值: 30

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

udca

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

詳情請參閱「收集 Analytics 和部署狀態資料」。

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

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

udca.fluentd.image.url 進階 版本:1.0.0

預設值:無

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

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

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

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

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「Enabling Workload Identity with Helm charts」。

udca.image.pullPolicy 進階 版本:1.0.0

預設值:IfNotPresent

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

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

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

udca.image.tag 進階 版本:1.0.0

預設值: 1.11.2

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

混合式環境可自動為 UDCA 部署項目新增的 Pod 數量上限。 由於 UDCA 是以 ReplicaSet 形式實作,因此 Pod 是副本。

建議將 udca.replicaCountMax 設為每個環境的備用資源數量上限,再乘以 Apigee 機構中的環境數量。舉例來說,如要允許每個環境最多有 4 個副本,且您有 3 個環境,請將 udca.replicaCountMax: 12 設為 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

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

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

udca.serviceAccountRef 基本 於下列版本推出:1.2.0

預設值:無

請提供 serviceAccountPath 或 serviceAccountRef 其中之一。

udca.targetCPUUtilizationPercentage 進階 版本:1.0.0

預設值: 75

ReplicaSet 中 Pod 數量的資源調度 CPU 使用率門檻,以可用 CPU 資源總數的百分比表示。混合模式會使用資料收集 Pod (fluentd 和 UDCA) 中所有容器的綜合使用率,計算目前的使用率。

如果 CPU 使用率超過這個值,混合式自動調度資源功能就會逐步增加 ReplicaSet 中的 Pod 數量,最多可達 udca.replicaCountMax。

udca.terminationGracePeriodSeconds 進階 版本:1.0.0

預設值: 600

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

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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

virtualhosts

virtualhosts 屬性是必要的設定屬性。 虛擬主機可讓 Apigee Hybrid 處理傳送至指定環境群組的 API 要求。

詳情請參閱「設定虛擬主機」。

下表說明 virtualhosts 物件的屬性:

屬性 類型 說明
virtualhosts[].additionalGateways 基本 於下列版本推出:1.2.0

預設值:無

要將流量轉送至的 Istio 閘道清單。

virtualhosts[].cipherSuites[] 進階 推出版本:1.9.2

預設值:無

這項屬性會設定輸入閘道中使用的 TLS 密碼。以下列出 OpenSSL 格式中預設啟用的密碼。如要進一步瞭解支援的密碼,請參閱 Envoy 的 Boring FIPS 建構版本說明文件。如果值為空白,則預設為 Envoy 的 Boring FIPS 建構版本支援的密碼編譯套件。

預設啟用 TLS v.1.3 (您無法覆寫 TLS 1.3 密碼套件):

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256

預設啟用 TLS v.1.2:

  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES256-GCM-SHA384

如要在 Apigee Ingress 閘道部署中啟用舊版 TLS,請使用 virtualhosts.minTLSProtocolVersion 和 virtualhosts.cipherSuites 屬性。

舉例來說,如要啟用 TLS v.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[].minTLSProtocolVersion 和 virtualhosts[].maxTLSProtocolVersion 之間使用最佳 TLS 通訊協定版本。Apigee Hybrid 支援 TLSv1.0 至 TLSv1.3。

值必須是數字。例如:

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[].minTLSProtocolVersion 和 virtualhosts[].maxTLSProtocolVersion 之間使用最佳 TLS 通訊協定版本。Apigee Hybrid 支援 TLSv1.0 至 TLSv1.3。

值必須是數字。例如:

virtualhosts:
  - name: default
    minTLSProtocolVersion: "1.2"

其中數字代表 TLS 版本號碼,格式為 #.#。在上述範例中,1.2 代表 Istio TLS 版本 TLSV1_2。

另請參閱 Istio 說明文件中的 ServerTLSSettings.TLSProtocol 。

virtualhosts[].selector 基本 於下列版本推出:1.2.0

預設值: app: apigee-ingressgateway

必要

鍵/值選擇器值組,用於指向不同的 Ingress 選擇器。

  • apigee-ingressgateway:適用於使用 Apigee Ingress 閘道的 Apigee Hybrid 安裝作業。
  • istio-ingressgateway:適用於使用 Anthos 服務網格的 Apigee Hybrid 安裝作業 (Apigee Hybrid 1.8 版和更早版本)。

如果未提供選取器標籤,系統會將設定提供給 Apigee Ingress 閘道。

virtualhosts[].sslCertPath 基本 於下列版本推出:1.2.0

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

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

virtualhosts[].sslKeyPath 基本 於下列版本推出:1.2.0

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

系統中傳輸層安全標準 (TLS) 私密金鑰檔案的路徑。

virtualhosts[].sslSecret 基本 於下列版本推出:1.2.0

預設值:無

必須提供 sslCertPath/sslKeyPath 或 sslSecret。

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

另請參閱:

watcher

watcher 屬性是必要的設定屬性。 監控程序會監控設定變更,並觸發應用程式至執行階段平面。

下表說明 watcher 物件的屬性:

屬性 類型 說明
watcher.annotations 進階 導入版本:1.5.0

預設值:無

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

watcher.args.enableIssueScanning 進階 推出版本:1.10.0

預設值: true

啟用或停用自動顯示問題功能。true 會自動掃描控制層和 Kubernetes API 伺服器狀態,判斷是否有任何設定問題。

設為 false 即可停用自動顯示問題功能。詳情請參閱「自動顯示問題」。

watcher.args.issueScanInterval 進階 推出版本:1.10.0

預設值: 60

Watcher 掃描執行階段平面以自動顯示問題的間隔時間 (以秒為單位)。詳情請參閱「自動顯示問題」。

watcher.gsa 進階 推出版本:1.10.0

預設值:無

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

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

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

例如:

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

請參閱「Enabling Workload Identity with Helm charts」。

watcher.image.pullPolicy 進階 推出版本:1.4.0

預設值: IfNotPresent

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

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

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

watcher.image.tag 進階 推出版本:1.4.0

預設值: 1.11.2

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

watcher.image.url 進階 推出版本:1.4.0

預設值:無

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

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

watcher.replicaCountMax 基本 推出版本:1.3.0

預設值: 1

觀察項目的副本數量上限。為避免衝突,請將此值維持在 1 以下。

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 Runtime Agent」角色的 Google 服務帳戶金鑰檔案路徑。

watcher.serviceAccountRef 進階 推出版本:1.3.0

預設值:無

您必須提供 serviceAccountPath 或 serviceAccountRef 其中之一。

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

預設值:無

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:無

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

key 會找出可套用容錯的 Pod。

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

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

預設值: "Equal"

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

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

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

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

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

預設值:無

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

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

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

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

預設值:無

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

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

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