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.ac.cn/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)