kubectl-edit man page

kubectl edit — Edit a resource on the server


kubectl edit [Options]


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.


-f, --filename=[]
Filename, directory, or URL to files to use to edit the resource
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 the formatted object with the given group version (for ex: 'extensions/v1beta1').
Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
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.
--schema-cache-dir=" /.kube/schema"
If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
If true, use a schema to validate the input before sending it
Use Windows line-endings (default Unix line-endings)

Options Inherited from Parent Commands

Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.
log to standard error as well as files
DEPRECATED: The API version to use when talking to the server
Max number of application metrics to store (per container)
Username to impersonate for the operation
Path to the file container Azure container registry configuration information.
Comma-separated list of files to check for boot-id. Use the first one that exists.
Path to a cert. file for the certificate authority
Path to a client certificate file for TLS
Path to a client key file for TLS
The name of the kubeconfig cluster to use
location of the container hints file
The name of the kubeconfig context to use
docker endpoint
a comma-separated list of environment variable keys that needs to be collected for docker containers
Only report docker containers in addition to root stats
DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)
Whether to enable cpu load reader
Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types
Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types
Interval between global housekeepings
The Google Cloud Platform Service Account JSON Key to use for authentication.
Interval between container housekeepings
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
Data source used by InitialResources. Supported options: influxdb, gcm.
InfluxDB database name which contains metrics required by InitialResources
Hawkular configuration URL
Address of InfluxDB which contains metrics required by InitialResources
Whether the estimation should be made only based on data from the same namespace.
Password used for connecting to InfluxDB
Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.
User used for connecting to InfluxDB
Path to the kubeconfig file to use for CLI requests.
when logging hits line file:N, emit a stack trace
Whether to log the usage of the cAdvisor container
If non-empty, write log files in this directory
Log level (0 = DEBUG, 5 = FATAL)
log to standard error instead of files
Comma-separated list of files to check for machine-id. Use the first one that exists.
Require server version to match client version
-n, --namespace=""
If present, the namespace scope for this CLI request
Password for basic authentication to the API server
The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
-s, --server=""
The address and port of the Kubernetes API server
logs at or above this threshold go to stderr
Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction
database name
database host:port
database password
use secure connection with database
table name
database username
Bearer token for authentication to the API server
The name of the kubeconfig user to use
Username for basic authentication to the API server
-v, --v=0
log level for V logs
comma-separated list of pattern=N settings for file-filtered logging


  # 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



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


kubernetes User Manuals Eric Paris Jan 2015