本節列出所有可用於自訂 Apigee Hybrid 部署作業執行階段層的設定屬性。
篩選這個頁面
如要篩選這個頁面顯示的屬性,請選取「基本」(最常見的屬性) 或「進階」 (很少需要變更的屬性):
多媒體廣告活動頂層屬性
下表說明 overrides.yaml
檔案中的頂層屬性。這些是不屬於其他物件的屬性,適用於機構或環境層級:
屬性 | 類型 | 說明 |
---|---|---|
axHashSalt |
進階 | 導入版本:1.3.0 預設值: 選用 Kubernetes 密鑰的名稱,其中包含用於計算雜湊的鹽,可在使用者資料傳送至 Apigee Analytics 前混淆處理。如未指定鹽值,系統預設會使用 Apigee 會先使用 SHA512 雜湊處理原始值,再將資料從執行階段層傳送至控制層。 請參閱「對使用者資料進行模糊處理,以便用於數據分析」。 |
contractProvider |
進階 | 推出版本:1.0.0
預設值: 定義安裝中所有 API 的 API 路徑。 如果混合式安裝作業使用資料落地,則為必填欄位,格式如下: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com 其中 CONTROL_PLANE_LOCATION 是儲存控制平面資料 (例如 Proxy 組合) 的位置。如需清單,請參閱「可用的 Apigee API 控制平面區域」。 例如: contractProvider: https://us-apigee.googleapis.com |
gcpProjectID |
進階 | Deprecated: 如果是 1.2.0 以上版本,請改用 gcp.projectID 。
推出版本:1.0.0 預設值: 無 必要 Google Cloud 專案的 ID。可搭配 |
gcpRegion |
進階 | Deprecated: 如果是 1.2.0 以上版本,請改用 gcp.region 。
推出版本:1.0.0 預設值: 必要 Kubernetes 叢集最近的 Google Cloud 區域或可用區。與 |
hub |
進階 | 版本:1.11.0
預設值:無 私人映像檔容器存放區的網址,用於從私人存放區提取所有 Apigee 元件的映像檔。
每個個別元件的圖片路徑會是
舉例來說,如果 hub: private-docker-host.example.com 為: ## an example of internal component vs 3rd party containers: - name: apigee-udca image: private-docker-host.example.com/apigee-udca:1.13.4 imagePullPolicy: IfNotPresent containers: - name: apigee-ingressgateway image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.4-distroless imagePullPolicy: IfNotPresent 其他元件也會遵循類似模式。 使用 請參閱「搭配 Apigee Hybrid 使用私人映像檔存放區」。 您可以使用下列屬性,個別覆寫元件的圖片網址:
|
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) 叢集名稱。可與 |
kmsEncryptionKey |
進階 | 推出版本:1.0.0
預設值: 選填。請只使用 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
預設值: 選填。請只使用 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
預設值: 如果是多機構叢集,這項屬性可將機構的指標匯出至 |
namespace |
基本 | 推出版本:1.0.0
預設值: Kubernetes 叢集的命名空間,Apigee 元件將安裝於此。 |
org |
基本 |
推出版本:1.0.0 預設值:無 必要 Apigee 在 Hybrid 安裝期間為您佈建的混合型機構。機構是 Apigee 中的頂層容器,其中包含所有 API Proxy 和相關資源。如果值為空白,您必須在建立機構後,更新機構名稱。 |
orgScopedUDCA |
進階 | 推出版本:1.8.0
預設值: 在機構層級啟用通用資料收集代理程式 (UDCA) 服務,擷取分析、營利和偵錯 (追蹤) 資料,並傳送至位於控制平面的 Unified Analytics Platform (UAP)。 機構範圍的 UDCA 會為所有 Apigee 環境使用單一 Google 服務帳戶。服務帳戶必須具備 Apigee Analytics 代理程式 ( 使用 如果您偏好為每個環境使用個別的 UDCA 代理程式,請設定 另請參閱:udca。 |
revision |
進階 | 推出版本:1.0.0
預設值: Apigee Hybrid 支援 Kubernetes 滾動式更新,可逐步更新 Pod 執行個體,完全不必停機即可部署更新。 更新某些 YAML 覆寫項目時,如果導致基礎 Kubernetes
變更並套用
如要變更下列物件的屬性,必須更新 詳情請參閱「推出更新」。 |
serviceAccountSecretProviderClass |
進階 | 版本:1.12.0
預設值:無 用於在 Vault 中儲存服務帳戶金鑰的機構專屬密鑰供應商類別 ( |
validateOrg |
進階 | 推出版本:1.8.0
預設值: 嚴格驗證 Apigee 機構與 Google Cloud 專案之間的連結,並檢查環境群組是否存在。
另請參閱 |
validateServiceAccounts |
進階 | 推出版本:1.0.0
預設值: 啟用服務帳戶權限的嚴格驗證。這會使用 Cloud Resource Manager API 方法
另請參閱 |
ao
Apigee Operators (AO) 會建立及更新部署和維護元件所需的低階 Kubernetes 和 Istio 資源。舉例來說,控制器會執行訊息處理器的發布作業。
下表說明 apigee-operators ao
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
ao.args.disableIstioConfigInAPIServer |
進階 | 推出版本:1.8.0
預設值: 停止向客戶安裝的 Cloud Service Mesh 提供設定。
|
ao.args.disableManagedClusterRoles |
進階 | 導入版本:1.10.0
預設值:
如果選取 |
ao.image.pullPolicy |
進階 | 推出版本:1.2.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
ao.image.tag |
進階 | 推出版本:1.2.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
ao.image.url |
進階 | 推出版本:1.2.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
ao.resources.limits.cpu |
進階 | 推出版本:1.2.0
預設值: Kubernetes 容器中資源的 CPU 限制 (以毫秒為單位)。
|
ao.resources.limits.memory |
進階 | 推出版本:1.2.0
預設值: Kubernetes 容器中資源的記憶體限制,以 MiB 為單位。
|
ao.resources.requests.cpu |
進階 | 推出版本:1.2.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
ao.resources.requests.memory |
進階 | 推出版本:1.2.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
ao.tolerations.effect |
進階 | 推出版本:1.10.1
預設值:無 使用 Kubernetes 的 Taints and Tolerations 功能時,必須設定這項屬性。
詳情請參閱「Taints and Tolerations: Concepts」。 |
ao.tolerations.key |
進階 | 推出版本:1.10.1
預設值:無 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
ao.tolerations.operator |
進階 | 推出版本:1.10.1
預設值: 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
ao.tolerations.tolerationSeconds |
進階 | 推出版本:1.10.1
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
ao.tolerations.value |
進階 | 推出版本:1.10.1
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
apigeeIngressGateway
設定 Apigee Hybrid 的 Apigee 進入閘道。使用 apigeeIngressGateway
屬性,將一般設定套用至所有 Apigee Ingress 閘道執行個體。
如要個別設定執行個體,請參閱 ingressGateways
。
使用 apigee-org
圖表將變更套用至 apigeeIngressGateway
屬性。
下表說明 apigeeIngressGateway
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
apigeeIngressGateway.image.pullPolicy |
進階 | 版本:1.11.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
apigeeIngressGateway.image.tag |
進階 | 版本:1.11.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
apigeeIngressGateway.image.url |
進階 | 版本:1.11.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
apigeeIngressGateway.nodeSelector.key |
進階 | 版本:1.11.0
預設值:無 必要 節點選取器標籤鍵,用於指定 Ingress 閘道服務的專屬 Kubernetes 節點。 請參閱 設定專屬節點集區。 |
apigeeIngressGateway.nodeSelector.value |
進階 | 版本:1.11.0
預設值:無 選用節點選取器標籤值,用於指定輸入閘道服務的專屬 Kubernetes 節點,並覆寫 請參閱 nodeSelector。 |
apigeeIngressGateway.replicaCountMax |
基本 | 版本:1.11.0
預設值: 混合式可自動新增的 Pod 數量上限,適用於可自動調整資源配置的 Ingress 閘道。 |
apigeeIngressGateway.replicaCountMin |
基本 | 版本:1.11.0
預設值: 可供自動調整資源配置的 Ingress 閘道 Pod 數量下限。 |
apigeeIngressGateway.targetCPUUtilizationPercentage |
進階 | 導入版本:1.10.5、1.11.2、1.12.1
預設值: ReplicaSet 中 Pod 數量的資源調度 CPU 使用率門檻,以可用 CPU 資源總數的百分比表示。 如果 CPU 使用率超過這個值,混合式自動調度資源功能就會逐步增加 ReplicaSet 中的 Pod 數量,最多可達 如要進一步瞭解 Kubernetes 中的調度功能,請參閱 Kubernetes 說明文件的水平 Pod 自動調度。 |
apigeeIngressGateway.tolerations.effect |
進階 | 版本:1.11.0
預設值:無 使用 Kubernetes 的 Taints and Tolerations 功能時,必須設定這項屬性。
詳情請參閱「Taints and Tolerations: Concepts」。 |
apigeeIngressGateway.tolerations.key |
進階 | 版本:1.11.0
預設值:無 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
apigeeIngressGateway.tolerations.operator |
進階 | 版本:1.11.0
預設值: 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
apigeeIngressGateway.tolerations.tolerationSeconds |
進階 | 版本:1.11.0
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
apigeeIngressGateway.tolerations.value |
進階 | 版本:1.11.0
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
cassandra
定義用於管理執行階段資料存放區的混合式服務。這個存放區會儲存應用程式設定、分散式配額計數器、API 金鑰,以及在閘道上執行的應用程式 OAuth 權杖。
詳情請參閱「StorageClass 設定」。
下表說明 cassandra
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
cassandra.annotations |
進階 | 導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
cassandra.auth.admin.password |
基本 | 推出版本:1.0.0
預設值: 必要 Cassandra 管理員的密碼。管理員使用者可用於在 Cassandra 叢集上執行任何管理活動,例如備份和還原。 |
cassandra.auth.ddl.password |
基本 | 推出版本:1.0.0
預設值: 必要 Cassandra 資料定義語言 (DDL) 使用者的密碼。MART 用於任何資料定義工作,例如建立、更新及刪除鍵空間。 |
cassandra.auth.default.password |
基本 | 推出版本:1.0.0
預設值: 必要 啟用驗證時建立的預設 Cassandra 使用者密碼。設定 Cassandra 驗證時,必須重設這組密碼。請參閱「為 Cassandra 設定 TLS」。 |
cassandra.auth.dml.password |
基本 | 推出版本:1.0.0
預設值: 必要 Cassandra 資料操縱語言 (DML) 使用者的密碼。用戶端通訊會使用 DML 使用者,從 Cassandra 讀取及寫入資料。 |
cassandra.auth.image.pullPolicy |
進階 | 推出版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
cassandra.auth.image.tag |
進階 | 推出版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
cassandra.auth.image.url |
進階 | 推出版本:1.0.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
cassandra.auth.jmx.password |
基本 | 導入版本:1.4.0
預設值: 必要 Cassandra JMX 作業使用者的密碼。用於驗證及與 Cassandra JMX 介面通訊。 |
cassandra.auth.jmx.username |
基本 | 導入版本:1.4.0
預設值: 必要 Cassandra JMX 作業使用者的使用者名稱。用於驗證及與 Cassandra JMX 介面通訊。 |
cassandra.auth.jolokia.password |
基本 | 導入版本:1.4.0
預設值: 必要 Cassandra Jolokia JMX 作業使用者的密碼。用於驗證及與 Cassandra JMX API 通訊。 |
cassandra.auth.jolokia.username |
基本 | 導入版本:1.4.0
預設值: 必要 Cassandra Jolokia JMX 作業使用者的使用者名稱。用於驗證及與 Cassandra JMX API 通訊。 |
cassandra.auth.secret |
基本 | 導入版本:1.3.3
預設值:無 儲存在 Kubernetes 密碼中的檔案名稱,內含 Cassandra 使用者和密碼。您可以按照下列操作說明建立密鑰: 建立密鑰。 另請參閱:
|
cassandra.auth.secretProviderClass |
進階 | 導入版本:1.10.3
預設值:無 Cassandra 密鑰儲存空間政策。設定後,這個值必須與參照外部密鑰提供者 (例如 Hashicorp Vault) 的 SecretProviderClass 相符。如果未設定,Apigee Hybrid 會使用儲存在下列位置的使用者名稱和密碼:
或儲存在下列位置的 Kubernetes Secret: 如需建立政策的操作說明,請參閱在 Hashicorp Vault 中儲存 Cassandra 密鑰。 |
cassandra.backup.cloudProvider |
進階 | 推出版本:1.0.0
預設值: 備份供應商的名稱。支援的值: |
cassandra.backup.dbStorageBucket |
進階 | 推出版本:1.0.0
預設值:無 如果已啟用備份功能,且 現有 Google Cloud Storage 值區的名稱,用於儲存備份封存檔。如需建立 bucket,請參閱「 建立 bucket」一文。 |
cassandra.backup.enabled |
進階 | 推出版本:1.0.0
預設值: 根據預設,系統不會啟用資料備份功能。如要啟用,請設為 請參閱「Cassandra 備份與復原」。 |
cassandra.backup.gsa |
進階 | 導入版本:1.10.0
預設值:無 僅限 Helm: GSA 電子郵件地址的格式通常為: GSA_NAME@PROJECT_ID.iam.gserviceaccount.com 例如: apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com |
cassandra.backup.image.pullPolicy |
進階 | 推出版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
cassandra.backup.image.tag |
進階 | 推出版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
cassandra.backup.image.url |
進階 | 推出版本:1.0.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
cassandra.backup.keyfile |
進階 | 導入版本:1.3.0
預設值:無 如果已啟用備份功能,且 本機檔案系統中安全殼層私密金鑰檔案的路徑。 |
cassandra.backup.schedule |
進階 | 推出版本:1.0.0
預設值: 備份 Cron 工作的時間表。 請參閱「Cassandra 備份與復原」。 |
cassandra.backup.server |
進階 | 導入版本:1.3.0
預設值:無 如果已啟用備份功能,且 遠端 SSH 備份伺服器的 IP 位址。 |
cassandra.backup.serviceAccountPath |
進階 | 推出版本:1.0.0
預設值:無 具有「Storage Object Admin」( 如果已啟用備份功能,且 |
cassandra.backup.serviceAccountRef |
進階 | 推出版本:1.2.0
預設值:無 現有 Kubernetes 密鑰的名稱,用於儲存具有 Storage 物件管理員 ( 如果已啟用備份功能,且 |
cassandra.backup.storageDirectory |
進階 | 導入版本:1.3.0
預設值:無 如果已啟用備份功能,且 可以是 備份 SSH 伺服器上的備份目錄名稱。 |
cassandra.clusterName |
基本 | 推出版本:1.0.0
預設值: 指定 Cassandra 叢集的名稱。 |
cassandra.datacenter |
基本 | 推出版本:1.0.0
預設值: 指定 Cassandra 節點的資料中心。 |
cassandra.dnsPolicy |
基本 | 推出版本:1.1.1
預設值:無
將 |
cassandra.externalSeedHost |
基本 | 推出版本:1.0.0
預設值:無 Cassandra 叢集節點的主機名稱或 IP。如未設定,系統會使用 Kubernetes 本機服務。 |
cassandra.heapNewSize |
基本 | 推出版本:1.0.0
預設值: 分配給較新物件的 JVM 系統記憶體量,以 MB 為單位。 |
cassandra.hostNetwork |
基本 | 推出版本:1.1.1
預設值: 啟用 Kubernetes
針對單一區域安裝和多區域安裝,請將 如果多區域安裝作業中,不同叢集的 Pod 之間沒有通訊,請將
|
cassandra.image.pullPolicy |
進階 | 推出版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
cassandra.image.tag |
進階 | 推出版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
cassandra.image.url |
進階 | 推出版本:1.0.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
cassandra.maxHeapSize |
進階 | 推出版本:1.0.0
預設值: Cassandra 作業可用的 JVM 系統記憶體上限 (以 MB 為單位)。 |
cassandra.multiRegionSeedHost |
基本 | 推出版本:1.0.0
預設值:無 現有 Cassandra 叢集的 IP 位址,用於將現有叢集擴展至新區域。請參閱「設定多區域種子主機」。 |
cassandra.nodeSelector.key |
進階 | 推出版本:1.0.0
預設值:無 必要 用於指定 請參閱 設定專屬節點集區。 |
cassandra.nodeSelector.value |
進階 | 推出版本:1.0.0
預設值:無 選用的節點選取器標籤值,用於指定資料服務的專屬 Kubernetes 節點,並覆寫 請參閱 nodeSelector。 |
cassandra.port |
進階 | 推出版本:1.0.0
預設值: 連線至 Cassandra 時使用的通訊埠編號。 |
cassandra.rack |
基本 | 推出版本:1.0.0
預設值: 指定 Cassandra 節點的機架。 |
cassandra.readinessProbe.failureThreshold |
進階 | 推出版本:1.0.0
預設值: Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。 |
cassandra.readinessProbe.initialDelaySeconds |
進階 | 推出版本:1.0.0
預設值: 容器啟動後,啟動就緒探測作業前的秒數。 |
cassandra.readinessProbe.periodSeconds |
進階 | 推出版本:1.0.0
預設值: 決定執行準備狀態探測的頻率 (以秒為單位)。最小值為 1。 |
cassandra.readinessProbe.successThreshold |
進階 | 推出版本:1.0.0
預設值: 失敗後,至少要連續成功幾次,才算成功。最小值為 1。 |
cassandra.readinessProbe.timeoutSeconds |
進階 | 推出版本:1.0.0
預設值: 健康狀態探測逾時的秒數。最小值為 1。 |
cassandra.replicaCount |
基本 | 推出版本:1.0.0
預設值: Cassandra 是複寫資料庫。這項屬性會指定做為 StatefulSet 的 Cassandra 節點數量。 |
cassandra.resources.requests.cpu |
進階 | 推出版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
cassandra.resources.requests.memory |
進階 | 推出版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
cassandra.restore.cloudProvider |
進階 | 推出版本:1.0.0
預設值: 還原供應商的名稱。支援的值: |
cassandra.restore.dbStorageBucket |
進階 | 推出版本:1.0.0
預設值:無 如果已啟用還原功能,且 Google Cloud Storage bucket 的名稱,用於儲存備份封存檔,以供資料還原。 |
cassandra.restore.enabled |
進階 | 推出版本:1.0.0
預設值: 根據預設,系統不會啟用資料還原功能,如要啟用,請設為 請參閱「Cassandra 備份與復原」。 |
cassandra.restore.gsa |
進階 | 導入版本:1.10.0
預設值:無 僅限 Helm:啟用 GKE 叢集上的 Workload Identity 時,要與 Cassandra 還原 Kubernetes 服務帳戶建立關聯的 GSA 電子郵件地址的格式通常為: GSA_NAME@PROJECT_ID.iam.gserviceaccount.com 例如: apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com |
cassandra.restore.image.pullPolicy |
進階 | 推出版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
cassandra.restore.image.tag |
進階 | 推出版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
cassandra.restore.image.url |
進階 | 推出版本:1.0.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
cassandra.restore.serviceAccountPath |
進階 | 推出版本:1.0.0
預設值:無 具有「Storage Object Admin」( 如果已啟用還原功能,且 |
cassandra.restore.serviceAccountRef |
進階 | 推出版本:1.2.0
預設值:無 現有 Kubernetes 密鑰的名稱,用於儲存具有 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
預設值: 指定 指定所需磁碟大小,以 MiB 或 GiB 為單位。 |
cassandra.storage.storageclass |
基本 | 推出版本:1.0.0
預設值:無 指定使用的內部部署儲存空間類別。 |
cassandra.storage.storageSize |
基本 | 版本:1.11.0
預設值: 指定 指定所需磁碟大小,以 MiB 或 GiB 為單位。 |
cassandra.terminationGracePeriodSeconds |
進階 | 推出版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
cassandra.tolerations.effect |
進階 | 推出版本:1.10.1
預設值:無 使用 Kubernetes 的 Taints and Tolerations 功能時,必須設定這項屬性。
詳情請參閱「Taints and Tolerations: Concepts」。 |
cassandra.tolerations.key |
進階 | 推出版本:1.10.1
預設值:無 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
cassandra.tolerations.operator |
進階 | 推出版本:1.10.1
預設值: 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
cassandra.tolerations.tolerationSeconds |
進階 | 推出版本:1.10.1
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
cassandra.tolerations.value |
進階 | 推出版本:1.10.1
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
certManager
Apigee 使用 cert-manager 進行憑證驗證。
下表說明 certManager
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
certManager.namespace |
進階 | 推出版本:1.9.0
預設值: cert-manager 的命名空間。 請參閱「在自訂命名空間中執行 cert-manager」。 |
connectAgent
Apigee Connect 可讓 Apigee Hybrid 管理層安全地連線至執行階段層中的 MART 服務,無須在網際網路上公開 MART 端點。
下表說明 connectAgent
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
connectAgent.annotations |
進階 | 導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
connectAgent.gsa |
進階 | 導入版本:1.10.0
預設值:無 僅限 Helm:啟用 GKE 叢集上的 Workload Identity 時,connectAgent 會使用 Helm 資訊圖表,將 Google IAM 服務帳戶 (GSA) 的電子郵件地址與對應的 Kubernetes 服務帳戶建立關聯。設定 GSA 電子郵件地址的格式通常為: GSA_NAME@PROJECT_ID.iam.gserviceaccount.com 例如: apigee-mart@my-hybrid-project.iam.gserviceaccount.com 請參閱「在 GKE 上啟用 Workload Identity」或「在 AKS 和 EKS 上啟用 Workload Identity Federation」。 |
connectAgent.logLevel |
進階 | 推出版本:1.2.0
預設值: 記錄回報層級。可能的值:
|
connectAgent.image.pullPolicy |
進階 | 推出版本:1.2.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
connectAgent.image.tag |
進階 | 推出版本:1.2.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
connectAgent.image.url |
進階 | 推出版本:1.2.0
預設值:無 這項服務的 Docker 映像檔位置。 使用 |
connectAgent.replicaCountMax |
基本 | 推出版本:1.2.0
預設值: 可供自動調度資源的副本數量上限。 |
connectAgent.replicaCountMin |
基本 | 推出版本:1.2.0
預設值: 可供自動調整資源配置的備用資源數量下限。 在正式環境中,您可能需要將 |
connectAgent.resources.limits.cpu |
進階 | 版本:1.11.0
預設值: Kubernetes 容器中資源的 CPU 限制 (以毫秒為單位)。
|
connectAgent.resources.limits.memory |
進階 | 版本:1.11.0
預設值: Kubernetes 容器中資源的記憶體限制,以 MiB 為單位。
|
connectAgent.resources.requests.cpu |
進階 | 版本:1.11.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
connectAgent.resources.requests.memory |
進階 | 推出版本:1.2.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
connectAgent.server |
進階 | 推出版本:1.2.0
預設值: 這項服務的伺服器位置和通訊埠。 |
connectAgent.serviceAccountPath |
基本 | 推出版本:1.1.1
預設值:無 請提供
在大多數安裝作業中, |
connectAgent.serviceAccountRef |
基本 | 推出版本:1.2.0
預設值:無 請提供
在大多數安裝作業中, |
connectAgent.targetCPUUtilizationPercentage |
進階 | 推出版本:1.2.0
預設值: Pod 中 Apigee Connect 代理程式的目標 CPU 使用率。當 CPU 使用率達到這個欄位的值時,Apigee Connect 就會自動調度資源,直到達到 |
connectAgent.terminationGracePeriodSeconds |
進階 | 推出版本:1.2.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
connectAgent.tolerations.effect |
進階 | 推出版本:1.10.1
預設值:無 使用 Kubernetes 的 Taints and Tolerations 功能時,必須設定這項屬性。
詳情請參閱「Taints and Tolerations: Concepts」。 |
connectAgent.tolerations.key |
進階 | 推出版本:1.10.1
預設值:無 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
connectAgent.tolerations.operator |
進階 | 推出版本:1.10.1
預設值: 使用 Kubernetes 的 Taints 和容許條件功能時,必須啟用這項功能。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
connectAgent.tolerations.tolerationSeconds |
進階 | 推出版本:1.10.1
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
connectAgent.tolerations.value |
進階 | 推出版本:1.10.1
預設值:無 由 Kubernetes 的 Taint 和容許條件功能使用。
詳情請參閱「Taints and Tolerations: Concepts」(汙點和容許度:概念)。 |
defaults
Apigee Hybrid 安裝的預設加密金鑰。
下表說明 defaults
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
defaults.org.kmsEncryptionKey |
基本 | 推出版本:1.0.0
預設值: KMS 中機構的預設加密金鑰。 |
defaults.org.kvmEncryptionKey |
基本 | 推出版本:1.0.0
預設值: 機構在 KVM 中的預設加密金鑰。 |
defaults.env.kmsEncryptionKey |
基本 | 推出版本:1.0.0
預設值: KMS 中環境 (env) 的預設加密金鑰。 |
defaults.env.kvmEncryptionKey |
基本 | 推出版本:1.0.0
預設值: KVM 中環境 (env) 的預設加密金鑰。 |
defaults.env.cacheEncryptionKey |
基本 | 推出版本:1.0.0
預設值: 環境 (env) 的預設快取加密金鑰。 |
diagnostic
診斷收集器工具的設定。
請參閱「使用診斷收集器」
下表說明 diagnostic
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
diagnostic.bucket |
基本 | 推出版本:1.6.0
預設值:無 必要 Google Cloud 儲存空間 bucket 的名稱,診斷資料會存放在這裡。 請參閱「建立儲存空間值區」。 |
diagnostic.container |
基本 | 推出版本:1.6.0
預設值:無 必要 這會指定要從哪種 Pod 擷取資料。可能的值如下:
|
diagnostic.loggingDetails.logDuration |
基本 | 推出版本:1.6.0
預設值:無 如果診斷收集作業為「LOGGING」(使用 收集到的記錄資料時間長度 (以毫秒為單位)。一般值為 |
diagnostic.loggingDetails.loggerNames[] |
基本 | 推出版本:1.6.0
預設值:無 如果診斷收集作業為「LOGGING」(使用 依名稱指定要收集資料的記錄器。如果是 Apigee Hybrid 1.6.0 版,唯一支援的值是 diagnostic: loggingDetails: loggerNames: - ALL |
diagnostic.loggingDetails.logLevel |
基本 | 推出版本:1.6.0
預設值:無 如果診斷收集作業為「LOGGING」(使用 指定要收集的記錄資料精細程度。在 Apigee Hybrid 1.6 中,系統僅支援 |
diagnostic.namespace |
基本 | 推出版本:1.6.0
預設值:無 必要 您要收集資料的 Pod 所在的 Kubernetes 命名空間。命名空間必須與您透過
|
diagnostic.operation |
基本 | 推出版本:1.6.0
預設值:無 必要 指定要收集所有統計資料,還是只收集記錄。 值為:
|
diagnostic.podNames[] |
基本 | 推出版本:1.6.0
預設值:無 必要 您要收集資料的 Kubernetes Pod 名稱。例如: diagnostic: podNames: - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2 |
diagnostic.serviceAccountPath |
基本 | 推出版本:1.6.0
預設值:無 必要 具有 Storage 管理員角色 ( 請參閱「關於服務帳戶」。 |
diagnostic.tcpDumpDetails.maxMsgs |
基本 | 推出版本:1.6.0
預設值:無 如果您使用 設定要收集的 |
diagnostic.tcpDumpDetails.timeoutInSeconds |
基本 | 推出版本:1.6.0
預設值:無 如果您使用 設定等待 |
diagnostic.threadDumpDetails.delayInSeconds |
基本 | 推出版本:1.6.0
預設值:無 如果您使用 收集每個執行緒傾印之間的延遲時間 (以秒為單位)。 |
diagnostic.threadDumpDetails.iterations |
基本 | 推出版本:1.6.0
預設值:無 如果您使用 要收集的 jstack 執行緒傾印疊代次數。 |
envs
定義可部署 API Proxy 的環境陣列。每個環境都會提供獨立的內容或沙箱,用於執行 API Proxy。
啟用混合式功能的機構必須至少有一個環境。
詳情請參閱「關於環境」一文。
下表說明 envs
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
envs[].cacheEncryptionKey |
基本 | 推出版本:1.0.0
預設值:無 必須提供 Base64 編碼的加密金鑰。請參閱「資料加密」一節。 |
envs[].cacheEncryptionPath |
基本 | 推出版本:1.2.0
預設值:無 必須提供 包含 Base64 編碼加密金鑰的檔案路徑。請參閱「資料加密」一節。 |
envs[].cacheEncryptionSecret.key |
基本 | 推出版本:1.2.0
預設值:無 必須提供 Kubernetes Secret 的金鑰,其中包含 Base64 編碼的加密金鑰。請參閱「資料加密」一節。 |
envs[].cacheEncryptionSecret.name |
基本 | 推出版本:1.2.0
預設值:無 你必須提供 Kubernetes 密鑰的名稱,其中包含以 base64 編碼的加密金鑰。請參閱「資料加密」一節。 |
envs[].components.runtime.replicaCountMax |
基本 | 推出版本:1.9.3
預設值:4 自動調度資源的備用資源數量上限。如果指定,則會覆寫 |
envs[].components.runtime.replicaCountMin |
基本 | 推出版本:1.9.3
預設值:1 自動調整資源配置的備用資源數量下限。如果指定,則會覆寫 |
envs[].components.synchronizer.replicaCountMax |
基本 | 推出版本:1.9.3
預設值:4 自動調度資源的備用資源數量上限。如果指定,則會覆寫 |
envs[].components.synchronizer.replicaCountMin |
基本 | 推出版本:1.9.3
預設值:1 自動調整資源配置的備用資源數量下限。如果指定,則會覆寫 |
envs[].components.udca.replicaCountMax |
基本 | 推出版本:1.9.3
預設值:4 自動調度資源的備用資源數量上限。如果指定,則會覆寫 |
envs[].components.udca.replicaCountMin |
基本 | 推出版本:1.9.3
預設值:1 自動調整資源配置的備用資源數量下限。如果指定,則會覆寫 |
envs.gsa.runtime |
進階 | 導入版本:1.10.0
預設值:無 僅限 Helm:執行階段 Google IAM 服務帳戶的電子郵件地址,用於在 GKE 叢集上啟用 Workload Identity 時,與對應的 Kubernetes 服務帳戶建立關聯 (使用 Helm 圖表)。 請參閱「在 GKE 上啟用 Workload Identity」或「在 AKS 和 EKS 上啟用 Workload Identity Federation」。 |
envs.gsa.synchronizer |
進階 | 導入版本:1.10.0
預設值:無 僅限 Helm:啟用 Workload Identity 時,同步器 Google IAM 服務帳戶的電子郵件地址會與對應的 Kubernetes 服務帳戶建立關聯。啟用方式是使用 Helm 資訊套件, 請參閱「在 GKE 上啟用 Workload Identity」或「在 AKS 和 EKS 上啟用 Workload Identity Federation」。 |
envs.gsa.udca |
進階 | 導入版本:1.10.0
預設值:無 僅限 Helm:udca Google IAM 服務帳戶的電子郵件地址 (適用於環境範圍的 udca),用於在 GKE 叢集上使用 Helm 資訊圖表啟用 Workload Identity 時,與對應的 Kubernetes 服務帳戶建立關聯。 請參閱「在 GKE 上啟用 Workload Identity」或「在 AKS 和 EKS 上啟用 Workload Identity Federation」。 |
envs[].hostAliases[] |
基本 | 推出版本:1.2.0
預設值:無 Deprecated:從 Hybrid 1.4 版開始,執行階段平面會從管理平面接收這項資訊。請參閱關於環境和環境群組。 |
envs[].httpProxy.host |
基本 | 推出版本:1.2.0
預設值:無 指定執行 HTTP Proxy 的主機名稱或 IP 位址。 依 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 的通訊埠 |
envs[].httpProxy.scheme |
基本 | 推出版本:1.2.0
預設值: 指定 HTTP Proxy 的類型,例如 HTTP 或 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 服務帳戶金鑰,通常是 |
envs[].serviceAccountPaths.synchronizer |
基本 | 推出版本:1.0
預設值:無 本機系統上檔案的路徑,該檔案是具有「Apigee Synchronizer Manager」角色的 Google 服務帳戶金鑰。 |
envs[].serviceAccountPaths.udca |
基本 | 推出版本:1.0
預設值:無 本機系統上檔案的路徑,該檔案是具有 Apigee Analytics 代理程式角色的 Google 服務帳戶金鑰。 只有在 |
envs[].serviceAccountSecretProviderClass |
進階 | 版本:1.12.0
預設值:無 用於在 Vault 中儲存服務帳戶金鑰的環境專屬密鑰供應商類別名稱 ( |
envs[].serviceAccountSecretRefs.runtime |
基本 | 導入版本:1.4.0
預設值:無 Kubernetes 密鑰名稱。您必須使用具有 Cloud Trace 代理者角色的 Google 服務帳戶金鑰做為輸入內容,建立密鑰。 |
envs[].serviceAccountSecretRefs.synchronizer |
基本 | 推出版本:1.2.0
預設值:無 Kubernetes 密鑰名稱。您必須使用具有「Apigee Synchronizer Manager」角色的 Google 服務帳戶金鑰建立密鑰。 |
envs[].serviceAccountSecretRefs.udca |
基本 | 推出版本:1.2.0
預設值:無 Kubernetes 密鑰名稱。您必須使用具有「Apigee Analytic Agent」角色的 Google 服務帳戶金鑰做為輸入內容,建立密鑰。 只有在 |
envs[].sslCertPath |
基本 | 推出版本:1.2.0
預設值:無 請提供
系統中傳輸層安全標準 (TLS) 憑證檔案的路徑。 |
envs[].sslKeyPath |
基本 | 推出版本:1.2.0
預設值:無 必須提供
系統上 TLS 私密金鑰檔案的路徑。 |
envs[].sslSecret |
基本 | 推出版本:1.2.0
預設值:無 請提供
儲存在 Kubernetes 密鑰中的檔案名稱,該檔案包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。 另請參閱:
|
gcp
識別 Google Cloud 專案 ID (所有混合式安裝作業都必須提供)、Workload Identity 和聯盟 Workload Identity 設定,以及 apigee-logger
和 apigee-metrics
推送資料的區域。
下表說明 gcp
物件的屬性:
屬性 | 類型 | 說明 |
---|---|---|
gcp.federatedWorkloadIdentity.audience |
基本 | 版本:1.12.0
預設值:無 非 GKE 平台上的 Workload Identity 提供者允許的對象。 |
gcp.federatedWorkloadIdentity.credentialSourceFile |
基本 | 版本:1.12.0
預設值:無 Workload Identity Federation 用來取得服務帳戶憑證的憑證來源檔案名稱和路徑。使用 |
gcp.federatedWorkloadIdentity.enabled |
基本 | 版本:1.12.0
預設值: 在非 GKE 平台上啟用 Workload Identity Federation。如果 |
gcp.federatedWorkloadIdentity.tokenExpiration |
基本 | 版本:1.12.0
預設值: 權杖的生命週期 (以秒為單位)。 |
gcp.projectID |
基本 | 推出版本:1.2.0
預設值:無 必要 識別 Google Cloud 專案,其中 |
gcp.projectIDRuntime |
基本 | 推出版本:1.2.0
預設值:無 識別執行階段 Kubernetes 叢集專案。
|
gcp.region |
基本 | 推出版本:1.2.0
預設值: 必要 識別 Google Cloud 區域, |
gcp.workloadIdentity.enabled |
基本 | 導入版本:1.10.0
預設值: 僅限 Helm:啟用在 GKE 上使用 Workload Identity。透過 Workload Identity,GKE 叢集中的工作負載可以模擬 Identity and Access Management (IAM) 服務帳戶,存取 Google Cloud 服務。 如果 如果 如果 |