1OC(1) June 2016 OC(1)
2
6 oc edit - Edit a resource on the server
7
11 oc edit [OPTIONS]
12
16 Edit a resource from the default editor
17 The edit command allows you to directly edit any API resource you can
20 retrieve via the command line tools. It will open the editor defined by
21 your OC _EDITOR, or EDITOR environment variables, or fall back to 'vi'
22 for Linux or 'notepad' for Windows. You can edit multiple objects,
23 although changes are applied one at a time. The command accepts file‐
24 names as well as command line arguments, although the files you point
25 to must be previously saved versions of resources.
26 The files to edit will be output in the default API version, or a ver‐
29 sion specified by --output-version. The default format is YAML - if you
30 would like to edit in JSON pass -o json. The flag --windows-line-end‐
31 ings can be used to force Windows line endings, otherwise the default
32 for your operating system will be used.
33 In the event an error occurs while updating, a temporary file will be
36 created on disk that contains your unapplied changes. The most common
37 error when updating a resource is another editor changing the resource
38 on the server. When this occurs, you will have to apply your changes to
39 the newer version of the resource, or update your temporary saved copy
40 to include the latest resource version.
41
45 --allow-missing-template-keys=true
46 If true, ignore any errors in templates when a field or map key is
47 missing in the template. Only applies to golang and jsonpath output
48 formats.
49 -f, --filename=[]
52 Filename, directory, or URL to files to use to edit the resource
53 --include-uninitialized=false
56 If true, the kubectl command applies to uninitialized objects. If
57 explicitly set to false, this flag overrides other flags that make the
58 kubectl commands apply to uninitialized objects, e.g., "--all". Objects
59 with empty metadata.initializers are regarded as initialized.
60 -o, --output=""
63 Output format. One of: json|yaml|name|go-template|go-tem‐
64 plate-file|templatefile|template|jsonpath-file|jsonpath.
65 --output-patch=false
68 Output the patch if the resource is edited.
69 --record=false
72 Record current kubectl command in the resource annotation. If set
73 to false, do not record the command. If set to true, record the com‐
74 mand. If not set, default to updating the existing annotation value
75 only if one already exists.
76 -R, --recursive=false
79 Process the directory used in -f, --filename recursively. Useful
80 when you want to manage related manifests organized within the same
81 directory.
82 --save-config=false
85 If true, the configuration of current object will be saved in its
86 annotation. Otherwise, the annotation will be unchanged. This flag is
87 useful when you want to perform kubectl apply on this object in the
88 future.
89 --template=""
92 Template string or path to template file to use when -o=go-tem‐
93 plate, -o=go-template-file. The template format is golang templates [
94 ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].
95 --validate=false
98 If true, use a schema to validate the input before sending it
99 --windows-line-endings=false
102 Defaults to the line ending native to your platform.
103
107 --allow_verification_with_non_compliant_keys=false
108 Allow a SignatureVerifier to use keys which are technically
109 non-compliant with RFC6962.
110 --alsologtostderr=false
113 log to standard error as well as files
114 --application_metrics_count_limit=100
117 Max number of application metrics to store (per container)
118 --as=""
121 Username to impersonate for the operation
122 --as-group=[]
125 Group to impersonate for the operation, this flag can be repeated
126 to specify multiple groups.
127 --azure-container-registry-config=""
130 Path to the file containing Azure container registry configuration
131 information.
132 --boot_id_file="/proc/sys/kernel/random/boot_id"
135 Comma-separated list of files to check for boot-id. Use the first
136 one that exists.
137 --cache-dir="/builddir/.kube/http-cache"
140 Default HTTP cache directory
141 --certificate-authority=""
144 Path to a cert file for the certificate authority
145 --client-certificate=""
148 Path to a client certificate file for TLS
149 --client-key=""
152 Path to a client key file for TLS
153 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
156 CIDRs opened in GCE firewall for LB traffic proxy health checks
157 --cluster=""
160 The name of the kubeconfig cluster to use
161 --container_hints="/etc/cadvisor/container_hints.json"
164 location of the container hints file
165 --containerd="unix:///var/run/containerd.sock"
168 containerd endpoint
169 --context=""
172 The name of the kubeconfig context to use
173 --default-not-ready-toleration-seconds=300
176 Indicates the tolerationSeconds of the toleration for
177 notReady:NoExecute that is added by default to every pod that does not
178 already have such a toleration.
179 --default-unreachable-toleration-seconds=300
182 Indicates the tolerationSeconds of the toleration for unreach‐
183 able:NoExecute that is added by default to every pod that does not
184 already have such a toleration.
185 --docker="unix:///var/run/docker.sock"
188 docker endpoint
189 --docker-tls=false
192 use TLS to connect to docker
193 --docker-tls-ca="ca.pem"
196 path to trusted CA
197 --docker-tls-cert="cert.pem"
200 path to client certificate
201 --docker-tls-key="key.pem"
204 path to private key
205 --docker_env_metadata_whitelist=""
208 a comma-separated list of environment variable keys that needs to
209 be collected for docker containers
210 --docker_only=false
213 Only report docker containers in addition to root stats
214 --docker_root="/var/lib/docker"
217 DEPRECATED: docker root is read from docker info (this is a fall‐
218 back, default: /var/lib/docker)
219 --enable_load_reader=false
222 Whether to enable cpu load reader
223 --event_storage_age_limit="default=24h"
226 Max length of time for which to store events (per type). Value is a
227 comma separated list of key values, where the keys are event types
228 (e.g.: creation, oom) or "default" and the value is a duration. Default
229 is applied to all non-specified event types
230 --event_storage_event_limit="default=100000"
233 Max number of events to store (per type). Value is a comma sepa‐
234 rated list of key values, where the keys are event types (e.g.: cre‐
235 ation, oom) or "default" and the value is an integer. Default is
236 applied to all non-specified event types
237 --global_housekeeping_interval=0
240 Interval between global housekeepings
241 --housekeeping_interval=0
244 Interval between container housekeepings
245 --insecure-skip-tls-verify=false
248 If true, the server's certificate will not be checked for validity.
249 This will make your HTTPS connections insecure
250 --kubeconfig=""
253 Path to the kubeconfig file to use for CLI requests.
254 --log-flush-frequency=0
257 Maximum number of seconds between log flushes
258 --log_backtrace_at=:0
261 when logging hits line file:N, emit a stack trace
262 --log_cadvisor_usage=false
265 Whether to log the usage of the cAdvisor container
266 --log_dir=""
269 If non-empty, write log files in this directory
270 --logtostderr=true
273 log to standard error instead of files
274 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
277 Comma-separated list of files to check for machine-id. Use the
278 first one that exists.
279 --match-server-version=false
282 Require server version to match client version
283 -n, --namespace=""
286 If present, the namespace scope for this CLI request
287 --request-timeout="0"
290 The length of time to wait before giving up on a single server
291 request. Non-zero values should contain a corresponding time unit (e.g.
292 1s, 2m, 3h). A value of zero means don't timeout requests.
293 -s, --server=""
296 The address and port of the Kubernetes API server
297 --stderrthreshold=2
300 logs at or above this threshold go to stderr
301 --storage_driver_buffer_duration=0
304 Writes in the storage driver will be buffered for this duration,
305 and committed to the non memory backends as a single transaction
306 --storage_driver_db="cadvisor"
309 database name
310 --storage_driver_host="localhost:8086"
313 database host:port
314 --storage_driver_password="root"
317 database password
318 --storage_driver_secure=false
321 use secure connection with database
322 --storage_driver_table="stats"
325 table name
326 --storage_driver_user="root"
329 database username
330 --token=""
333 Bearer token for authentication to the API server
334 --user=""
337 The name of the kubeconfig user to use
338 -v, --v=0
341 log level for V logs
342 --version=false
345 Print version information and quit
346 --vmodule=
349 comma-separated list of pattern=N settings for file-filtered log‐
350 ging
351
355 # Edit the service named 'docker-registry':
356 oc edit svc/docker-registry
357 # Edit the DeploymentConfig named 'my-deployment':
359 oc edit dc/my-deployment
360 # Use an alternative editor
362 OC_EDITOR="nano" oc edit dc/my-deployment
363 # Edit the service 'docker-registry' in JSON using the v1 API format:
365 oc edit svc/docker-registry --output-version=v1 -o json
366
371 oc(1),
372
376 June 2016, Ported from the Kubernetes man-doc generator
377Openshift Openshift CLI User Manuals OC(1)