管理執行階段層元件

本主題說明如何設定及管理 Apigee 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 檔案中維護預設元件設定。此檔案會盡可能為每個混合式元件指定預設值。

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

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

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

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

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

自訂註解

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

如要新增自訂名稱/值對註解，請開啟覆寫檔案，然後為相應元件新增 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 指令提供標記，可讓您刪除已安裝的混合式執行階段元件全部或部分。如需指令使用方式的詳細資訊，請參閱 apigeectl 參考資料頁面。另請參閱「解除安裝 Hybrid 執行階段」。

可刪除環境

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