本節列出所有可用於自訂 Apigee Hybrid 部署作業執行階段層的設定屬性。
頂層屬性
下表說明 overrides.yaml 檔案中的頂層屬性。這些屬性不屬於其他物件,適用於機構或環境層級:
| 屬性 | 說明 |
|---|---|
axHashSalt |
推出版本:1.3.0 預設值: 貴機構名稱 選用 Kubernetes 密鑰的名稱,其中包含用於加密傳送至 Apigee Analytics 的模糊處理使用者資料的雜湊鹽值。如未指定鹽值,系統預設會使用貴機構的名稱。 建立密碼,並將鹽值做為輸入內容。您可以在多個叢集中使用相同的鹽,確保叢集間的雜湊結果一致。 |
contractProvider |
版本:1.0.0
預設值: 定義安裝中所有 API 的 API 路徑。 |
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 區域或可用區。與 |
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 編碼的加密金鑰。請參閱「資料加密」一節。 |
namespace |
版本:1.0.0
預設值: Kubernetes 叢集的命名空間,Apigee 元件將安裝於此。 |
org |
推出版本:1.0.0 預設值:無 必要 Apigee 在 Hybrid 安裝期間為您佈建的 Hybrid 啟用機構。機構是 Apigee 中的頂層容器,其中包含所有 API Proxy 和相關資源。如果值為空白,您必須在建立機構後更新機構名稱。 |
revision |
版本:1.0.0
預設值: Apigee Hybrid 支援 Kubernetes 滾動式更新,可逐步更新 Pod 執行個體,完全不必停機即可部署更新。 更新某些 YAML 覆寫項目時,如果導致基礎 Kubernetes
變更並套用
如要變更下列物件的屬性,必須更新 詳情請參閱「推出更新」。 |
validateServiceAccounts |
版本:1.0.0
預設值: 啟用服務帳戶權限的嚴格驗證。這會使用 Cloud Resource Manager API 方法
另請參閱 |
ao
Apigee Operators (AO) 會建立及更新部署和維護 ApigeeDeployment (AD) 所需的低層級 Kubernetes 和 Istio 資源。舉例來說,控制器會釋出訊息處理器。此外,也會在 Kubernetes 叢集中保留 ApigeeDeployment 設定之前,先驗證該設定。
下表說明 apigee-operators ao 物件的屬性:
| 屬性 | 說明 |
|---|---|
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 為單位。 |
authz
下表說明 authz 物件的屬性:
| 屬性 | 說明 |
|---|---|
authz.image.pullPolicy |
版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
authz.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
authz.image.url |
版本:1.0.0
預設值:
這項服務的 Docker 映像檔位置。 |
authz.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
authz.livenessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,到啟動存活探測作業之間的時間間隔 (以秒為單位)。 |
authz.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
authz.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
authz.readinessProbe.failureThreshold |
版本:Beta2
預設值: Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。 |
authz.readinessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,啟動就緒探測作業前的秒數。 |
authz.readinessProbe.periodSeconds |
版本:1.0.0
預設值: 決定執行準備狀態探測的頻率 (以秒為單位)。最小值為 1。 |
authz.readinessProbe.successThreshold |
版本:1.0.0
預設值: 失敗後,至少要連續成功幾次,才算成功。最小值為 1。 |
authz.readinessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
authz.resources.requests.cpu |
版本:1.0.0
預設值: 要為驗證要求分配的 CPU 資源量。 |
authz.resources.requests.memory |
版本:1.0.0
預設值: 要為驗證要求分配的記憶體資源量。 |
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 密鑰中的檔案名稱,該檔案包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。 另請參閱:
|
cassandra.backup.cloudProvider |
推出版本:1.0.0
預設值: 如果已啟用備份功能,則為必要選項。 備份儲存空間的雲端供應商。 您可以將值設為 |
cassandra.backup.dbStorageBucket |
版本:1.0.0
預設值:無 如果已啟用備份功能,則為必要選項。 備份資料的 Cloud Storage bucket。 |
cassandra.backup.enabled |
版本:1.0.0
預設值: 系統預設不會啟用資料備份功能。如要啟用,請設為 請參閱「Cassandra 備份與復原」。 |
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.schedule |
版本:1.0.0
預設值: Cron 工作的時間表。 請參閱「Cassandra 備份與復原」。 |
cassandra.backup.serviceAccountPath |
版本:1.0.0
預設值:無 如果已啟用備份功能,則必須提供 具有 Storage 物件管理員角色的 Google 服務帳戶金鑰檔案路徑。 |
cassandra.backup.serviceAccountRef |
推出版本:1.2.0
預設值:無 如果已啟用備份功能,則必須提供 |
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
針對單一區域安裝和多區域安裝,請將 將
|
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
預設值:無 如果已啟用還原功能,則為必填欄位。 用於還原備份資料的 Cloud Storage bucket。 |
cassandra.restore.enabled |
版本:1.0.0
預設值: |
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 物件管理員角色的 Google 服務帳戶金鑰檔案路徑。 |
cassandra.restore.serviceAccountRef |
推出版本:1.2.0
預設值:無 如果啟用還原功能,則必須提供 |
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
預設值: 指定 指定所需磁碟大小 (以 MiB 為單位)。 |
cassandra.storage.storageclass |
版本:1.0.0
預設值:無 指定使用的內部部署儲存空間類別。 |
cassandra.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
connectAgent
Apigee Connect 可讓 Apigee Hybrid 管理層安全地連線至執行階段層中的 MART 服務,不必將 MART 端點公開至網際網路。
請參閱「Apigee Connect」。
下表說明 connectAgent 物件的屬性:
| 屬性 | 說明 |
|---|---|
connectAgent.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
connectAgent.enabled |
推出版本:1.2.0
預設值: 這個安裝項目是否使用 Apigee Connect,而非 Istio Ingress for MART?下列敘述是否正確? 請參閱「Apigee Connect」。 |
connectAgent.server |
推出版本:1.2.0
預設值: 這項服務的伺服器和通訊埠位置。 |
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.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
connectAgent.resources.requests.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
connectAgent.targetCPUUtilizationPercentage |
推出版本:1.2.0
預設值: Pod 中 Apigee Connect 代理程式的目標 CPU 使用率。當 CPU 使用率達到這個欄位的值時,Apigee Connect 就會自動調度資源,最高可達 |
connectAgent.terminationGracePeriodSeconds |
推出版本:1.2.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
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 的名稱,診斷資料會存放在這裡。 請參閱「建立儲存空間 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[].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。預設值為「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
預設值:無 本機系統上檔案的路徑,該檔案是具有「Cloud Trace 代理人」角色的 Google 服務帳戶金鑰,通常是 |
envs[].serviceAccountPaths.synchronizer |
推出版本:1.0
預設值:無 本機系統上檔案的路徑,該檔案是具有「Apigee Synchronizer Manager」角色的 Google 服務帳戶金鑰。 |
envs[].serviceAccountPaths.udca |
推出版本:1.0
預設值:無 本機系統上檔案的路徑,該檔案是具有 Apigee Analytic Agent 角色的 Google 服務帳戶金鑰。 |
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 服務帳戶金鑰,建立密鑰。 |
envs[].sslCertPath |
推出版本:1.2.0
預設值:無 請提供
系統中傳輸層安全標準 (TLS) 憑證檔案的路徑。 |
envs[].sslKeyPath |
推出版本:1.2.0
預設值:無 必須提供
系統中 TLS 私密金鑰檔案的路徑。 |
envs[].sslSecret |
推出版本:1.2.0
預設值:無 請提供
儲存在 Kubernetes 密鑰中的檔案名稱,該檔案包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。 另請參閱:
|
gcp
識別 apigee-logger 和 apigee-metrics 推送資料的 Google Cloud 專案 ID 和區域。
下表說明 gcp 物件的屬性:
| 屬性 | 說明 |
|---|---|
gcp.region |
推出版本:1.2.0
預設值:無 必要 識別 |
gcp.projectID |
推出版本:1.2.0
預設值:無 必要 識別 Google Cloud 專案, |
gcp.projectIDRuntime |
推出版本:1.2.0
預設值:無 識別執行階段 Kubernetes 叢集專案。
|
httpProxy
httpProxy 提供 HTTP 轉送 Proxy 伺服器的設定參數。在 overrides.yaml 中設定後,MART、Synchronizer 和 UDCA 元件的所有網際網路通訊都會透過 Proxy 伺服器傳遞。
下表說明 httpProxy 物件的屬性:
| 屬性 | 說明 |
|---|---|
httpProxy.host |
導入版本:1.1.1
預設值:無 HTTP Proxy 的主機名稱。 |
httpProxy.port |
導入版本:1.1.1
預設值:無 HTTP Proxy 的通訊埠。 |
httpProxy.scheme |
導入版本:1.1.1
預設值: Proxy 使用的配置。值可以是 |
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
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
kubeRBACProxy.image.tag |
推出版本: 1.2.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
kubeRBACProxy.image.url |
推出版本:1.2.0
預設值: 這項服務的 Docker 映像檔位置。 如不想使用 Google Docker Hub,請下載映像檔,並使用內部 Docker 映像檔的代管地址。 |
logger
定義管理作業記錄的服務。在 Kubernetes 叢集中執行的所有 Apigee Hybrid 服務都會輸出這項資訊。
詳情請參閱「記錄總覽」。
下表說明 logger 物件的屬性:
| 屬性 | 說明 |
|---|---|
logger.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
logger.enabled |
版本:1.0.0
預設值: 啟用或停用叢集的記錄功能。如果不是 GKE,請設為 |
logger.fluentd.buffer_chunk_limit |
版本:1.0.0
預設值: 允許的緩衝區區塊大小上限 (以 KB 為單位)。超過上限的區塊會自動排入輸出佇列。 |
logger.fluentd.buffer_queue_limit |
版本:1.0.0
預設值: 輸出佇列的長度上限。預設上限為 256 個區塊。 |
logger.fluentd.flush_interval |
版本:1.0.0
預設值: 在叫用下一個緩衝區排清作業前等待的時間間隔 (以秒為單位)。 |
logger.fluentd.max_retry_wait |
版本:1.0.0
預設值: 寫入重試之間的時間間隔上限 (以秒為單位)。 |
logger.fluentd.num_threads |
版本:1.0.0
預設值: 用於排清緩衝區的執行緒數量。預設值為 1。 |
logger.image.pullPolicy |
版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
logger.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
logger.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。 |
logger.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
logger.livenessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,到啟動存活探測作業之間的時間間隔 (以秒為單位)。 |
logger.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
logger.livenessProbe.successThreshold |
版本:1.0.0
預設值: 探測失敗後,至少要連續成功幾次,才算成功。最小值為 1。 |
logger.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
logger.nodeSelector.key |
版本:1.0.0
預設值: 必要 用於指定 請參閱 設定專屬節點集區。 |
logger.nodeSelector.value |
版本:1.0.0
預設值: 必要 節點選取器標籤值,用於指定 請參閱 設定專屬節點集區。 |
logger.proxyURL |
版本:1.0.0
預設值:無 客戶 Proxy 伺服器的網址。 |
logger.resources.limits.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源的記憶體限制,以 MiB 為單位。
|
logger.resources.limits.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源的 CPU 限制 (以毫核為單位)。
|
logger.resources.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
logger.resources.requests.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
logger.serviceAccountPath |
版本:1.0.0
預設值:無 請提供 具有「記錄檔寫入者」角色的 Google 服務帳戶金鑰檔案路徑。 |
logger.serviceAccountRef |
推出版本:1.2.0
預設值:無 請提供 |
logger.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
mart
定義 MART (Management API for RunTime data) 服務,做為公開 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
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
mart.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
mart.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。檢查 |
mart.initCheckCF.resources.requests.cpu |
版本:1.0.0
預設值: 分配給 Cloud Foundry 程序初始化檢查的 CPU 資源量。 |
mart.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
mart.livenessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,到啟動存活探測作業之間的時間間隔 (以秒為單位)。 |
mart.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
mart.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
mart.metricsURL |
版本:1.0.0
預設值: |
mart.nodeSelector.key |
版本:1.0.0
預設值:無 選用節點選取器標籤鍵,用於指定 請參閱 設定專屬節點集區。 |
mart.nodeSelector.value |
版本:1.0.0
預設值:無 選用節點選取器標籤值,用於指定 請參閱 設定專屬節點集區。 |
mart.readinessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。 |
mart.readinessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,啟動就緒探測作業前的秒數。 |
mart.readinessProbe.periodSeconds |
版本:1.0.0
預設值: 決定執行準備狀態探測的頻率 (以秒為單位)。最小值為 1。 |
mart.readinessProbe.successThreshold |
版本:1.0.0
預設值: 失敗後,至少要連續成功幾次,才算成功。最小值為 1。 |
mart.readinessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
mart.replicaCountMax |
版本:1.0.0
預設值: 自動調度資源功能可用的副本數量上限。 |
mart.replicaCountMin |
版本:1.0.0
預設值: 可供自動調度資源的副本數量下限。 |
mart.resources.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
mart.resources.requests.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
mart.serviceAccountPath |
導入版本:1.1.1
預設值:無 請提供 Google 服務帳戶金鑰檔案的路徑 (沒有角色)。 |
mart.serviceAccountRef |
推出版本:1.2.0
預設值:無 請提供 |
mart.sslCertPath |
版本:1.0.0
預設值:無 必須提供 用於將 SSL 憑證載入及編碼至 Secret 的本機檔案系統路徑。 |
mart.sslKeyPath |
版本:1.0.0
預設值:無 請提供 用於將 SSL 金鑰載入及編碼為 Secret 的本機檔案系統路徑。 |
mart.sslSecret |
推出版本:1.2.0
預設值:無 必須提供 儲存在 Kubernetes 密鑰中的檔案名稱,該檔案含有 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。 另請參閱:
|
mart.targetCPUUtilizationPercentage |
版本:1.0.0
預設值: Pod 中 MART 程序的目標 CPU 使用率。當 CPU 使用率達到這個欄位的值時,MART 會自動調度資源,最高可達 |
mart.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
metrics
定義收集作業指標的服務。您可以運用指標資料監控 Hybrid 服務的健康狀態、設定快訊等。
詳情請參閱「指標收集總覽」。
下表說明 metrics 物件的屬性:
| 屬性 | 說明 |
|---|---|
metrics.aggregator.resources.requests.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中匯總工具正常運作所需的 CPU,以毫核心為單位。 |
metrics.aggregator.resources.requests.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中匯總工具正常運作所需的記憶體,以 MiB 為單位。 |
metrics.aggregator.resources.limits.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中匯總器資源的 CPU 限制 (以毫核心為單位)。 |
metrics.aggregator.resources.limits.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中匯總器資源的記憶體限制 (以 GiB 為單位)。 |
metrics.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
metrics.app.resources.requests.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中應用程式正常運作所需的 CPU,以毫核心為單位。 |
metrics.app.resources.requests.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中應用程式正常運作所需的記憶體,以 MiB 為單位。 |
metrics.app.resources.limits.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中應用程式資源的 CPU 限制,以毫核心為單位。 |
metrics.app.resources.limits.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中應用程式資源的記憶體限制 (以 GiB 為單位)。 |
metrics.enabled |
版本:1.0.0
預設值: 啟用 Apigee 指標。設為 |
metrics.nodeSelector.key |
版本:1.0.0
預設值:無 必要 用於指定 請參閱 設定專屬節點集區。 |
metrics.nodeSelector.value |
版本:1.0.0
預設值:無 必要 節點選取器標籤值,用於指定 請參閱 設定專屬節點集區。 |
metrics.prometheus.args.storage_tsdb_retention |
版本:1.0.0
預設值: Prometheus 從本機儲存空間移除舊資料前等待的時間量 (以小時為單位)。 |
metrics.prometheus.containerPort |
版本:1.0.0
預設值: 用來連線至 Prometheus 指標服務的通訊埠。 |
metrics.prometheus.image.pullPolicy |
版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
metrics.prometheus.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
metrics.prometheus.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。 |
metrics.prometheus.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
metrics.prometheus.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
metrics.prometheus.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
metrics.prometheus.readinessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。 |
metrics.prometheus.readinessProbe.periodSeconds |
版本:1.0.0
預設值: 決定執行準備狀態探測的頻率 (以秒為單位)。最小值為 1。 |
metrics.prometheus.readinessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 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
預設值: Kubernetes 容器中 Proxy 正常運作所需的 CPU,以毫核心為單位。 |
metrics.proxy.resources.requests.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中 Proxy 正常運作所需的記憶體,以 mebibytes 為單位。 |
metrics.proxy.resources.limits.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中 Proxy 資源的 CPU 限制 (以毫核心為單位)。 |
metrics.proxy.resources.limits.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中 Proxy 資源的記憶體限制,以 GiB 為單位。 |
metrics.proxyURL |
版本:1.0.0
預設值:無 Kubernetes 叢集中指標程序輔助 Proxy 的網址。 |
metrics.sdSidecar.containerPort |
版本:1.0.0
預設值: 連線至 Cloud Operations 指標服務的通訊埠。 |
metrics.sdSidecar.image.pullPolicy |
版本:1.0.0
預設值: 決定 Kubelet 何時會提取這項服務的 Docker 映像檔。 可能的值包括:
|
metrics.sdSidecar.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
metrics.sdSidecar.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。 |
metrics.serviceAccountPath |
版本:1.0.0
預設值:無 請提供 具有「監控指標寫入者」角色的 Google 服務帳戶金鑰檔案路徑。 |
metrics.serviceAccountRef |
推出版本:1.2.0
預設值:無 請提供 |
metrics.stackdriverExporter.resources.requests.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中 stackdriverExporter 正常運作所需的 CPU,以毫核心為單位。 |
metrics.stackdriverExporter.resources.requests.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中 stackdriverExporter 正常運作所需的記憶體,以 MiB 為單位。 |
metrics.stackdriverExporter.resources.limits.cpu |
推出版本:1.4.0
預設值: Kubernetes 容器中 stackdriverExporter 資源的 CPU 限制,以毫微核心為單位。 |
metrics.stackdriverExporter.resources.limits.memory |
推出版本:1.4.0
預設值: Kubernetes 容器中 stackdriverExporter 資源的記憶體限制,以吉位元組為單位。 |
metrics.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
nodeSelector
nodeSelector 物件會定義 Apigee 執行個體的節點。在幕後執行 apigeectl 時,系統會負責將 apigeeRuntime 和 apigeeData 的標籤鍵/值對應至個別的 Istio 和 MART 元件。您可以在 mart:nodeSelector 屬性中,為個別物件覆寫這項設定。
下表說明 nodeSelector 物件的屬性:
| 屬性 | 說明 |
|---|---|
nodeSelector.apigeeData.key |
版本:1.0.0
預設值: ApigeeData 是 Cassandra 資料庫的節點。用於指定 Kubernetes 節點的節點選取器標籤鍵,可處理 Apigee 服務資料。 請參閱「設定專屬節點集區」。 |
nodeSelector.apigeeData.value |
版本:1.0.0
預設值: apigee-data 是 Cassandra 資料庫的節點。節點選取器標籤值,用於指定 Kubernetes 節點,以便處理 Apigee 服務資料。 請參閱「設定專屬節點集區」。 |
nodeSelector.apigeeRuntime.key |
版本:1.0.0
預設值: Apigee Runtime 是專案執行階段環境的節點。節點選取器標籤鍵,用於指定 Apigee 執行階段服務的 Kubernetes 節點。 請參閱「設定專屬節點集區」。 |
nodeSelector.apigeeRuntime.value |
版本:1.0.0
預設值:
請參閱「設定專屬節點集區」。 |
nodeSelector.requiredForScheduling |
版本:1.0.0
預設值:false
在正式版中, 請參閱「設定專屬節點集區」。 |
redis
下表說明 redis 物件的屬性:
| 屬性 | 說明 |
|---|---|
redis.auth.password |
推出版本:1.6.0
預設值: 必要 Redis 管理員的密碼。管理使用者可用於在 Redis 叢集上執行的任何管理活動。 |
redis.replicaCount |
推出版本:1.6.0
預設值: Redis 是複製儲存空間,這個屬性會指定做為 StatefulSet 的 Redis 節點數量。 |
redis.resources.requests.cpu |
推出版本:1.6.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
runtime
下表說明 runtime 物件的屬性:
| 屬性 | 說明 |
|---|---|
runtime.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
runtime.image.pullPolicy |
版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
runtime.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
runtime.image.url |
版本:1.0.0
預設值: 安裝圖片資源的網址,例如:
這項服務的 Docker 映像檔位置。 |
runtime.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
runtime.livenessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,到啟動存活探測作業之間的時間間隔 (以秒為單位)。 |
runtime.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
runtime.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
runtime.nodeSelector.key |
版本:1.0.0
預設值:無 選用節點選取器標籤鍵,用於指定 請參閱nodeSelector 屬性。 |
runtime.nodeSelector.value |
版本:1.0.0
預設值:無 指定 Kubernetes 節點的節點選取器標籤值,以用於 請參閱 設定專屬節點集區。 |
runtime.readinessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。 |
runtime.readinessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,啟動就緒探測作業前的秒數。 |
runtime.readinessProbe.periodSeconds |
版本:1.0.0
預設值: 決定執行準備狀態探測的頻率 (以秒為單位)。最小值為 1。 |
runtime.readinessProbe.successThreshold |
版本:1.0.0
預設值: 失敗後,至少要連續成功幾次,才算成功。最小值為 1。 |
runtime.readinessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
runtime.replicaCountMax |
版本:1.0.0
預設值: 自動調度資源功能可用的副本數量上限。 |
runtime.replicaCountMin |
版本:1.0.0
預設值: 可供自動調度資源的副本數量下限。 |
runtime.resources.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
runtime.resources.requests.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,單位為 MiB ( |
runtime.service.type |
版本:1.0.0
預設值: 服務類型。您可以將此項設為 ClusterIP 以外的服務,例如 |
runtime.targetCPUUtilizationPercentage |
版本:1.0.0
預設值: Pod 中執行階段程序的目標 CPU 使用率。這個欄位的值可讓執行階段在 CPU 使用率達到這個值時,自動調度資源至 |
runtime.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
synchronizer
確保訊息處理器與最新部署的 API Proxy 套件保持同步。為此,Synchronizer 會輪詢管理層;偵測到新合約時,Synchronizer 會將合約傳送至執行階段層。根據預設,Synchronizer 會將環境設定資料儲存在 Cassandra 中。
詳情請參閱「同步器」。
下表說明 synchronizer 物件的屬性:
| 屬性 | 說明 |
|---|---|
synchronizer.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
synchronizer.image.pullPolicy |
版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
synchronizer.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
synchronizer.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。 |
synchronizer.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
synchronizer.livenessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,到啟動存活探測作業之間的時間間隔 (以秒為單位)。 |
synchronizer.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
synchronizer.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
synchronizer.nodeSelector.key |
版本:1.0.0
預設值:無 必要 選用節點選取器標籤鍵,用於指定 請參閱 nodeSelector。 |
synchronizer.nodeSelector.value |
版本:1.0.0
預設值:無 選用的節點選取器標籤值,用於指定 Kubernetes 節點的 請參閱 nodeSelector。 |
synchronizer.pollInterval |
版本:1.0.0
預設值: Synchronizer 在輪詢作業之間等待的時間長度。同步器會輪詢 Apigee 控制平面服務,偵測並提取新的執行階段合約。 |
synchronizer.readinessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證完備性探測失敗的次數,再將 Pod 標示為「尚未準備就緒」。最小值為 1。 |
synchronizer.readinessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,啟動就緒探測作業前的秒數。 |
synchronizer.readinessProbe.periodSeconds |
版本:1.0.0
預設值: 決定執行準備狀態探測的頻率 (以秒為單位)。最小值為 1。 |
synchronizer.readinessProbe.successThreshold |
版本:1.0.0
預設值: 失敗後,至少要連續成功幾次,才算成功。最小值為 1。 |
synchronizer.readinessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
synchronizer.replicaCount |
版本:1.0.0
預設值: 自動調度資源的備用資源數量。 |
synchronizer.replicaCountMax |
推出版本:1.2.0
預設值: 自動調度資源的副本數量上限。 |
synchronizer.replicaCountMin |
推出版本:1.2.0
預設值: 自動調度資源的副本數量下限。 |
synchronizer.resources.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
synchronizer.resources.requests.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 GB 為單位。 |
synchronizer.serviceAccountPath |
版本:1.0.0
預設值:無 請提供 具有 Apigee Synchronizer Manager 角色的 Google 服務帳戶金鑰檔案路徑。 |
synchronizer.serviceAccountRef |
推出版本:1.2.0
預設值:無 請提供 |
synchronizer.targetCPUUtilizationPercentage |
版本:1.0.0
預設值:
Pod 中 Synchronizer 程序的目標 CPU 使用率。當 CPU 使用率達到這個欄位的值時,同步器就會自動調度資源,最多可調度至 |
synchronizer.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
udca
(通用資料收集代理程式) 定義在執行階段平面資料收集 Pod 中執行的服務。這項服務會擷取分析和部署狀態資料,並傳送至 Unified Analytics Platform (UAP)。
詳情請參閱「收集 Analytics 和部署狀態資料」。
下表說明 udca 物件的屬性:
| 屬性 | 說明 |
|---|---|
udca.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
udca.fluentd.image.pullPolicy |
版本:1.0.0
預設值: 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
udca.fluentd.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
udca.fluentd.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。 |
udca.fluentd.resources.limits.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源的記憶體限制,以 MiB 為單位。
|
udca.fluentd.resources.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
udca.fluentd.resources.requests.memory |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的記憶體,以 MiB 為單位。 |
udca.image.pullPolicy |
版本:1.0.0
預設值:IfNotPresent 決定 kubelet 何時提取 Pod 的 Docker 映像檔。可能的值包括:
詳情請參閱「更新圖片」。 |
udca.image.tag |
版本:1.0.0
預設值: 這項服務 Docker 映像檔的版本標籤。 |
udca.image.url |
版本:1.0.0
預設值: 這項服務的 Docker 映像檔位置。 |
udca.jvmXms |
版本:1.0.0
預設值: 資料收集 Pod JVM 的起始記憶體量。 |
udca.jvmXmx |
版本:1.0.0
預設值: 資料收集 Pod JVM 的記憶體分配上限。 |
udca.livenessProbe.failureThreshold |
版本:1.0.0
預設值: Kubernetes 會先驗證有效性探測失敗的次數,再重新啟動容器。最小值為 1。 |
udca.livenessProbe.initialDelaySeconds |
版本:1.0.0
預設值: 容器啟動後,到啟動存活探測作業之間的時間間隔 (以秒為單位)。 |
udca.livenessProbe.periodSeconds |
版本:1.0.0
預設值: 以秒為單位,決定執行 Liveness 探測的頻率。最小值為 1。 |
udca.livenessProbe.timeoutSeconds |
版本:1.0.0
預設值: 健康狀態探測作業逾時的秒數。最小值為 1。 |
udca.nodeSelector.key |
版本:1.0.0
預設值:無 必要 用於指定 請參閱 設定專屬節點集區。 |
udca.nodeSelector.value |
版本:1.0.0
預設值:無 必要 節點選取器標籤值,用於指定 請參閱 設定專屬節點集區。 |
udca.pollingIntervalInSec |
版本:1.0.0
預設值: UDCA 在輪詢作業之間等待的時間長度 (以秒為單位)。UDCA 會輪詢資料收集 Pod 檔案系統中的資料目錄,偵測要上傳的新檔案。 |
udca.replicaCountMax |
版本:1.0.0
預設值: 混合式可為 UDCA 部署項目自動新增的 Pod 數量上限。由於 UDCA 是以 ReplicaSet 形式實作,因此 Pod 是副本。 |
udca.replicaCountMin |
版本:1.0.0
預設值: UDCA 部署項目的 Pod 數量下限。由於 UDCA 是以 ReplicaSet 形式實作,因此 Pod 是副本。 如果 CPU 使用率超過 |
udca.resources.requests.cpu |
版本:1.0.0
預設值: Kubernetes 容器中資源正常運作所需的 CPU,以毫核心為單位。 |
udca.revision |
推出版本:1
預設值: 在標籤中填入的靜態值,可啟用 Canary 部署。 |
udca.serviceAccountPath |
版本:1.0.0
預設值:無 請提供 具有 Apigee Analytics Agent 角色的 Google 服務帳戶金鑰檔案路徑。 |
udca.serviceAccountRef |
推出版本:1.2.0
預設值:無 請提供 |
udca.targetCPUUtilizationPercentage |
版本:1.0.0
預設值: Pod 數量的資源調度 CPU 使用率門檻,以可用 CPU 資源總數的百分比表示。混合模式會使用資料收集 Pod (fluentd 和 UDCA) 中所有容器的合併使用率,計算目前的使用率。 如果 CPU 使用率超過這個值,混合式自動調度資源功能就會逐步增加 ReplicaSet 中的 Pod 數量,最多可達 |
udca.terminationGracePeriodSeconds |
版本:1.0.0
預設值: 要求刪除 Pod 與終止 Pod 之間的時間 (以秒為單位)。在這段期間,系統會執行所有前置停止勾點,且所有執行中的程序都應正常終止。 |
virtualhosts
virtualhosts 屬性是必要的設定屬性。
虛擬主機可讓 Apigee Hybrid 處理指定環境群組的 API 要求。
詳情請參閱「設定虛擬主機」。
下表說明 virtualhosts 物件的屬性:
| 屬性 | 說明 |
|---|---|
virtualhosts[].additionalGateways |
推出版本:1.2.0
預設值:無 要將流量轉送至的 Istio 閘道清單。 |
virtualhosts[].name |
推出版本:1.2.0
預設值:無 必要 虛擬主機的名稱。 |
virtualhosts[].hostAliases[] |
推出版本:1.2.0
預設值:無 必要 Deprecated:從 Hybrid 1.4 版開始,執行階段平面會從管理平面接收這項資訊。請參閱「關於環境和環境群組」。 |
virtualhosts[].maxTLSProtocolVersion |
版本:1.3.0
預設值:無 Envoy 可選取的 TLS 通訊協定最高版本。Envoy 會自動在 值必須是數字。例如:
virtualhosts:
- name: default
maxTLSProtocolVersion: "1.3"
其中數字代表 TLS 版本號碼,格式為 另請參閱 Istio 說明文件中的
|
virtualhosts[].minTLSProtocolVersion |
版本:1.3.0
預設值:無 Envoy 可選取的 TLS 通訊協定最低版本。Envoy 會自動在 值必須是數字。例如:
virtualhosts:
- name: default
minTLSProtocolVersion: "1.2"
其中數字代表 TLS 版本號碼,格式為 另請參閱 Istio 說明文件中的
|
virtualhosts[].selector |
推出版本:1.2.0
預設值: 必要 鍵/值選擇器值組,用於指向不同的 Ingress 選擇器。 |
virtualhosts[].sslCertPath |
推出版本:1.2.0
預設值:無 必須提供
系統中傳輸層安全標準 (TLS) 憑證檔案的路徑。 |
virtualhosts[].sslKeyPath |
推出版本:1.2.0
預設值:無 必須提供
系統中 TLS 私密金鑰檔案的路徑。 |
virtualhosts[].sslSecret |
推出版本:1.2.0
預設值:無 請提供
儲存在 Kubernetes 密鑰中的檔案名稱,該檔案包含 TLS 憑證和私密金鑰。您必須使用 TLS 憑證和金鑰資料做為輸入內容,建立密鑰。 另請參閱:
|
watcher
watcher 屬性是必要的設定屬性。
監控程序會監控設定變更,並觸發應用程式至執行階段平面。
下表說明 watcher 物件的屬性:
| 屬性 | 說明 |
|---|---|
watcher.annotations |
導入版本:1.5.0
預設值:無 用於註解 Pod 的選用鍵/值對應。詳情請參閱自訂註解。 |
watcher.replicaCountMax |
版本:1.3.0
預設值: 監控程式副本數量上限。為避免發生衝突,請將此值設為
|
watcher.replicaCountMin |
版本:1.3.0
預設值: 監控程式副本數量下限。 |
watcher.serviceAccountPath |
版本:1.3.0
預設值:無 必要。 具有「Apigee 執行階段代理程式」角色的 Google 服務帳戶金鑰檔案路徑。 |
watcher.serviceAccountRef |
版本:1.3.0
預設值:無 必須提供 serviceAccountPath 或 serviceAccountRef 其中之一。 |