kubectl describe

概要

顯示特定資源或資源群組的詳細資訊。

列印所選資源的詳細描述，包括相關資源，例如事件或控制器。您可以依名稱選取單一物件、該類型的所有物件、提供名稱前綴或標籤選擇器。例如

    $ kubectl describe TYPE NAME_PREFIX

將首先檢查 TYPE 與 NAME_PREFIX 是否完全相符。如果沒有此類資源存在，它將輸出每個名稱以 NAME_PREFIX 為前綴的資源的詳細資訊。

使用 "kubectl api-resources" 取得支援資源的完整清單。

kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

範例

  # Describe a node
  kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
  
  # Describe a pod
  kubectl describe pods/nginx
  
  # Describe a pod identified by type and name in "pod.json"
  kubectl describe -f pod.json
  
  # Describe all pods
  kubectl describe pods
  
  # Describe pods by label name=myLabel
  kubectl describe pods -l name=myLabel
  
  # Describe all pods managed by the 'frontend' replication controller
  # (rc-created pods get the name of the rc as a prefix in the pod name)
  kubectl describe pods frontend

選項

-A, --all-namespaces

如果存在，則列出所有命名空間中請求的物件。即使使用 --namespace 指定，也會忽略目前內容中的命名空間。

--chunk-size int     預設值：500

以區塊而非一次全部傳回大型清單。傳遞 0 以停用。此標記為 Beta 版，未來可能會變更。

-f, --filename strings

包含要描述資源的檔案的檔名、目錄或 URL

-h, --help

describe 的說明

-k, --kustomize string

處理 kustomization 目錄。此標記不能與 -f 或 -R 一起使用。

-R, --recursive

以遞迴方式處理 -f、--filename 中使用的目錄。當您想要管理在相同目錄中組織的相關資訊清單時很有用。

-l, --selector string

要篩選的選擇器（標籤查詢），支援 '='、'==' 與 '!='。（例如 -l key1=value1,key2=value2）。相符的物件必須滿足所有指定的標籤約束。

--show-events     預設值：true

如果為 true，則顯示與描述物件相關的事件。

--as string

要模擬操作的使用者名稱。使用者可以是命名空間中的一般使用者或服務帳戶。

--as-group strings

要模擬操作的群組，可以重複此標記以指定多個群組。

--as-uid string

要模擬操作的 UID。

--cache-dir string     預設值："$HOME/.kube/cache"

預設快取目錄

--certificate-authority string

憑證授權單位的憑證檔案路徑

--client-certificate string

TLS 的用戶端憑證檔案路徑

--client-key string

TLS 的用戶端金鑰檔案路徑

--cluster string

要使用的 kubeconfig 叢集名稱

--context string

要使用的 kubeconfig 內容名稱

--default-not-ready-toleration-seconds int     預設值：300

指出預設新增至每個尚未具有此容忍度的 Pod 的 notReady:NoExecute 容忍度的 tolerationSeconds。

--default-unreachable-toleration-seconds int     預設值：300

指出預設新增至每個尚未具有此容忍度的 Pod 的 unreachable:NoExecute 容忍度的 tolerationSeconds。

--disable-compression

如果為 true，則針對伺服器的所有請求選擇退出回應壓縮

--insecure-skip-tls-verify

如果為 true，則不會檢查伺服器憑證的有效性。這會使您的 HTTPS 連線變得不安全

--kubeconfig string

用於 CLI 請求的 kubeconfig 檔案路徑。

--match-server-version

要求伺服器版本與用戶端版本相符

-n, --namespace string

如果存在，則此 CLI 請求的命名空間範圍

--password string

用於 API 伺服器的基本驗證密碼

--profile string     預設值："none"

要擷取的設定檔名稱。其中之一 (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output string     預設值："profile.pprof"

要將設定檔寫入的檔案名稱

--request-timeout string     預設值："0"

放棄單一伺服器請求之前要等待的時間長度。非零值應包含對應的時間單位（例如 1 秒、2 分、3 小時）。值為零表示請求不會逾時。

-s, --server string

Kubernetes API 伺服器的位址與連接埠

--storage-driver-buffer-duration duration     預設值：1m0s

儲存驅動程式中的寫入將緩衝此持續時間，並作為單一交易提交到非記憶體後端

--storage-driver-db string     預設值："cadvisor"

資料庫名稱

--storage-driver-host string     預設值："localhost:8086"

資料庫主機：連接埠

--storage-driver-password string     預設值："root"

資料庫密碼

--storage-driver-secure

使用與資料庫的安全連線

--storage-driver-table string     預設值："stats"

表名稱

--storage-driver-user string     預設值："root"

資料庫使用者名稱

--tls-server-name string

用於伺服器憑證驗證的伺服器名稱。如果未提供，則使用用於聯絡伺服器的主機名稱

--token string

用於 API 伺服器驗證的持有者權杖

--user string

要使用的 kubeconfig 使用者名稱

--username string

用於 API 伺服器的基本驗證使用者名稱

--version version[=true]

--version、--version=raw 列印版本資訊並結束；--version=vX.Y.Z... 設定報告的版本

--warnings-as-errors

將從伺服器接收的警告視為錯誤，並以非零結束代碼結束

另請參閱

  • kubectl - kubectl 控制 Kubernetes 叢集管理員

此頁面為自動產生。

如果您計畫回報此頁面的問題，請在您的問題描述中提及此頁面為自動產生。修正可能需要在 Kubernetes 專案的其他位置進行。

上次修改時間為 2024 年 8 月 19 日下午 5:14 PST：更新 v1.31 kubectl 參考文件 (59df28c340)