kubectl annotate
Synopsis
更新一個或多個資源的註解。
所有 Kubernetes 物件都支援將額外資料以註解（annotations）的形式儲存在物件中。註解是鍵值對，其大小可以比標籤大，並且可以包含任意字串值，例如結構化的 JSON。工具和系統擴充套件可以使用註解來儲存自己的資料。
嘗試設定一個已存在的註解將失敗，除非設定了 --overwrite。如果指定了 --resource-version 且其與伺服器上的當前資源版本不匹配，則命令將失敗。
使用 "kubectl api-resources" 獲取支援的資源列表。
kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
示例
# Update pod 'foo' with the annotation 'description' and the value 'my frontend'
# If the same annotation is set multiple times, only the last value will be applied
kubectl annotate pods foo description='my frontend'
# Update a pod identified by type and name in "pod.json"
kubectl annotate -f pod.json description='my frontend'
# Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value
kubectl annotate --overwrite pods foo description='my frontend running nginx'
# Update all pods in the namespace
kubectl annotate pods --all description='my frontend running nginx'
# Update pod 'foo' only if the resource is unchanged from version 1
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
# Update pod 'foo' by removing an annotation named 'description' if it exists
# Does not require the --overwrite flag
kubectl annotate pods foo description-
Options
| --all | |
選擇所有資源，位於指定資源型別的名稱空間內。 | |
| -A, --all-namespaces | |
如果為 true，則在所有名稱空間中檢查指定的動作。 | |
| --allow-missing-template-keys 預設值: true | |
如果為 true，則在模板中缺少欄位或對映鍵時忽略模板中的任何錯誤。僅適用於 golang 和 jsonpath 輸出格式。 | |
| --dry-run string[="unchanged"] 預設值: "none" | |
必須是 "none"、"server" 或 "client"。如果是 client 策略，則僅列印將要傳送的物件，而不傳送它。如果是 server 策略，則提交伺服器端請求而不持久化資源。 | |
| --field-manager string 預設值: "kubectl-annotate" | |
用於跟蹤欄位所有權的管理器名稱。 | |
| --field-selector string | |
用於過濾的選擇器（欄位查詢），支援 '=', '==', 和 '!='。（例如 --field-selector key1=value1,key2=value2）。伺服器僅支援每種型別的有限數量的欄位查詢。 | |
| -f, --filename strings | |
檔名、目錄或 URL，指向標識要更新註解的資源的檔案。 | |
| -h, --help | |
annotate 的幫助資訊 | |
| -k, --kustomize string | |
處理 kustomization 目錄。此標誌不能與 -f 或 -R 一起使用。 | |
| --list | |
如果為 true，則顯示給定資源的註解。 | |
| --local | |
如果為 true，則註解不會聯絡 api-server，而是本地執行。 | |
| -o, --output string | |
輸出格式。選擇之一：(json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file)。 | |
| --overwrite | |
如果為 true，則允許覆蓋註解，否則拒絕覆蓋現有註解的註解更新。 | |
| -R, --recursive | |
遞迴處理 -f, --filename 指定的目錄。當您想管理組織在同一目錄下的相關清單時很有用。 | |
| --resource-version string | |
如果非空，則只有當此是物件的當前 resource-version 時，註解更新才會成功。僅在指定單個資源時有效。 | |
| -l, --selector string | |
用於過濾的選擇器（標籤查詢），支援 '=', '==', '!=', 'in', 'notin'。（例如 -l key1=value1,key2=value2,key3 in (value3)）。匹配的物件必須滿足所有指定的標籤約束。 | |
| --show-managed-fields | |
如果為 true，則在以 JSON 或 YAML 格式列印物件時保留 managedFields。 | |
| --template string | |
當 -o=go-template, -o=go-template-file 時使用的模板字串或模板檔案路徑。模板格式為 golang 模板 [https://golang.org.tw/pkg/text/template/#pkg-overview]。 | |
繼承的父選項
| --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 專案的其他地方進行。