kubectl run

概要

在 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>

选项

--allow-missing-template-keys     默认值:true

如果为 true,则忽略模板中字段或映射键缺失时的任何错误。仅适用于 golang 和 jsonpath 输出格式。

--annotations 字符串

要应用于 Pod 的注释。

--attach

如果为 true,则等待 Pod 开始运行,然后像调用 'kubectl attach ...' 一样附加到 Pod。默认值为 false,除非设置了 '-i/--stdin',在这种情况下,默认值为 true。使用 '--restart=Never' 时,将返回容器进程的退出代码。

--command

如果为 true 且存在额外参数,则将它们用作容器中的 'command' 字段,而不是默认的 'args' 字段。

--dry-run 字符串[="unchanged"]     默认值: "none"

必须为 "none"、"server" 或 "client"。如果为客户端策略,则仅打印将要发送的对象,而不发送它。如果为服务器策略,则提交服务器端请求而不持久化资源。

--env 字符串

要在容器中设置的环境变量。

--expose --port

如果为 true,则创建与 Pod 关联的 ClusterIP 服务。需要 --port。

--field-manager 字符串     默认值: "kubectl-run"

用于跟踪字段所有权的管理器的名称。

-h, --help

run 的帮助信息

--image 字符串

要运行的容器的镜像。

--image-pull-policy 字符串

容器的镜像拉取策略。如果留空,则此值不会由客户端指定,而是由服务器默认设置。

-l, --labels 字符串

要应用于 Pod 的逗号分隔标签。将覆盖以前的值。

--leave-stdin-open

如果 Pod 在交互模式下或使用 stdin 启动,则在第一次附加完成之后保持 stdin 打开。默认情况下,stdin 将在第一次附加完成之后关闭。

-o, --output 字符串

输出格式。以下之一:(json、yaml、name、go-template、go-template-file、template、templatefile、jsonpath、jsonpath-as-json、jsonpath-file)。

--override-type 字符串     默认值: "merge"

用于覆盖生成的对象的方法:json、merge 或 strategic。

--overrides 字符串

生成对象的内联 JSON 覆盖。如果此项非空,则用于覆盖生成的对象。要求对象提供有效的 apiVersion 字段。

--pod-running-timeout 持续时间     默认值: 1m0s

等待至少一个 Pod 运行的时间长度(例如 5s、2m 或 3h,大于零)。

--port 字符串

此容器公开的端口。

--privileged

如果为 true,则以特权模式运行容器。

-q, --quiet

如果为 true,则抑制提示消息。

--restart 字符串     默认值: "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 字符串

当 -o=go-template、-o=go-template-file 时要使用的模板字符串或模板文件路径。模板格式为 golang 模板 [https://golang.ac.cn/pkg/text/template/#pkg-overview]。

-t, --tty

为 Pod 中的容器分配 TTY。

--as 字符串

要为操作模拟的用户名称。用户可以是普通用户或命名空间中的服务帐户。

--as-group 字符串

要为操作模拟的组,此标志可以重复以指定多个组。

--as-uid 字符串

要为操作模拟的 UID。

--cache-dir 字符串     默认值: "$HOME/.kube/cache"

默认缓存目录

--certificate-authority 字符串

证书颁发机构证书文件的路径

--client-certificate 字符串

用于 TLS 的客户端证书文件的路径

--client-key 字符串

用于 TLS 的客户端密钥文件的路径

--cloud-provider-gce-l7lb-src-cidrs cidrs     默认值: 130.211.0.0/22,35.191.0.0/16

在 GCE 防火墙中为 L7 LB 流量代理和运行状况检查打开的 CIDR

--cloud-provider-gce-lb-src-cidrs cidrs     默认值: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16

在 GCE 防火墙中为 L4 LB 流量代理和运行状况检查打开的 CIDR

--cluster 字符串

要使用的 kubeconfig 集群的名称

--context 字符串

要使用的 kubeconfig 上下文的名称

--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"

要捕获的配置文件名称。以下之一 (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output 字符串     默认值: "profile.pprof"

要写入配置文件的名称

--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 服务器进行身份验证的承载令牌

--user 字符串

要使用的 kubeconfig 用户的名称

--username 字符串

用于对 API 服务器进行基本身份验证的用户名

--version 版本[=true]

--version、--version=raw 打印版本信息并退出;--version=vX.Y.Z... 设置报告的版本

--warnings-as-errors

将从服务器收到的警告视为错误,并以非零退出代码退出

另请参阅

  • kubectl - kubectl 控制 Kubernetes 集群管理器

此页面是自动生成的。

如果您打算报告此页面的问题,请在您的问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间:2024 年 4 月 18 日下午 6:36 PST:更新 kubectl 参考以匹配 v1.30 (a6ccd20be9)