kubectl-edit man page

kubectl edit — Edit a resource on the server

Synopsis

kubectl edit [Options]

Description

Edit a resource from the default editor.

The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources.

The files to edit will be output in the default API version, or a version specified by --output-version. The default format is YAML - if you would like to edit in JSON pass -o json. The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used.

In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

Options

-f, --filename=[]
Filename, directory, or URL to file to use to edit the resource
--include-extended-apis=true
If true, include definitions of new APIs via calls to the API server. [default true]
-o, --output="yaml"
Output format. One of: yaml|json.
--output-version=""
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--record=false
Record current kubectl command in the resource annotation.
-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--save-config=false
If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
--windows-line-endings=false
Use Windows line-endings (default Unix line-endings)

Options Inherited from Parent Commands

--alsologtostderr=false
log to standard error as well as files

--api-version=""
DEPRECATED: The API version to use when talking to the server

--as=""
Username to impersonate for the operation.

--certificate-authority=""
Path to a cert. file for the certificate authority.

--client-certificate=""
Path to a client certificate file for TLS.

--client-key=""
Path to a client key file for TLS.

--cluster=""
The name of the kubeconfig cluster to use

--context=""
The name of the kubeconfig context to use

--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

--kubeconfig=""
Path to the kubeconfig file to use for CLI requests.

--log-backtrace-at=:0
when logging hits line file:N, emit a stack trace

--log-dir=""
If non-empty, write log files in this directory

--log-flush-frequency=5s
Maximum number of seconds between log flushes

--logtostderr=true
log to standard error instead of files

--match-server-version=false
Require server version to match client version

--namespace=""
If present, the namespace scope for this CLI request.

--password=""
Password for basic authentication to the API server.

-s, --server=""
The address and port of the Kubernetes API server

--stderrthreshold=2
logs at or above this threshold go to stderr

--token=""
Bearer token for authentication to the API server.

--user=""
The name of the kubeconfig user to use

--username=""
Username for basic authentication to the API server.

--v=0
log level for V logs

--vmodule=
comma-separated list of pattern=N settings for file-filtered logging

Example

# Edit the service named 'docker-registry':
kubectl edit svc/docker-registry

# Use an alternative editor
KUBE_EDITOR="nano" kubectl edit svc/docker-registry

# Edit the service 'docker-registry' in JSON using the v1 API format:
kubectl edit svc/docker-registry --output-version=v1 -o json

See Also

kubectl(1),

History

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Referenced By

kubectl(1).

kubernetes User Manuals Eric Paris Jan 2015