kubectl edit

概要

使用默认编辑器编辑资源。

edit 命令允许您直接编辑您可以通过命令行工具检索到的任何 API 资源。它将打开由您的 KUBE_EDITOR 或 EDITOR 环境变量定义的编辑器，或者回退到 Linux 的“vi”或 Windows 的“notepad”。当尝试打开编辑器时，它将首先尝试使用在“SHELL”环境变量中定义的 shell。如果未定义，则将使用默认 shell，即 Linux 的“/bin/bash”或 Windows 的“cmd”。

您可以编辑多个对象，但更改是一次应用一个的。该命令接受文件名以及命令行参数，但您指向的文件必须是以前保存的资源版本。

编辑是使用用于获取资源的 API 版本完成的。要使用特定的 API 版本进行编辑，请完全限定资源、版本和组。

默认格式为 YAML。要在 JSON 中编辑，请指定“-o json”。

可以使用 --windows-line-endings 标志强制使用 Windows 行尾，否则将使用您的操作系统的默认行尾。

如果在更新期间发生错误，将在磁盘上创建一个临时文件，其中包含您未应用的更改。更新资源时最常见的错误是另一个编辑器更改了服务器上的资源。发生这种情况时，您必须将更改应用于更新版本的资源，或者更新您的临时保存副本以包含最新的资源版本。

kubectl edit (RESOURCE/NAME | -f FILENAME)

示例

  # Edit the service named 'registry'
  kubectl edit svc/registry
  
  # Use an alternative editor
  KUBE_EDITOR="nano" kubectl edit svc/registry
  
  # Edit the job 'myjob' in JSON using the v1 API format
  kubectl edit job.v1.batch/myjob -o json
  
  # Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation
  kubectl edit deployment/mydeployment -o yaml --save-config
  
  # Edit the 'status' subresource for the 'mydeployment' deployment
  kubectl edit deployment mydeployment --subresource='status'

选项

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

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

--field-manager string     默认值：“kubectl-edit”

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

-f, --filename strings

要用于编辑资源的文件的文件名、目录或 URL

-h, --help

edit 的帮助

-k, --kustomize string

处理 kustomization 目录。此标志不能与 -f 或 -R 一起使用。

-o, --output string

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

--output-patch

如果资源被编辑，则输出补丁。

-R, --recursive

递归处理 -f、--filename 中使用的目录。当您想要管理组织在同一目录中的相关清单时非常有用。

--save-config

如果为 true，则当前对象的配置将保存在其注释中。否则，注释将保持不变。当您希望将来对此对象执行 kubectl apply 时，此标志非常有用。

--show-managed-fields

如果为 true，则在以 JSON 或 YAML 格式打印对象时保留 managedFields。

--subresource string

如果指定，edit 将对请求对象的子资源进行操作。必须是 [status] 之一。此标志处于测试阶段，将来可能会更改。

--template string

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

--validate string[="strict"]     默认值：“strict”

必须是以下之一：strict（或 true）、warn、ignore（或 false）。
“true”或“strict”将使用架构来验证输入，如果无效则拒绝请求。如果在 api-server 上启用了 ServerSideFieldValidation，它将执行服务器端验证，但如果未启用，则将回退到不太可靠的客户端验证。
如果在 API 服务器上启用了服务器端字段验证，“warn”将警告有关未知或重复字段的信息，而不会阻止请求，否则将表现为“ignore”。
“false”或“ignore”将不执行任何架构验证，静默删除任何未知或重复的字段。

--windows-line-endings

默认为您的平台原生的行尾。

--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 的客户端密钥文件路径

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

要捕获的配置文件的名称。以下之一：(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 令牌

--user string

要使用的 kubeconfig 用户的名称

--username string

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

--version version[=true]

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

--warnings-as-errors

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

另请参阅

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

本页面自动生成。

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

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