設定屬性參考資料

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

篩選這個頁面

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

螢幕   本頁的設定屬性。

頂層屬性

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

屬性 類型 說明
axHashSalt 進階

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

預設值: 貴機構名稱

選用

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

預設值: 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 將資料推送至何處。

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

預設值:

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

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

預設值:

必要

此安裝作業的專屬 ID。

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

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

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

預設值:

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

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

預設值: defaults.org.kmsEncryptionKey

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

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

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

預設值:

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

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

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

預設值:

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

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

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

預設值:

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

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

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

預設值: defaults.org.kmsEncryptionKey

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

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

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

預設值:

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

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

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

預設值:

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

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

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

預設值:

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

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

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

預設值: apigee

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

org 基本

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

預設值:

必要

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

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

預設值: true

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

組織層級 UDCA 會為所有 Apigee 環境使用單一服務帳戶。服務帳戶必須透過 overrides.yaml 設定中的 udca:serviceAccountPath 屬性進行設定 (該屬性應將路徑設為具有 Apigee Analytics Agent 角色的 Google 服務帳戶金鑰檔案)。

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

另請參閱:udca

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

預設值: "194" (您的 Apigee Hybrid 版本,不含句點。例如,1.9.0 版的預設值為 "190")。

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

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

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

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

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

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

預設值: true

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

另請參閱 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

預設值: false

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

  • 如果是使用 Apigee 入口閘道進行混合式安裝,請將此值設為 true
  • 如果是使用 Anthos 服務網格進行混合雲安裝作業 (Apigee 混合雲版本 1.8 及更早版本),請將此值設為 false
ao.image.pullPolicy 進階 這項功能已在以下版本推出:1.2.0

預設值: IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

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

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

ao.installer.pullPolicy 進階 這項元素已在以下版本推出:1.3.0

預設值: IfNotPresent

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

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

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

ao.installer.tag 進階 這項元素已在以下版本推出:1.3.0

預設值: 1.9.4

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

ao.installer.url 進階 這項元素已在以下版本推出:1.3.0

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

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

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 為單位。

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

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

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

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

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

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.backup.cloudProvider 進階 這項功能已在以下版本推出:1.0.0

預設值: GCP

如果已啟用備份功能,則為必要欄位。

備份儲存空間的雲端供應商。

您可以將值設為 GCPHYBRID。如果要將備份儲存在 Google Cloud Storage 中,請將值設為 GCP;如果要將備份儲存在遠端伺服器中,請設為 HYBRID

如要瞭解 Google Cloud、AWS 和 Azure 等雲端平台的 CSI 備份與還原作業,請參閱「CSI 備份與還原」一文。

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

預設值:

如果已啟用備份功能,則為必要欄位。

備份資料的 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.9.4

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

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

預設值: gcr.io/apigee-release/hybrid/apigee-cassandra-backup-utility

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

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

預設值: 0 2 * * *

Cron 工作的時間表。

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

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

預設值:

如果已啟用備份功能,則必須提供 backup.serviceAccountPathbackup.serviceAccountRef 其中之一。

具有 Storage 物件管理員角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

如果已啟用備份功能,則必須提供 backup.serviceAccountPathbackup.serviceAccountRef 其中之一。

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 會在多區域安裝作業中使用這項功能,這是非 GKE 安裝作業的預設情況,包括 GKE 在內部部署、AWS 上的 GKE、裸機上的 Anthos、AKS、EKS 和 OpenShift。

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

如果是多區域安裝作業,且不同叢集中的 Pod 之間沒有通訊,請將 cassandra.hostNetwork 設為 true,例如 GKE On-prem、AWS 上的 GKE、裸機上的 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.9.4

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

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

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

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

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

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

預設值: GCP

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

備份儲存空間的雲端供應商。

如要瞭解 Google Cloud、AWS 和 Azure 等雲端平台的 CSI 備份與還原作業,請參閱「CSI 備份與還原」一文。

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

預設值:

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

要還原備份資料的 Cloud Storage 值區。

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

預設值: false

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

預設值: gcr.io/apigee-release/hybrid/apigee-cassandra-backup-utility

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

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

預設值:

如果啟用還原功能,就必須使用 restore.serviceAccountPathrestore.serviceAccountRef 其中之一。

具有 Storage 物件管理員角色的 Google 服務帳戶金鑰檔案路徑。

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

預設值:

如果啟用還原功能,就必須使用 restore.serviceAccountPathrestore.serviceAccountRef 其中之一。

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

預設值:

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

應還原的備份時間戳記。

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

預設值: 管理員帳戶

用於結構定義備份還原作業的 Cassandra 使用者名稱。如未指定,系統會使用管理員使用者。

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

預設值:

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

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

預設值:

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

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

預設值:

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

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

預設值: 10Gi

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

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

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

預設值:

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

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

預設值: 300

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

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.server 進階 這項功能已在以下版本推出:1.2.0

預設值: apigeeconnect.googleapis.com:443

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

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

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

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

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

這項服務的 Docker 映像檔位置。檢查 values.yaml 檔案,找出特定網址。

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

預設值: 5

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

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

預設值: 1

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

在實際環境中,您可能會將 replicaCountMin 增加至 3,以便有更多連線可連至控制層,提高可靠性和可擴充性。

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

預設值: 100m

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

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

預設值: 30Mi

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

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 遭到終止之間的時間,以秒為單位。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。

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.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[].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

預設值:

指定 HTTP Proxy 的類型為 HTTP 或 HTTPS。預設會使用「HTTP」。

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

預設值:

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

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

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 密鑰中的檔案名稱,其中包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。

另請參閱:

gcp

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

下表說明 gcp 物件的屬性:

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

預設值: us-central1

必要

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

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

預設值:

必要

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

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

預設值:

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

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

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

預設值:false

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

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

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

httpProxy

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

另請參閱:loggermart指標synchronizerudca

下表說明 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 Hybrid 設定 Apigee 入口閘道。

下表說明 ingressGateways 物件的屬性:

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.17.2-asm.8-distroless

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

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

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

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

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

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

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

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.annotations 基本 推出版本:1.9.4

預設值:

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

istiod:
  annotations:
    key1: "value1"
    key2: "value2"
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 入口網站閘道 Pod。

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.17.2-asm.8-distroless

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

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

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

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

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

預設值: v0.14.0

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

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

預設值: gcr.io/apigee-release/hybrid/apigee-kube-rbac-proxy

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

如果您不想使用 Google Docker Hub,請下載映像檔,並使用內部代管 Docker 映像檔的地址。

logger

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

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

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

緩衝區區塊的大小上限 (以千位元為單位)。超過上限的區塊會自動刷新至輸出佇列。

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.image.tag 進階 這項元素已在以下版本推出:1.0.0

預設值: 2.1.3

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

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

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

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

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

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

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

預設值:

必須使用 serviceAccountPathserviceAccountRef 其中之一。

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

預設值: 30

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

mart

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

下表說明 mart 物件的屬性:

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

預設值:

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

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

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

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

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

這項服務的 Docker 映像檔位置。請檢查 values.yaml 檔案,找出特定網址。您可以覆寫這個值。

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.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 遭到終止之間的時間,以秒為單位。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。

metrics

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

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

下表說明 metrics 物件的屬性:

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

預設值: IfNotPresent

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

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

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

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

預設值: v0.10.0

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

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

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

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

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.requests.cpu 進階 這項功能已在以下版本推出:1.7.0

預設值: 128m

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

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

預設值: 512Mi

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

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

預設值: true

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

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

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

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

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

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

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 容器中代理程式正常運作所需的記憶體,以 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

預設值: 0.9.0

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

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

預設值: gcr.io/apigee-release/hybrid/apigee-stackdriver-prometheus-sidecar

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

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 遭到終止之間的時間,以秒為單位。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。

mintTaskScheduler

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

下表說明 mintTaskScheduler 物件的屬性:

屬性 類型 說明
mintTaskScheduler.image.pullPolicy 進階 這項功能已在以下版本推出:1.7.0

預設值: IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

預設值: gcr.io/apigee-release/hybrid/apigee-mint-task-scheduler

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

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

預設值: 500m

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

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

預設值: 512Mi

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

nodeSelector

nodeSelector 物件會定義 Apigee 執行個體的節點。在 apigeectl 執行時,系統會在幕後將 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

預設值:false

requiredForScheduling 屬性預設為 false。如果這個值覆寫為 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

預設值: v1.25.1

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

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

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

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

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

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

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

redis.replicaCount 基本 這項功能已在以下版本推出:1.6.0

預設值: 2

Redis 是複製儲存空間。這個屬性會指定用作 StatefulSet 的 Redis 節點數量。

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

預設值: 500m

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

runtime

下表說明 runtime 物件的屬性:

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

預設值:

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

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

預設值: 安裝項目圖片資源的網址,例如: gcr.io/apigee-release/hybrid/apigee-runtime

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

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

預設值: 12

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.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 遭到終止之間的時間,以秒為單位。在這段期間內,系統會執行所有預停止掛鉤,並且所有執行中的程序都應能正常終止。

synchronizer

確保訊息處理器能與最新部署的 API Proxy 套件保持同步。為此,Synchronizer 會輪詢管理層,偵測到新合約時,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.9.4

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

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

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

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

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.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.targetCPUUtilizationPercentage 進階 這項元素已在以下版本推出:1.0.0

預設值: 75

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

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

預設值: 30

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

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.9.12-2

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

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

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

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

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

預設值: 500m

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

udca.fluentd.resources.limits.memory 進階 這項元素已在以下版本推出:1.0.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.image.pullPolicy 進階 這項功能已在以下版本推出:1.0.0

預設值:IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

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

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

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

預設值: 500m

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

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

預設值: 500Mi

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 中,用於調整 pod 數量的 CPU 使用率門檻,以可用 CPU 資源總數的百分比表示。Hybrid 會使用資料收集 pod 中所有容器 (包括 fluentd 和 UDCA) 的總使用率,計算目前的使用率。

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

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

預設值: 600

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

virtualhosts

virtualhosts 屬性是必要的設定屬性。虛擬主機可讓 Apigee Hybrid 處理指定環境群組的 API 要求。

詳情請參閱「設定虛擬主機」。

下表說明 virtualhosts 物件的屬性:

屬性 類型 說明
virtualhosts[].additionalGateways 基本 這項功能已在以下版本推出:1.2.0

預設值:

要將流量轉送至的 Istio 閘道清單。

virtualhosts[].cipherSuites[] 進階 推出版本:1.9.2

預設值:

TLS 加密法清單。如要查看支援的加密編碼完整清單,請參閱 Boring FIPS 版本的 Envoy 說明文件。空白值預設為 Boring FIPS 版本的 Envoy 支援的加密組合。

舉例來說,如要支援 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:適用於使用 Anthos 服務網格的 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 密鑰中的檔案名稱,其中包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。

另請參閱:

watcher

watcher 屬性是必要的設定屬性。監控器是一種程序,可監控設定變更,並觸發對執行階段平面的應用。

下表說明 watcher 物件的屬性:

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

預設值:

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

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.9.4

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

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

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

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

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

預設值: 1

監控備用資源的數量上限。為避免衝突,請將這個值保持為 1

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

預設值: 1

監控備用資源的數量下限。

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

預設值:

必要。

具有 Apigee 執行階段代理人角色的 Google 服務帳戶金鑰檔案路徑。

watcher.serviceAccountRef 進階 這項元素已在以下版本推出:1.3.0

預設值:

必須指定 serviceAccountPath 或 serviceAccountRef 其中一個。