本頁面概略介紹 Google Cloud CLI,以及常見的指令模式和功能。
什麼是 gcloud CLI?
Google Cloud CLI 是一套工具,可用於建立及管理Google Cloud 資源。無論是透過指令列、指令碼或其他自動化程序,您都能使用這些工具執行許多常見的平台工作。
舉例來說,您可以使用 gcloud CLI 建立及管理下列項目:
- Compute Engine 虛擬機器執行個體和其他資源
- Cloud SQL 執行個體
- Google Kubernetes Engine 叢集
- Managed Service for Apache Spark 叢集和作業
- Cloud DNS 代管區域和記錄集
- Cloud Deployment Manager 部署作業
您也可以使用 gcloud CLI 部署 App Engine 應用程式、管理驗證、自訂本機設定,以及執行其他工作。
下載並安裝 gcloud CLI
目前的 gcloud CLI 版本為 588.0.0。
我們強烈建議使用目前版本的 gcloud CLI,但您也可以從下載封存下載並安裝舊版。
如果您使用 Cloud Shell,系統會自動提供 gcloud CLI,因此不需要安裝。否則,請下載並安裝 gcloud CLI,然後初始化。
根據預設,gcloud CLI 會安裝正式發布版層級的指令。gcloud CLI 元件 (名稱為 alpha、beta 和 preview) 提供額外功能。透過這些元件,您可以搭配 gcloud CLI 使用 Bigtable、Dataflow,以及其他尚未正式發布的 Google Cloud 服務。
gcloud CLI 一覽表
如要快速瞭解 gcloud CLI、查看常用指令清單,以及瞭解這些指令的結構,請參閱 gcloud CLI 一覽表。
版本層級
gcloud CLI 指令有下列版本層級:
| 版本層級 | 標籤 | 描述 |
|---|---|---|
| 正式發行版 | 無 | 指令能夠穩定運作且可用於正式版本。如要提前瞭解會破壞目前功能的指令異動,請參閱版本資訊。 |
| 預覽 | preview |
指令屬於預先發布版層級,用於收集顧客意見回饋。預先發布版通常會公開發布,但不一定具備完整功能,而且不提供相關的服務水準協議或技術支援。除非 Google 另行聲明,否則預先發布版僅適用於測試環境。預先發布版測試階段平均會持續約六個月。 |
| Beta 版 | beta |
指令功能完整,但仍可能有一些未解決的問題。這些指令如有重大變更,恕不另行通知。 |
| Alpha 版 | alpha |
指令為早期版本,且未來可能有所異動,而不另行通知。 |
安裝 gcloud CLI 時,系統預設不會安裝 alpha、beta 和 preview 元件。您必須使用 gcloud components install 指令分別安裝這些元件。如果您嘗試執行 Alpha 版、Beta 版或預覽版指令,但未安裝對應元件,gcloud CLI 會提示您安裝。
指令群組
在每個發布層級中,gcloud CLI 指令會整理成指令群組的巢狀階層,每個指令群組代表 Google Cloud 的產品或功能,或是功能子群組。
例如:
| 指令群組 | 描述 |
|---|---|
gcloud compute |
正式發布的 Compute Engine 相關指令 |
gcloud compute instances |
與正式發布的 Compute Engine 執行個體相關的指令 |
gcloud beta compute |
Beta 版中和 Compute Engine 相關的指令。 |
gcloud preview |
與「預覽」相關的指令 Google Cloud |
gcloud alpha app |
Alpha 版中與管理 App Engine 部署相關的指令。 |
執行 gcloud CLI 指令
您可以透過指令列,以及指令碼和其他自動化程序執行 gcloud CLI 指令,例如使用 Jenkins 自動執行 Google Cloud 工作。
屬性
gcloud CLI 屬性是會影響 gcloud CLI 工具行為的設定。其中部分屬性可透過全域或指令選項設定,在這種情況下,選項設定的值會優先採用。
啟用無障礙功能
如要享有更精簡流暢的螢幕閱讀器體驗,gcloud CLI 隨附 accessibility/screen_reader 屬性。
如要啟用無障礙屬性,請執行下列指令:
gcloud config set accessibility/screen_reader true
如要進一步瞭解 gcloud 指令列工具隨附的無障礙功能,請參閱「啟用無障礙功能」指南。
設定
設定是一組 gcloud CLI 屬性。設定的運作方式與設定檔類似。
開始使用 gcloud CLI 時,您會使用名為 default 的單一設定,並可透過執行 gcloud init 或 gcloud config set 設定屬性。這個單一預設配置可適用於大多數的用途。
如要使用多個專案或授權帳戶,可以設定多個 gcloud config configurations create 設定,並在這些設定之間切換。您可以在設定中自訂屬性。
舉例來說,如要在有效設定中設定專案,請使用 project 屬性:
gcloud config set project <project-id>
如要詳細瞭解這些概念,請參閱設定指南。
全域選項
gcloud CLI 提供一組 gcloud CLI 選項,可管理指令在每次叫用時的行為。選項會覆寫 gcloud CLI 屬性中設定的值。
位置引數和選項
位置引數和選項都會影響 gcloud CLI 指令的輸出內容,但兩者的用途略有不同。位置引數用於定義指令運作的實體,而選項則用於設定指令行為的變化。
使用 stdout 和 stderr
成功執行 gcloud CLI 指令後,輸出內容會寫入 stdout。其他類型的回應 (提示、警告和錯誤) 則會寫入 stderr。請勿根據寫入 stderr 的回應編寫指令碼,因為這些回應不穩定。
如需處理輸出的相關指南,請參閱指令碼指南。
撰寫提示詞
為避免發生非預期的破壞性動作,gcloud CLI 會先確認您的意圖,再執行 gcloud projects delete 等指令。
如果需要更多資訊,系統可能會提示您。
舉例來說,使用 gcloud compute instances create test-instance 建立 Compute Engine 虛擬機器執行個體時,系統會要求您選擇可用區。
如要停用提示,請使用 --quiet 選項。
請勿根據提示的措辭編寫指令碼,因為措辭可能會變更。
略過提示、寫入終端機和登入
gcloud CLI 的 --quiet 選項 (也包括 -q) 會在執行 gcloud CLI 指令時停用所有互動式提示,適用於編寫指令碼。如果需要輸入內容,系統會使用預設值。如果沒有預設值,系統會引發錯誤。
如要在終端機中禁止將指令輸出內容列印至標準輸出和標準錯誤,請使用 --no-user-output-enabled 選項。
如要調整記錄的詳細程度,請使用 --verbosity 選項指定詳細程度 (debug、info、warning、error、critical 或 none)。
決定輸出結構
根據預設,當 gcloud CLI 指令傳回資源清單時,資源會以美觀格式列印至標準輸出。如要產生更有意義的輸出內容,可以使用 format、filter 和 projection 選項微調輸出內容。
如要只定義輸出內容的格式,請使用 --format 選項,產生輸出內容的表格或扁平化版本 (用於互動式顯示),或是機器可讀取的輸出內容版本 (json、csv、yaml、value)。
如要格式化選取資源資料值的鍵清單,請使用 projections。如要進一步根據您定義的條件調整輸出內容,請使用 filter。
後續步驟
- 如要進一步瞭解 gcloud CLI 指令,請參閱 gcloud CLI 參考資料。
