kubectl run

Synopsis

建立並執行一個 Pod 中的特定映象。

kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server|client] [--overrides=inline-json] [--command] -- [COMMAND] [args...]

示例

  # Start a nginx pod
  kubectl run nginx --image=nginx
  
  # Start a hazelcast pod and let the container expose port 5701
  kubectl run hazelcast --image=hazelcast/hazelcast --port=5701
  
  # Start a hazelcast pod and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container
  kubectl run hazelcast --image=hazelcast/hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
  
  # Start a hazelcast pod and set labels "app=hazelcast" and "env=prod" in the container
  kubectl run hazelcast --image=hazelcast/hazelcast --labels="app=hazelcast,env=prod"
  
  # Dry run; print the corresponding API objects without creating them
  kubectl run nginx --image=nginx --dry-run=client
  
  # Start a nginx pod, but overload the spec with a partial set of values parsed from JSON
  kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
  
  # Start a busybox pod and keep it in the foreground, don't restart it if it exits
  kubectl run -i -t busybox --image=busybox --restart=Never
  
  # Start the nginx pod using the default command, but use custom arguments (arg1 .. argN) for that command
  kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
  
  # Start the nginx pod using a different command and custom arguments
  kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>

Options

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

如果為 true，則在模板中缺少欄位或對映鍵時忽略模板中的任何錯誤。僅適用於 golang 和 jsonpath 輸出格式。

--annotations string

要應用於 Pod 的註解。

--attach

如果為 true，則等待 Pod 開始執行，然後附加到 Pod，就像呼叫了 'kubectl attach ...' 一樣。預設值為 false，除非設定了 '-i/--stdin'，在這種情況下預設為 true。對於 '--restart=Never'，將返回容器程序的退出碼。

--cascade string[="background"]     預設值: "background"

必須是“background”、“orphan”或“foreground”。選擇依賴項（例如，由 ReplicationController 建立的 Pod）的刪除級聯策略。預設為 background。

--command

如果為 true 且存在額外的引數，則將它們用作容器中的 'command' 欄位，而不是預設的 'args' 欄位。

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

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

--env string

要在容器中設定的環境變數。

--expose --port

如果為 true，則建立一個與 Pod 關聯的 ClusterIP 服務。需要 --port。

--field-manager string     預設值: "kubectl-run"

用於跟蹤欄位所有權的管理器名稱。

-f, --filename strings

用於替換資源的。

--force

如果為 true，則立即從 API 中刪除資源並繞過正常刪除。請注意，立即刪除某些資源可能導致不一致或資料丟失，並需要確認。

--grace-period int     預設值: -1

在資源終止之前給予的優雅終止時間（秒）。如果為負數則忽略。設定為 1 以立即關閉。僅當 --force 為 true（強制刪除）時才能設定為 0。

-h, --help

執行命令的幫助

--image string

容器要執行的映象。

--image-pull-policy string

容器的映象拉取策略。如果留空，此值將不會由客戶端指定，而是由伺服器預設。

-k, --kustomize string

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

-l, --labels string

要應用於 Pod 的逗號分隔的標籤。將覆蓋先前的值。

--leave-stdin-open

如果 Pod 以互動模式或帶有 stdin 啟動，在第一次附加完成後，將 stdin 保持開啟狀態。預設情況下，stdin 在第一次附加完成後將關閉。

-o, --output string

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

--override-type string     預設值: "merge"

用於覆蓋生成物件的型別：json、merge 或 strategic。

--overrides string

用於覆蓋生成物件的內聯 JSON。如果此欄位非空，則用於覆蓋生成物件。要求物件提供有效的 apiVersion 欄位。

--pod-running-timeout duration     預設值：1m0s

等待直到至少有一個 pod 執行的時間長度（例如 5s、2m 或 3h，必須大於零）。

--port string

此容器公開的埠。

--privileged

如果為 true，則以特權模式執行容器。

-q, --quiet

如果為 true，則抑制提示訊息。

-R, --recursive

遞迴處理 -f, --filename 指定的目錄。當您想管理組織在同一目錄下的相關清單時很有用。

--restart string     預設值: "Always"

此 Pod 的重啟策略。合法值包括 [Always, OnFailure, Never]。

--rm

如果為 true，則在 Pod 退出後刪除它。僅當附加到容器時有效，例如使用 '--attach' 或 '-i/--stdin'。

--save-config

如果為 true，當前物件的配置將儲存在其註解中。否則，註解將保持不變。如果您將來希望對此物件執行 kubectl apply，此標誌非常有用。

--show-managed-fields

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

-i, --stdin

在 Pod 的容器中保持 stdin 開啟，即使沒有附加任何內容。

--template string

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

--timeout duration

放棄刪除之前等待的時間長度，零表示根據物件大小確定超時

-t, --tty

為 Pod 中的容器分配一個 TTY。

--wait

如果為 true，則在返回之前等待資源消失。這將等待 finalizers。

繼承的父選項

--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 專案的其他地方進行。

最後修改於 2025 年 9 月 4 日下午 3:30 PST: Update kubectl reference for v1.34 (bdc4bba2a5)