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 将对请求对象的子资源进行操作。

--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" 将使用 Schema 验证输入,并在无效时使请求失败。如果在 API 服务器上启用了 ServerSideFieldValidation,它将执行服务器端验证,否则将回退到不太可靠的客户端验证。"warn" 将在 API 服务器上启用了服务器端字段验证的情况下,警告未知或重复字段而不阻塞请求,否则将行为如同 "ignore"。"false" 或 "ignore" 将不执行任何 Schema 验证,静默删除任何未知或重复字段。

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

--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 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 年 4 月 24 日 太平洋时间 8:03 AM:v1.33 的 kubectl 参考 (80481646c3)