kubectl explain
Synopsis
描述各種資源的欄位和結構。
此命令描述了每個支援的 API 資源所關聯的欄位。欄位透過簡單的 JSONPath 識別符號進行識別。
<type>.<fieldName>[.<fieldName>]
每個欄位的資訊均以 OpenAPI 格式從伺服器檢索。
使用 "kubectl api-resources" 獲取支援的資源列表。
kubectl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [-o|--output=plaintext|plaintext-openapiv2]
示例
# Get the documentation of the resource and its fields
kubectl explain pods
# Get all the fields in the resource
kubectl explain pods --recursive
# Get the explanation for deployment in supported api versions
kubectl explain deployments --api-version=apps/v1
# Get the documentation of a specific field of a resource
kubectl explain pods.spec.containers
# Get the documentation of resources in different format
kubectl explain deployment --output=plaintext-openapiv2
Options
| --api-version string | |
為特定 API 版本（API 組/版本）獲取不同的解釋。 | |
| -h, --help | |
explain 的幫助資訊 | |
| -o, --output string 預設值: "plaintext" | |
渲染 schema 的格式（plaintext、plaintext-openapiv2）。 | |
| --recursive | |
列印欄位的欄位（目前僅支援 1 級深度）。 | |
繼承的父選項
| --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 上下文名稱 | |
| --disable-compression | |
如果為 true，則選擇退出所有到伺服器的請求的響應壓縮 | |
| --insecure-skip-tls-verify | |
如果為 true，則不會檢查伺服器證書的有效性。這將使您的 HTTPS 連線不安全。 | |
| --kubeconfig string | |
用於 CLI 請求的 kubeconfig 檔案路徑。 | |
| --kuberc string | |
用於首選項的 kuberc 檔案路徑。可以透過匯出 KUBECTL_KUBERC=false 功能標誌或關閉 KUBERC=off 功能來停用此功能。 | |
| --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" | |
在放棄單個伺服器請求之前等待的時間。非零值應包含相應的時間單位（例如 1s、2m、3h）。零值表示不超時請求。 | |
| -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 伺服器身份驗證的 Bearer token | |
| --user string | |
要使用的 kubeconfig 使用者名稱 | |
| --username string | |
API 伺服器基本身份驗證的使用者名稱 | |
| --version version[=true] | |
--version, --version=raw 列印版本資訊並退出；--version=vX.Y.Z... 設定報告的版本 | |
| --warnings-as-errors | |
將從伺服器收到的警告視為錯誤，並以非零退出程式碼退出。 | |
另請參閱
- kubectl - kubectl 控制 Kubernetes 叢集管理器
本頁面是自動生成的。
如果你打算報告此頁面存在的問題，請在問題描述中提及此頁面是自動生成的。修復可能需要在 Kubernetes 專案的其他地方進行。