apigeectectl

apigeectl 是指令列介面 (CLI)，用於在 Kubernetes 叢集中安裝及管理 Apigee Hybrid。如要瞭解如何下載及安裝 apigeectl，請參閱「下載並安裝 apigeectl」。

適用範圍 apigeectl

使用 apigeectl 旗標，即可控管指令要將設定變更套用至哪些範圍。如要瞭解 Apigee Hybrid 執行階段中的範圍總覽，請參閱「執行階段服務設定總覽」。

範圍元件apigeectl 旗標
儲存空間 Cassandra ‑‑datastore
記憶體內儲存空間 Redis ‑‑redis
環境 執行階段
同步器
UDCA		 ‑‑all‑envs
‑‑env
機構 Apigee Connect 代理程式
MART
監控程式		 ‑‑org
報告 記錄器
指標		 ‑‑telemetry

apigeectl 語法

apigeectl [command] [flags]

其中：

  • command：指定要執行的作業。如需完整指令清單，請參閱「apigeectl 指令」。

  • flags：指定指令參數。如需完整旗標清單，請參閱 apigeectl 旗標。

apigeectl 指令

下表列出 apigeectl 指令：

指令 說明
apply

將 Apigee Hybrid 執行階段元件的設定套用至 Kubernetes 叢集。

apigeectl apply，系統會將變更套用至叢集中的所有元件。

apigeectl 旗標： ‑‑all‑envs、‑‑datastore、‑‑dry‑run、‑‑env、‑f、‑‑file‑override‑config、‑‑help、‑‑org、‑‑print‑yaml、‑‑redis、‑‑settings virtualhosts、‑‑telemetry、‑‑v
check‑ready

檢查混合元件 Pod 的狀態。所有元件 Pod 準備就緒後，系統會輸出「All containers ready」訊息。如要自動編寫指令碼，請注意，當所有容器都準備就緒時，指令會以狀態 0 結束。如果至少有一個 Pod 尚未就緒，指令會以狀態 1 結束。

apigeectl 旗標： ‑f、 ‑‑file‑override‑config、‑‑help、‑‑v

delete

從叢集中刪除混合式元件。使用 ‑‑all 旗標移除所有元件。如果省略 ‑‑all，系統只會移除 Apigee 專屬元件 (不會刪除使用 apigeectl init 安裝的元件)。Apigee 專屬元件是透過 apply 指令安裝的元件。

apigeectl delete (不含任何選用標記) 會將 delete 指令套用至叢集中部署的所有元件。

apigeectl diagnostic delete ‑f OVERRIDES_FILE 刪除 apigeectl diagnostic 建立的 apigee‑diagnostic 命名空間。‑f / ‑‑file‑override‑config 旗標必須搭配 apigeectl diagnostic delete

apigeectl 旗標： ‑‑all、‑‑all‑envs、‑‑datastore、‑‑env、‑f、‑‑file‑override‑config、‑‑help、‑‑org、‑‑redis、‑‑telemetry、‑‑v

詳情請參閱「解除安裝 Hybrid 執行階段」。
diagnostic

呼叫診斷收集器，視需求擷取 Apigee Hybrid 執行個體 Kubernetes 元件的診斷資料，並將資料儲存在 Google Cloud Storage 值區。

診斷資訊收集器需要具名的 Google Cloud Storage bucket、具有儲存空間管理員角色的服務帳戶，以及新增至 overrides 檔案的 diagnostic: 節。請參閱：

您叫用診斷資訊收集器時，系統會建立「apigee‑diagnostic」Kubernetes 命名空間。您必須先刪除這個檔案，才能再次叫用診斷收集器。apigeectl diagnostic delete

叫用診斷收集器： 

apigeectl diagnostic ‑f OVERRIDES_FILE

刪除診斷收集器： 

apigeectl diagnostic delete ‑f OVERRIDES_FILE

apigeectl 旗標： ‑‑file‑override‑config

encode

傳回指定機構或指定機構內指定環境的所有 ApigeeDeployment 編碼名稱清單。編碼名稱包含元件名稱、機構的雜湊名稱，以及 (如果使用 ‑‑env 旗標) 環境的雜湊名稱。Apigee Hybrid 會建立機構和環境的雜湊名稱，避免命名空間衝突。

您必須使用 ‑‑org org‑name，或同時使用 ‑‑org org‑name 和 ‑‑env env‑name 旗標，並搭配 encode。例如：

./apigeectl encode ‑‑org hybrid‑example
List of ApigeeDeployments are:
  apigee‑connect‑agent‑hybrid‑example‑6a82f8a
  apigee‑mart‑hybrid‑example‑6a82f8a
  apigee‑watcher‑hybrid‑example‑6a82f8a
 
./apigeectl encode ‑‑org hybrid‑example ‑‑env example‑env
List of ApigeeDeployments are:
  apigee‑runtime‑hybrid‑example‑example‑env‑9e87e2d
  apigee‑synchronizer‑hybrid‑example‑example‑env‑9e87e2d
  apigee‑udca‑hybrid‑example‑example‑env‑9e87e2d

apigeectl 旗標： ‑‑env, ‑‑org

help 列印線上說明。
init

在 apigee‑system 命名空間中安裝 Apigee Operator 和 CRD。

全新安裝或升級後，請先執行 apigeectl init，再執行 apigeectl apply。

apigeectl 旗標： ‑f、 ‑‑file‑override‑config、‑‑help、‑‑v

version 列印 CLI 版本資訊。

apigeectl 旗標： ‑‑help

apigeectl 旗標

下表列出 apigeectl 旗標：

標記 說明
‑‑all delete only：從叢集中刪除整個 Apigee Hybrid 安裝項目，但 ASM (Istio) 和 cert-manager 除外。
‑‑all‑envs

將 apigeectl 指令套用至覆寫設定檔中指定的機構單位下所有環境。
‑‑datastore

將設定套用至資料儲存庫範圍 (Cassandra)。
‑‑dry‑run 執行指定指令，但不變更叢集。搭配 ‑‑print‑yaml 使用，將算繪的物件規格輸出至檔案。

請根據您執行的 kubectl 版本，搭配下列其中一個值使用 ‑‑dry‑run。使用 gcloud version 檢查 kubectl 版本：

  • kubectl 1.17.x 版或更舊版本：‑‑dry‑run=true
  • kubectl 1.18.x 以上版本：‑‑dry‑run=client
‑‑env env‑name

將設定套用至指定環境。這個標記會將設定套用至環境範圍元件 apigee‑runtime、apigee‑synchronizer 和 apigee‑udca。

‑‑env 必須與 ‑‑org 旗標搭配使用。例如： 

apigeectl apply ‑‑org hybrid‑example ‑‑env example‑env \
      ‑f overrides/overrides.yaml
‑f
‑‑file‑override‑config		 指定包含混合式部署自訂設定屬性的 YAML 檔案。預設值為 ./overrides.yaml。使用 apply、check‑ready、delete 和 init 指令時，必須提供覆寫檔案。

您必須使用這個標記指定完整路徑。詳情請參閱「管理執行階段層元件」。
‑h
‑‑help		 顯示指令說明。
‑‑org

將設定套用至指定機構。這個標記會將設定套用至機構範圍元件 apigee‑connect‑agent、apigee‑mart 和 apigee‑watcher。
‑‑print‑yaml 將設定範本輸出內容列印至標準輸出。如需使用這個標記的範例，請參閱「將設定列印至檔案」。
‑‑redis

將設定套用至記憶體內資料儲存範圍 (Redis)。
‑‑restore

將 Cassandra 還原至先前儲存的快照，該快照由 overrides.yaml 檔案的 restore 設定中的 snapshotTimestamp 屬性指定。備份檔會根據 overrides.yaml 檔案中的 backup 設定，從 Cloud Storage 值區或遠端伺服器還原。詳情請參閱「從備份還原區域」。
‑s
‑‑settings virtualhosts

指定指令適用的設定。目前僅支援 virtualhosts 設定，這是 runtime 元件的一部分。如果您變更 virtualhosts 屬性，但沒有變更其他任何項目，請使用這個旗標。

舉例來說，如果您在覆寫檔案中變更 virtualhosts 設定，請使用下列指令將變更套用至叢集：

apigeectl apply ‑f my‑overrides.yaml ‑‑settings virtualhosts \
    ‑‑org example‑org ‑‑env example‑env
‑‑telemetry

為遙測元件 (例如 apigee‑logger 和 apigee‑metrics) 套用設定。
‑‑v int

將詳細記錄列印至標準錯誤。int 是一個整數，用於設定詳細程度。int 必須搭配 ‑‑v 使用。這個選項的行為與 kubectl ‑‑v 選項相同。

注意：這個選項會取代已淘汰的 ‑‑verbose 選項。

範例

初始化叢集設定

使用 init，將必要元件設定套用至叢集。您必須先執行 init 指令，再執行 apply 指令。

apigeectl init ‑f my_overrides.yaml

套用叢集設定

如要將混合式設定套用至 Kubernetes 叢集，請使用 apply 指令。第一次執行 apply 時，系統會在叢集中建立所有混合式執行階段元件。如果變更設定，請重新執行 apply，只套用變更，或使用標記，只對特定範圍套用變更。

下列範例會將混合式執行階段平面元件的設定套用至叢集：

apigeectl apply ‑f my_overrides.yaml

為單一元件套用設定

如要將 apply 指令限制為特定元件，請使用 apigeectl 標記中所述的標記。

下列範例只會套用 Cassandra 元件的設定：

apigeectl apply ‑‑datastore ‑f my_overrides.yaml

將設定列印到檔案

如要偵錯安裝問題，請將整個叢集設定列印到檔案，以便檢查設定。‑‑print‑yaml 標記會將混合式設定列印至 stdout，而 ‑‑dry‑run 標記則允許指令執行，但不會對叢集進行任何變更。

apigeectl apply ‑f my_overrides.yaml ‑‑dry‑run=client ‑‑print‑yaml > apigee‑hybrid.yaml

檢查 Pod 狀態

以下範例會檢查部署至叢集的 Pod 狀態：

apigeectl check‑ready ‑f overrides/overrides.yaml
All containers ready in namespace 'my-namespace'

從叢集刪除混合式設定

詳情請參閱「解除安裝 Hybrid 執行階段」。