asmcli 參考資料

本頁面說明 asmcli 的可用引數。

選項

找出叢集 您可以透過下列選項找出叢集：

僅限 GKE

-p|--project_id CLUSTER_PROJECT_ID
叢集建立所在的專案 ID。
-n|--cluster_name CLUSTER_NAME
叢集名稱。
-l|--cluster_location CLUSTER_LOCATION
叢集建立所在的區域 (適用於單一可用區叢集) 或地區 (適用於區域叢集)。

所有平台

--kubeconfig KUBECONFIG_FILE kubeconfig 檔案的完整路徑。環境變數 $PWD 在這裡無法運作。

--ctx|--context KUBE_CONTEXT 要使用的 kubeconfig 內容。如未指定，asmcli 會使用預設內容。

-c|--ca {mesh_ca|gcp_cas|citadel}

用於管理雙向 TLS 憑證的憑證授權單位 (CA)。指定 mesh_ca 使用 Cloud Service Mesh 憑證授權單位 (Cloud Service Mesh 憑證授權單位)、gcp_cas 使用憑證授權單位服務，或 citadel 使用 Istio CA。代管 Cloud Service Mesh 不支援 Istio CA。詳情請參閱下列資訊：

--co|--custom_overlay OVERLAY_FILE

使用 --custom_overly 和 YAML 檔案 (稱為「疊加檔案」) 的名稱，其中包含 IstioOperator 自訂資源，可設定叢內控制層。您指定疊加檔案來啟用預設未啟用的功能。代管 Cloud Service Mesh 不支援 IstioOperator API，因此您無法使用 --custom_overlay 設定代管控制層。asmcli 必須能夠找到疊加檔案，因此該檔案必須與 asmcli 位於同一目錄，或是您可以指定相對路徑。如要新增多個檔案，請指定 --co|--custom_overlay 和檔案名稱，例如：--co overlay_file1.yaml --co overlay_file2.yaml --co overlay_file3.yaml

--hub-registration-extra-flags HUB_REGISTRATION_EXTRA_FLAGS

如果使用附加的 Amazon EKS 叢集，請使用 --hub-registration-extra-flags 將叢集註冊至機群 (如果尚未註冊)。

-k|--key_file FILE_PATH

服務帳戶的金鑰檔案。如果未使用服務帳戶，請省略這個選項。

--network_id NETWORK_ID

使用 --network_id 設定套用至 istio-system 命名空間的 topology.istio.io/network 標籤。如果是 GKE，--network_id 預設為叢集的網路名稱。其他環境則會使用 default。

-o|--option OVERLAY_FILE

疊加檔案的名稱 (不含 .yaml 副檔名)。asmcli 會從 anthos-service-mesh 存放區下載這個檔案，以啟用選用功能。必須連上網際網路才能使用「--option」，--option 和 --custom_overlay 選項類似，但行為略有不同：

  • 如要變更疊加層檔案中的設定，請使用 --custom_overlay。

  • 使用 --option 啟用不需要變更疊加層檔案的功能，例如設定服務的稽核政策。

如要新增多個檔案，請指定 -o|--option 和檔案名稱，例如：-o option_file1 -o option_file2 -o option_file3

-D|--output_dir DIR_PATH

如未指定，asmcli 會建立臨時目錄，並在其中下載安裝 Cloud Service Mesh 所需的檔案和設定。指定 --output-dir 旗標，改為指定要使用的目錄相對路徑。完成後，指定目錄會包含 asm 和 istio-1.29.5-asm.12 子目錄。asm 目錄包含安裝設定。istio-1.29.5-asm.12 目錄包含安裝檔案的解壓縮內容，內含 istioctl、範例和資訊清單。如果您指定 --output-dir，且目錄已包含必要檔案，asmcli 會使用這些檔案，而不是再次下載。

--platform PLATFORM {gcp|multicloud}

Kubernetes 叢集的平台或供應商。預設值為 gcp (適用於 GKE 叢集)。如要使用其他平台，請multicloud。

-r|--revision_name REVISION NAME

修訂版本標籤是控制層上設定的鍵/值組合。修訂版本標籤鍵一律為 istio.io/rev。依預設，asmcli 會根據 Cloud Service Mesh 版本設定修訂版本標籤的值，例如：asm-1295-12。如要覆寫預設值並指定自己的值，請加入這個選項。REVISION NAME 引數必須是 DNS-1035 標籤。也就是說，名稱必須：

  • 不得超過 63 個半形字元
  • 只能包含小寫英數字元或「-」
  • 以英文字母開頭
  • 結尾為英數字元

用於驗證的規則運算式為：'[a-z]([-a-z0-9]*[a-z0-9])?'

-s|--service_account ACCOUNT
用於安裝 Cloud Service Mesh 的服務帳戶名稱。如未指定，則會使用目前 gcloud 設定中的有效使用者帳戶。如要變更使用中帳戶，請執行 gcloud auth login。

Istio CA 自訂憑證的選項

如果您指定 --ca citadel 並使用自訂 CA，請加入下列選項：

  • --ca_cert FILE_PATH：中繼憑證
  • --ca_key FILE_PATH：中繼憑證的金鑰
  • --root_cert FILE_PATH：根憑證
  • --cert_chain FILE_PATH：憑證鏈結

詳情請參閱「插入現有 CA 憑證」。

啟用旗標

以 --enable 開頭的旗標可讓 asmcli 啟用必要的 Google API、設定必要的 Identity and Access Management (IAM) 權限，以及更新叢集。或者，您也可以在執行 asmcli 前，自行更新專案和叢集。所有啟用旗標都與 asmcli validate 不相容。如果您在執行 asmcli validate 時指定啟用旗標，指令會終止並顯示錯誤。

-e|--enable_all
允許 asmcli 執行下列所有個別啟用動作。
--enable_cluster_roles
允許 asmcli 嘗試將執行 asmcli 的 Google Cloud 使用者或服務帳戶繫結至叢集中的cluster-admin角色。asmcli 會根據 gcloud config get core/account 指令判斷使用者帳戶。如果您使用使用者帳戶在本機執行 asmcli，請務必先呼叫 gcloud auth login 指令，再執行 asmcli。如要變更使用者帳戶，請執行 gcloud config set core/account GCP_EMAIL_ADDRESS 命令，其中 GCP_EMAIL_ADDRESS 是您用來登入 Google Cloud的帳戶。
--enable_cluster_labels
允許 asmcli 設定必要的叢集標籤。
--enable_gcp_components

允許 asmcli 啟用下列必要 Google Cloud 受管理 Google Cloud 服務和元件：

--enable_gcp_apis

允許 asmcli 啟用所有必要的 Google API。

--enable_gcp_iam_roles

允許 asmcli 設定必要的 IAM 權限。

--enable_meshconfig_init

允許指令碼代您初始化 meshconfig 端點。--enable_gcp_components 和 --managed 隱含。

--enable_namespace_creation

允許 asmcli 建立根 istio-system 命名空間。

--enable_registration

允許 asmcli 向叢集所在的專案註冊叢集。如果未提供這個標記，請按照「註冊叢集」一文中的步驟，手動註冊叢集。請注意，與其他啟用旗標不同，只有在指定需要叢集註冊的選項 (例如 --option hub-meshca) 時，--enable_registration 才會納入 --enable_all。否則，您必須另外指定這個旗標。

其他旗標

--dry_run
列印指令，但不執行。
--fleet_id
使用機群的主機專案 ID，向機群註冊叢集。如果不是Google Cloud 叢集，就必須設定這個旗標。如未提供叢集，則預設為叢集的專案 ID。Google Cloud 您可以在安裝前執行 asmcli install 和 --fleet_id，也可以傳遞 --enable-registration 和 --fleet-id 旗標，在安裝期間執行。設定完成後即無法變更。
--managed
佈建遠端代管控制層，而非在叢集中安裝控制層。
--offline
使用輸出目錄中預先下載的套件，執行離線安裝。如果未指定目錄或目錄不含必要檔案，指令碼會結束並顯示錯誤。
--only_enable
執行指定步驟來設定目前的使用者/叢集，但不會安裝任何項目。
--only_validate
執行驗證，但不要更新專案或叢集，也不要安裝 Cloud Service Mesh。這個標記與啟用標記不相容。如果您使用任何啟用旗標指定 --only_validate，asmcli 會以錯誤終止。
--print_config
不要安裝 Cloud Service Mesh，而是將所有已編譯的 YAML 列印到標準輸出 (stdout)。所有其他輸出內容都會寫入標準錯誤 (stderr)，即使這些內容通常會寫入 stdout 也是如此。指定此旗標時，asmcli 會略過所有驗證和設定。
--disable_canonical_service
根據預設，asmcli 會將標準服務控制器部署至叢集。如不想讓 asmcli 部署控制器，請指定 --disable_canonical_service。詳情請參閱「啟用及停用標準服務控制器」。
-h|--help
顯示說明訊息，說明選項和標記，然後結束。
--use_managed_cni
使用受管理 CNI。如果未傳遞這個旗標，asmcli 會套用靜態 CNI 資訊清單。
--use_vpcsc
專案不再需要這個標記，即可使用 VPC Service Controls。
-v|--verbose
執行時，會列印下一個要執行的指令。asmcli使用 --verbose 旗標時，asmcli 也會在執行後列印指令。
--version
列印 asmcli 版本並結束。如果沒有最新版本，請下載最新版 asmcli_1.29。

後續步驟