跳至主要内容

Rancher CLI

Rancher CLI（命令列介面）是一個統一的工具，您可以使用它與 Rancher 互動。使用此工具，您可以使用命令列而不是 GUI 來操作 Rancher。

下載 Rancher CLI​

可以直接從 UI 下載二進位檔案。

  1. 在左上角，點選 ☰。
  2. 在導覽側邊欄選單的底部，點選 Rancher 版本號。
  3. 在 CLI Downloads 區段下，有用於下載 Windows、Mac 和 Linux 二進位檔案的連結。您也可以查看我們 CLI 的發布頁面以直接下載二進位檔案。

需求​

下載 Rancher CLI 後，您需要進行一些設定。Rancher CLI 需要：

  • 您的 Rancher Server URL，用於連線到 Rancher Server。
  • 一個 API Bearer Token，用於與 Rancher 進行身份驗證。有關取得 Bearer Token 的更多資訊，請參閱建立 API 金鑰。

CLI 身份驗證​

在您可以使用 Rancher CLI 控制您的 Rancher Server 之前，您必須使用 API Bearer Token 進行身份驗證。使用以下指令登入（將 <BEARER_TOKEN> 和 <SERVER_URL> 替換為您的資訊）：

$ ./rancher login https://<SERVER_URL> --token <BEARER_TOKEN>

如果 Rancher Server 使用自簽憑證，Rancher CLI 會提示您繼續連線。

專案選擇​

在您可以執行任何指令之前，您必須選擇一個 Rancher 專案來執行這些指令。要選擇要處理的專案，請使用指令 ./rancher context switch。當您輸入此指令時，會顯示可用專案的清單。輸入數字以選擇您的專案。

範例：./rancher context switch 輸出

User:rancher-cli-directory user$ ./rancher context switch
NUMBER    CLUSTER NAME   PROJECT ID              PROJECT NAME
1         cluster-2      c-7q96s:p-h4tmb         project-2
2         cluster-2      c-7q96s:project-j6z6d   Default
3         cluster-1      c-lchzv:p-xbpdt         project-1
4         cluster-1      c-lchzv:project-s2mch   Default
Select a Project:

輸入數字後，控制台會顯示一條訊息，表明您已更改專案。

INFO[0005] Setting new context to project project-1
INFO[0005] Saving config to /Users/markbishop/.ranchcli2.json

確保您可以成功執行 rancher kubectl get pods。

指令​

以下指令可在 Rancher CLI 中使用。

指令結果
clusters, [cluster]對您的叢集執行操作。
context在 Rancher 專案之間切換。有關範例，請參閱專案選擇。
inspect [OPTIONS] [RESOURCEID RESOURCENAME]顯示有關 Kubernetes 資源或 Rancher 資源（即：專案和工作負載）的詳細資訊。按名稱或 ID 指定資源。
kubectl執行 kubectl 指令。
login, [l]登入 Rancher Server。有關範例，請參閱 CLI 身份驗證。
machines, [machine]對機器執行操作。
namespaces, [namespace]對命名空間執行操作。
nodes, [node]對節點執行操作。
projects, [project]對專案執行操作。
ps顯示專案中的工作負載。
server對伺服器執行操作。
settings, [setting]顯示您 Rancher Server 的目前設定。
ssh使用 SSH 協定連線到您的其中一個叢集節點。
up應用 compose 設定。
wait等待資源叢集、應用程式、專案、multiClusterApp。
token進行身份驗證並生成新的 kubeconfig token。
help, [h]顯示指令清單或單一指令的幫助。

Rancher CLI 說明​

使用 CLI 登入 Rancher Server 後，輸入 ./rancher --help 以取得指令清單。

所有指令都接受 --help 旗標，該旗標記錄了每個指令的用法。

限制​

Rancher CLI 無法用於安裝儀表板應用程式或 Rancher 功能圖表。