openshift-kube-edit man page

openshift kube edit — Edit a resource on the server

Synopsis

openshift kube 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. 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.
--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

--application-metrics-count-limit=100
Max number of application metrics to store (per container)

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

--boot-id-file="/proc/sys/kernel/random/boot_id"
Comma-separated list of files to check for boot-id. Use the first one that exists.

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

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

--container-hints="/etc/cadvisor/container_hints.json"
location of the container hints file

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

--docker="unix:///var/run/docker.sock"
docker endpoint

--docker-env-metadata-whitelist=""
a comma-separated list of environment variable keys that needs to be collected for docker containers

--docker-only=false
Only report docker containers in addition to root stats

--docker-root="/var/lib/docker"
DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)

--enable-load-reader=false
Whether to enable cpu load reader

--event-storage-age-limit="default=0"
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

--event-storage-event-limit="default=0"
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

--global-housekeeping-interval=0
Interval between global housekeepings

--google-json-key=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

--housekeeping-interval=0
Interval between container housekeepings

--httptest.serve=""
if non-empty, httptest.NewServer serves on this address and blocks

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

--ir-data-source="influxdb"
Data source used by InitialResources. Supported options: influxdb, gcm.

--ir-dbname="k8s"
InfluxDB database name which contains metrics requred by InitialResources

--ir-hawkular=""
Hawkular configuration URL

--ir-influxdb-host="localhost:8080/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb:api"
Address of InfluxDB which contains metrics requred by InitialResources

--ir-namespace-only=false
Whether the estimation should be made only based on data from the same namespace.

--ir-password="root"
Password used for connecting to InfluxDB

--ir-percentile=90
Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.

--ir-user="root"
User used for connecting to InfluxDB

--kubeconfig=""
Specify a kubeconfig file to define the configuration

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

--log-cadvisor-usage=false
Whether to log the usage of the cAdvisor container

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

--log-flush-frequency=0
Maximum number of seconds between log flushes

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

--machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
Comma-separated list of files to check for machine-id. Use the first one that exists.

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

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

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

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

--storage-driver-buffer-duration=0
Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

--storage-driver-db="cadvisor"
database name

--storage-driver-host="localhost:8086"
database host:port

--storage-driver-password="root"
database password

--storage-driver-secure=false
use secure connection with database

--storage-driver-table="stats"
table name

--storage-driver-user="root"
database username

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

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

-v, --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

openshift-kube(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-kube(1).

Openshift CLI User Manuals Openshift June 2016