kubectl edit

简介

用默认编辑器编辑资源。

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

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

  • edit 是通过用于获取资源的 API 版本完成的。要编辑特定 API 版本的资源，请完全限定资源、版本和组。

  • 默认格式为 YAML。要以 JSON 格式进行编辑，请指定 "-o json"。

  • --windows-line-endings 标志可用于强制 Windows 行结束，否则将使用操作系统的默认值。

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

kubectl edit (RESOURCE/NAME | -f FILENAME)

示例

# 编辑名为 "registry" 的 Service
kubectl edit svc/registry
  
# 使用替代编辑器
KUBE_EDITOR="nano" kubectl edit svc/registry
  
# 使用 v1 API 格式编辑 JSON 中的 Job "myjob"
kubectl edit job.v1.batch/myjob -o json
  
# 在 YAML 中编辑 Deployment "mydeployment" 并将修改后的配置保存在其注解中
kubectl edit deployment/mydeployment -o yaml --save-config
  
# 编辑 "mydeployment" Deployment 的 "status" 子资源
kubectl edit deployment mydeployment --subresource='status'

选项

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

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

--field-manager string     Default: "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 子资源。 该标志处于 Beta 状态，将来可能会发生变化。

--template string

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

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

必须是以下选项之一：strict（或 true）、warn、ignore（或 false）。
"true" 或 "strict" 将使用模式定义来验证输入，如果无效，则请求失败。 如果在 API 服务器上启用了 ServerSideFieldValidation，则执行服务器端验证， 但如果未启用，它将回退到可靠性较低的客户端验证。
如果在 API 服务器上启用了服务器端字段验证，"warn" 将警告未知或重复的字段而不阻止请求， 否则操作与 "ignore" 的表现相同。
"false" 或 "ignore" 将不会执行任何模式定义检查，而是静默删除所有未知或重复的字段。

--windows-line-endings

仅在 --edit=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

设置针对 notReady:NoExecute 的容忍度的 tolerationSeconds，默认添加到所有尚未设置此容忍度的 Pod。

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

设置针对 unreachable:NoExecute 的容忍度的 tolerationSeconds，默认添加到所有尚未设置此容忍度的 Pod。

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

数据库 host:port

--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 服务器进行身份验证的持有者令牌。

--user string

要使用的 kubeconfig 用户的名称。

--username string

向 API 服务器进行基本身份验证时所用的用户名。

--version version[=true]

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

--warnings-as-errors

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

另请参见

  • kubectl - kubectl 控制 Kubernetes 集群管理器
最后修改 December 15, 2024 at 6:24 PM PST: Merge pull request #49087 from Arhell/es-link (2c4497f)