管理執行階段層元件

本主題說明如何設定及管理 Apigee Hybrid 執行階段平面元件。

關於覆寫檔案

首次在叢集中安裝混合式執行階段時，您必須建立設定覆寫檔案。您可以在這個檔案中提供安裝 Hybrid 時所需的必要屬性值，例如 Google 專案名稱、機構名稱、環境詳細資料和憑證檔案等。您也可以在覆寫檔案中，覆寫大多數混合式元件的特定預設值。如需可設定屬性的完整清單，請參閱設定屬性參考資料。

混合式 安裝步驟會逐步說明如何建立覆寫檔案，並將設定套用至叢集。如要變更設定，請修改您建立的覆寫檔案，然後重新套用。請參閱「變更設定」。

變更設定

如要變更混合式執行階段平面元件的設定，請編輯覆寫檔案，然後使用 apigeectl 套用變更。如需可設定屬性的完整清單，請參閱「設定屬性參考資料」。

舉例來說，如要啟用 logger 元件，請更新覆寫檔案並重新套用：

  1. 開啟覆寫檔案。請務必使用將混合式執行階段安裝至叢集時所用的覆寫檔案。
  2. 找出檔案中的 logger 元素。例如： 
    ...
logger:
  enabled: false
...
  3. 將屬性值變更為 true： 
    ...
  logger:
  enabled: true
...
  4. 使用 apigeectl 將變更套用至叢集： 
    $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry

    --telemetry 標記會告知 apigeectl 只更新記錄器元件。如要瞭解範圍參數 (例如 --telemetry)，請參閱「適用於套用 apigeectl 的範圍」。

您可以修改哪些設定屬性？

如需可設定屬性的完整清單，請參閱「設定屬性參考資料」。 參考資料只會列出可修改的屬性；如果您嘗試修改參考資料中沒有的屬性，系統會忽略該變更。

如何使用設定參照

設定屬性參照使用點記號表示法來描述設定元素，其中第一個項目是頂層元素名稱，後面接著屬性和子項屬性。例如：

authz.image.pullPolicy

在覆寫檔案中，屬性會以正確的 YAML 格式設定。以上述範例來說，頂層 authz 元素會向左縮排，子元素屬性則會縮排至該元素下方。此外，YAML 規定每個元素和子元素結尾都必須加上半形冒號。

舉例來說，如要將 authz.image.pullPolicy 屬性設為 Always，請在覆寫檔案中找出這個 YAML 節，然後設定如下：

authz:
  image:
    pullPolicy: Always

再舉一例，屬性 cassandra.auth.admin.password (如設定屬性參考資料中所列) 用於設定 Cassandra 管理員密碼。如要變更，請在覆寫檔案中找出下列 YAML，並依下列方式設定：

cassandra:
  auth:
    admin:
      password: abc123

請注意，設定屬性參考資料說明瞭您可以在混合式執行階段平面元件上設定的所有屬性。請按照上述模式修改覆寫檔案中的這些元素，然後再將變更套用至叢集。

關於設定預設值

Apigee 會在 $HYBRID_FILES/config/values.yaml 檔案中保留預設元件設定。這個檔案會盡可能為每個混合元件指定預設值。

覆寫檔案的 YAML 結構與 values.yaml 相同，但覆寫檔案只包含 values.yaml 中的部分設定屬性。請注意，並非所有屬性都能編輯。將設定套用至叢集時，系統會合併覆寫項目和預設值，建立完整的 Kubernetes 叢集設定。

使用預先定義的樣本覆寫檔案

Apigee 提供一組範例覆寫檔案，協助您設定混合式部署作業。建議您複製並修改最符合安裝需求的覆寫檔案。

目錄 $APIGEECTL_HOME/examples 包含下列範例：

範例覆寫檔案 說明
overrides-small.yaml 這個範例非常適合快速上手。這項工具會使用建議的最小足跡，啟動混合式執行階段元件。這個範例設定盡可能採用預設設定和值。所有副本數量下限都設為 1。
overrides-medium.yaml 這個範例是測試和品質保證環境的良好起點。個別元件已獲得更高層級的資源，可處理額外流量。Cassandra 使用 SSD 磁碟來提升效能。在這個環境中，建議使用者在不同節點上安裝有狀態和無狀態元件。請參閱 設定專用節點。
overrides-large.yaml 這個範例是前置製作和製作等高效能環境的良好起點。範例包含設定加密金鑰、密碼等屬性。個別元件至少有兩個副本。
private-overrides.yaml 本範例說明如何使用私人映像檔存放區中的映像檔。請參閱「使用私人映像檔存放區」。

自訂註解

註解是鍵/值對應，用於將中繼資料附加至 Kubernetes Pod。您可以為「設定屬性參考資料」中列出的下列混合式元件屬性建立自訂註解：

如要新增自訂名稱/值對註解，請開啟覆寫檔案，為相應元件新增 annotations 節，然後使用 apigeectl 套用變更。例如：

runtime:
  annotations:
    businessunit: "bu1"

使用模擬測試來測試設定變更

您可以使用 --dry-run 標記和 apigeectl，測試覆寫設定檔，而不必實際套用至叢集。這個選項可顯示將套用至叢集的內容，因此有助於偵錯安裝問題。

在 Apigee Hybrid 中，--dry-run 旗標的語法取決於您執行的 kubectl 版本。使用下列指令檢查 kubectl 版本：

kubectl version

kubectl 1.17 版和舊版：

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl 1.18 以上版本：

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

視需要建立多個覆寫檔案

您可以建立多個覆寫檔案，每個檔案都符合特定需求。舉例來說，您可能有一個覆寫檔案用於調整叢集以供正式環境使用，另一個則用於建立叢集以供測試。然後在原始碼控管系統中維護這些檔案。

使用 apigeectl apply 指令，將覆寫檔案套用至叢集。例如：

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

刪除執行階段元件

apigeectl delete 指令提供多個標記，可供您刪除所有或部分已安裝的 Hybrid 執行階段元件。如要瞭解指令用法詳情，請參閱 apigeectl 參考頁面。另請參閱「解除安裝 Hybrid 執行階段」。

可刪除環境

如要徹底刪除環境，您必須移除執行階段 (本機) 和管理 (雲端) 層面。詳情請參閱「刪除環境」。