kubectl label

概要

更新資源上的標籤。

  • 標籤鍵與值必須以字母或數字開頭,並且可以包含字母、數字、連字號、點號和底線,每個最多 63 個字元。
  • (選擇性) 鍵可以 DNS 子網域前綴和單個 '/' 開頭,例如 example.com/my-app。
  • 如果 --overwrite 為 true,則現有標籤可以被覆寫,否則嘗試覆寫標籤將會導致錯誤。
  • 如果指定了 --resource-version,則更新將使用此資源版本,否則將使用現有的 resource-version。
kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

範例

  # Update pod 'foo' with the label 'unhealthy' and the value 'true'
  kubectl label pods foo unhealthy=true
  
  # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value
  kubectl label --overwrite pods foo status=unhealthy
  
  # Update all pods in the namespace
  kubectl label pods --all status=unhealthy
  
  # Update a pod identified by the type and name in "pod.json"
  kubectl label -f pod.json status=unhealthy
  
  # Update pod 'foo' only if the resource is unchanged from version 1
  kubectl label pods foo status=unhealthy --resource-version=1
  
  # Update pod 'foo' by removing a label named 'bar' if it exists
  # Does not require the --overwrite flag
  kubectl label pods foo bar-

選項

--all

選取所有資源,在指定資源類型的命名空間中

-A, --all-namespaces

如果為 true,則檢查所有命名空間中的指定動作。

--allow-missing-template-keys     預設值:true

如果為 true,則當範本中缺少欄位或映射鍵時,忽略範本中的任何錯誤。僅適用於 golang 和 jsonpath 輸出格式。

--dry-run 字串[="unchanged"]     預設值:"none"

必須為 "none"、"server" 或 "client"。如果為 client 策略,則僅列印將被傳送的物件,而不傳送它。如果為 server 策略,則提交伺服器端請求而不持久化資源。

--field-manager 字串     預設值:"kubectl-label"

用於追蹤欄位所有權的管理員名稱。

--field-selector 字串

要篩選的選擇器 (欄位查詢),支援 '='、'==' 和 '!='。(例如 --field-selector key1=value1,key2=value2)。伺服器僅支援每種類型有限數量的欄位查詢。

-f, --filename 字串

檔案名稱、目錄或 URL,指向識別要更新標籤的資源的檔案

-h, --help

label 的說明

-k, --kustomize 字串

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

--list

如果為 true,則顯示給定資源的標籤。

--local

如果為 true,則 label 將不會連線到 api-server,而是在本地執行。

-o, --output 字串

輸出格式。選項之一:(json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file)。

--overwrite

如果為 true,則允許覆寫標籤,否則拒絕覆寫現有標籤的標籤更新。

-R, --recursive

遞迴處理用於 -f, --filename 的目錄。當您想要管理在同一個目錄中組織的相關 Manifest 時非常有用。

--resource-version 字串

如果非空值,則只有當此值是物件的目前 resource-version 時,標籤更新才會成功。僅在指定單一資源時有效。

-l, --selector 字串

用於篩選的選取器(標籤查詢),支援 '=', '==' 和 '!='。(例如 -l key1=value1,key2=value2)。符合的物件必須滿足所有指定的標籤約束。

--show-managed-fields

如果為 true,則在 JSON 或 YAML 格式中列印物件時,保留 managedFields。

--template 字串

當使用 -o=go-template, -o=go-template-file 時,要使用的範本字串或範本檔案路徑。範本格式為 golang 範本 [https://go.dev.org.tw/pkg/text/template/#pkg-overview]。

--as 字串

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

--as-group 字串陣列

模擬操作的群組,可以重複此標誌以指定多個群組。

--as-uid 字串

模擬操作的 UID。

--cache-dir 字串     預設值: "$HOME/.kube/cache"

預設快取目錄

--certificate-authority 字串

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

--client-certificate 字串

TLS 用戶端憑證檔案路徑

--client-key 字串

TLS 用戶端金鑰檔案路徑

--cluster 字串

要使用的 kubeconfig 叢集名稱

--context 字串

要使用的 kubeconfig context 名稱

--default-not-ready-toleration-seconds 整數     預設值: 300

表示預設新增到每個尚未具有此容忍度的 Pod 的 notReady:NoExecute 容忍度的 tolerationSeconds。

--default-unreachable-toleration-seconds 整數     預設值: 300

表示預設新增到每個尚未具有此容忍度的 Pod 的 unreachable:NoExecute 容忍度的 tolerationSeconds。

--disable-compression

如果為 true,則選擇不對所有伺服器請求進行回應壓縮

--insecure-skip-tls-verify

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

--kubeconfig 字串

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

--match-server-version

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

-n, --namespace 字串

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

--password 字串

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

--profile 字串     預設值: "none"

要捕獲的 Profile 名稱。選項為 (none|cpu|heap|goroutine|threadcreate|block|mutex) 其中之一

--profile-output 字串     預設值: "profile.pprof"

要將 Profile 寫入的檔案名稱

--request-timeout 字串     預設值: "0"

放棄單一伺服器請求之前要等待的時間長度。非零值應包含對應的時間單位(例如 1s、2m、3h)。值為零表示請求永不逾時。

-s, --server 字串

Kubernetes API 伺服器的位址和埠

--storage-driver-buffer-duration 持續時間     預設值: 1m0s

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

--storage-driver-db 字串     預設值: "cadvisor"

資料庫名稱

--storage-driver-host 字串     預設值: "localhost:8086"

資料庫主機:埠

--storage-driver-password 字串     預設值: "root"

資料庫密碼

--storage-driver-secure

使用與資料庫的安全連線

--storage-driver-table 字串     預設值: "stats"

資料表名稱

--storage-driver-user 字串     預設值: "root"

資料庫使用者名稱

--tls-server-name 字串

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

--token 字串

用於 API 伺服器身分驗證的 Bearer 權杖

--user 字串

要使用的 kubeconfig 使用者名稱

--username 字串

用於 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)