kubectl 运行

概要

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

要应用于 Pod 的注解。

--attach

如果为 true，则等待 Pod 开始运行，然后像调用 'kubectl attach ...' 一样附加到 Pod。除非设置了 '-i/--stdin'，否则默认为 false，在这种情况下默认值为 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 strings

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

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

run 的帮助信息

--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，则等待资源消失后再返回。这将等待终结器。

--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 上下文的名称

--default-not-ready-toleration-seconds int     默认值: 300

指示默认情况下添加到每个尚未具有此类容忍度的 Pod 的 notReady:NoExecute 容忍度的 tolerationSeconds。

--default-unreachable-toleration-seconds int     默认值: 300

指示默认情况下添加到每个尚未具有此类容忍度的 Pod 的 unreachable:NoExecute 容忍度的 tolerationSeconds。

--disable-compression

如果为 true，则选择退出所有对服务器的请求的响应压缩

--insecure-skip-tls-verify

如果为 true，则不会检查服务器证书的有效性。 这会使您的 HTTPS 连接不安全

--kubeconfig string

用于 CLI 请求的 kubeconfig 文件的路径。

--match-server-version

要求服务器版本与客户端版本匹配

-n, --namespace string

如果存在，则此 CLI 请求的命名空间范围

--password string

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

--profile string      默认值: "none"

要捕获的 profile 的名称。 可选值包括 (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output string      默认值: "profile.pprof"

用于写入 profile 的文件名

--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 令牌

--user string

要使用的 kubeconfig 用户名

--username string

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

--version version[=true]

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

--warnings-as-errors

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

参见

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

此页面是自动生成的。

如果您计划报告此页面存在的问题，请在您的问题描述中说明该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间：太平洋标准时间 2024 年 8 月 19 日下午 5:14：更新 v1.31 的 kubectl 参考 (59df28c340)