設定屬性參考資料

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

篩選這個頁面

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

螢幕   本頁的設定屬性。

頂層屬性

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

屬性 類型 說明
axHashSalt 進階

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

預設值: iloveapis123

選用

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

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

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

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

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

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

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

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

預設值: none

必要

Google Cloud 專案的 ID。可搭配 k8sClusterName (已淘汰) 和 gcpRegion (已淘汰) 使用,用於識別專案,並決定 apigee-loggerapigee-metrics 將資料推送至何處。

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

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

預設值: us-central1

必要

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

hub 進階 這項功能已在以下版本推出:1.11.0

預設值:

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

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

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

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

hub: private-docker-host.example.com

為:

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

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

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

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

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

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

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

預設值:

已將 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 密鑰名稱。請參閱「資料加密」一節。

multiOrgCluster 進階 推出版本:1.10.0

預設值: false

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

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

預設值: apigee

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

org 基本

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

預設值:

必要

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

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

預設值: true

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

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

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

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

另請參閱:udca

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

預設值: "1112" (您的 Apigee Hybrid 版本,不含句點。例如,版本 1.11.0 的預設值為 "1110")。

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

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

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

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

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

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

預設值: true

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

另請參閱 org

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

預設值: true

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

另請參閱 gcpProjectID

ao

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

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

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

預設值: true

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

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

預設值: true

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

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.11.2

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

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

預設值:

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

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

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.11.2

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

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

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

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

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

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

預設值: 250m

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

ao.resources.limits.memory 進階 這項功能已在以下版本推出:1.2.0

預設值: 256Mi

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

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

預設值: 250m

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

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

預設值: 256Mi

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

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

預設值:

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

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

預設值:

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

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

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

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

預設值: "Equal"

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

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

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

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

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

預設值:

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

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

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

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

預設值:

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

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

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

apigeeIngressGateway

為 Apigee Hybrid 設定 Apigee 入口閘道。使用 apigeeIngressGateway 屬性,將一般設定套用至所有 Apigee 入口網關的例項。

請參閱 ingressGateways,瞭解如何設定個別例項。

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

下表說明 apigeeIngressGateway 物件的屬性:

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

預設值: IfNotPresent

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

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

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

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

預設值: 1.18.7-asm.26-distroless

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

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

預設值:

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

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

apigeeIngressGateway.nodeSelector.key 進階 這項功能已在以下版本推出:1.11.0

預設值:

必要

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

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

apigeeIngressGateway.nodeSelector.value 進階 這項功能已在以下版本推出:1.11.0

預設值:

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

請參閱 nodeSelector

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

預設值: 4

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

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

預設值: 2

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

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

預設值: 75

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

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

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

apigeeIngressGateway.tolerations.effect 進階 這項功能已在以下版本推出:1.11.0

預設值:

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

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

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

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

apigeeIngressGateway.tolerations.key 進階 這項功能已在以下版本推出:1.11.0

預設值:

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

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

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

apigeeIngressGateway.tolerations.operator 進階 這項功能已在以下版本推出:1.11.0

預設值: "Equal"

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

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

  • Equal 會與