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，它将执行服务器端验证，但如果未启用，则将回退到不太可靠的客户端验证。
"warn" 将警告未知或重复的字段，但如果 API 服务器上启用了服务器端字段验证，则不会阻止请求，否则将像 "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 服务器进行身份验证的承载令牌

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