1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl rollout pause - Mark the provided resource as paused
10
11
12

SYNOPSIS

14       kubectl rollout pause [OPTIONS]
15
16
17

DESCRIPTION

19       Mark the provided resource as paused
20
21
22       Paused  resources  will not be reconciled by a controller. Use "kubectl
23       rollout resume" to resume a paused resource. Currently only deployments
24       support being paused.
25
26
27

OPTIONS

29       --allow-missing-template-keys=true       If  true, ignore any errors in
30       templates when a field or map key is missing in the template. Only  ap‐
31       plies to golang and jsonpath output formats.
32
33
34       --field-manager="kubectl-rollout"       Name  of  the  manager  used to
35       track field ownership.
36
37
38       -f, --filename=[]      Filename, directory, or URL to files identifying
39       the resource to get from a server.
40
41
42       -k,  --kustomize=""      Process the kustomization directory. This flag
43       can't be used together with -f or -R.
44
45
46       -o, --output=""       Output  format.  One  of:  json|yaml|name|go-tem‐
47       plate|go-template-file|template|templatefile|jsonpath|json‐
48       path-as-json|jsonpath-file.
49
50
51       -R, --recursive=false      Process the directory used in -f, --filename
52       recursively. Useful when you want to manage related manifests organized
53       within the same directory.
54
55
56       --show-managed-fields=false      If true, keep the  managedFields  when
57       printing objects in JSON or YAML format.
58
59
60       --template=""      Template string or path to template file to use when
61       -o=go-template, -o=go-template-file. The template format is golang tem‐
62       plates [http://golang.org/pkg/text/template/#pkg-overview].
63
64
65

OPTIONS INHERITED FROM PARENT COMMANDS

67       --add-dir-header=false       If  true,  adds  the file directory to the
68       header of the log messages
69
70
71       --alsologtostderr=false      log to standard error as well as files
72
73
74       --application-metrics-count-limit=100      Max  number  of  application
75       metrics to store (per container)
76
77
78       --as=""      Username to impersonate for the operation
79
80
81       --as-group=[]       Group  to  impersonate for the operation, this flag
82       can be repeated to specify multiple groups.
83
84
85       --azure-container-registry-config=""      Path to the  file  containing
86       Azure container registry configuration information.
87
88
89       --boot-id-file="/proc/sys/kernel/random/boot_id"        Comma-separated
90       list of files to check for boot-id. Use the first one that exists.
91
92
93       --cache-dir="/builddir/.kube/cache"      Default cache directory
94
95
96       --certificate-authority=""      Path to a cert file for the certificate
97       authority
98
99
100       --client-certificate=""      Path to a client certificate file for TLS
101
102
103       --client-key=""      Path to a client key file for TLS
104
105
106       --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
107            CIDRs opened in GCE firewall for  L7  LB  traffic  proxy    health
108       checks
109
110
111       --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
112            CIDRs opened in GCE firewall for  L4  LB  traffic  proxy    health
113       checks
114
115
116       --cluster=""      The name of the kubeconfig cluster to use
117
118
119       --container-hints="/etc/cadvisor/container_hints.json"      location of
120       the container hints file
121
122
123       --containerd="/run/containerd/containerd.sock"      containerd endpoint
124
125
126       --containerd-namespace="k8s.io"      containerd namespace
127
128
129       --context=""      The name of the kubeconfig context to use
130
131
132       --default-not-ready-toleration-seconds=300      Indicates  the  tolera‐
133       tionSeconds  of  the toleration for notReady:NoExecute that is added by
134       default to every pod that does not already have such a toleration.
135
136
137       --default-unreachable-toleration-seconds=300      Indicates the tolera‐
138       tionSeconds  of  the toleration for unreachable:NoExecute that is added
139       by default to every pod that does not already have such a toleration.
140
141
142       --disable-root-cgroup-stats=false      Disable collecting  root  Cgroup
143       stats
144
145
146       --docker="unix:///var/run/docker.sock"      docker endpoint
147
148
149       --docker-env-metadata-whitelist=""      a comma-separated list of envi‐
150       ronment variable keys matched with specified prefix that  needs  to  be
151       collected for docker containers
152
153
154       --docker-only=false       Only  report docker containers in addition to
155       root stats
156
157
158       --docker-root="/var/lib/docker"      DEPRECATED: docker  root  is  read
159       from docker info (this is a fallback, default: /var/lib/docker)
160
161
162       --docker-tls=false      use TLS to connect to docker
163
164
165       --docker-tls-ca="ca.pem"      path to trusted CA
166
167
168       --docker-tls-cert="cert.pem"      path to client certificate
169
170
171       --docker-tls-key="key.pem"      path to private key
172
173
174       --enable-load-reader=false      Whether to enable cpu load reader
175
176
177       --event-storage-age-limit="default=0"      Max length of time for which
178       to store events (per type). Value is a comma separated list of key val‐
179       ues,  where the keys are event types (e.g.: creation, oom) or "default"
180       and the value is a duration. Default is applied  to  all  non-specified
181       event types
182
183
184       --event-storage-event-limit="default=0"       Max  number  of events to
185       store (per type). Value is a comma separated list of key values,  where
186       the  keys  are  event  types (e.g.: creation, oom) or "default" and the
187       value is an integer. Default is  applied  to  all  non-specified  event
188       types
189
190
191       --global-housekeeping-interval=1m0s      Interval between global house‐
192       keepings
193
194
195       --housekeeping-interval=10s      Interval between container  housekeep‐
196       ings
197
198
199       --insecure-skip-tls-verify=false      If true, the server's certificate
200       will not be checked for validity. This will make your HTTPS connections
201       insecure
202
203
204       --kubeconfig=""       Path  to  the  kubeconfig file to use for CLI re‐
205       quests.
206
207
208       --log-backtrace-at=:0      when logging hits line file:N, emit a  stack
209       trace
210
211
212       --log-cadvisor-usage=false       Whether to log the usage of the cAdvi‐
213       sor container
214
215
216       --log-dir=""      If non-empty, write log files in this directory
217
218
219       --log-file=""      If non-empty, use this log file
220
221
222       --log-file-max-size=1800      Defines the maximum size a log  file  can
223       grow to. Unit is megabytes. If the value is 0, the maximum file size is
224       unlimited.
225
226
227       --log-flush-frequency=5s      Maximum number  of  seconds  between  log
228       flushes
229
230
231       --logtostderr=true      log to standard error instead of files
232
233
234       --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
235            Comma-separated list of files to check  for  machine-id.  Use  the
236       first one that exists.
237
238
239       --match-server-version=false        Require  server  version  to  match
240       client version
241
242
243       -n, --namespace=""      If present, the namespace scope  for  this  CLI
244       request
245
246
247       --one-output=false      If true, only write logs to their native sever‐
248       ity level (vs also writing to each lower severity level)
249
250
251       --password=""      Password for basic authentication to the API server
252
253
254       --profile="none"        Name   of   profile   to   capture.   One    of
255       (none|cpu|heap|goroutine|threadcreate|block|mutex)
256
257
258       --profile-output="profile.pprof"       Name  of  the  file to write the
259       profile to
260
261
262       --referenced-reset-interval=0      Reset interval for referenced  bytes
263       (container_referenced_bytes metric), number of measurement cycles after
264       which referenced bytes are cleared, if set to 0  referenced  bytes  are
265       never cleared (default: 0)
266
267
268       --request-timeout="0"       The length of time to wait before giving up
269       on a single server request. Non-zero values  should  contain  a  corre‐
270       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
271       out requests.
272
273
274       -s, --server=""      The address and port of the Kubernetes API server
275
276
277       --skip-headers=false      If true, avoid header  prefixes  in  the  log
278       messages
279
280
281       --skip-log-headers=false       If  true, avoid headers when opening log
282       files
283
284
285       --stderrthreshold=2      logs at or above this threshold go to stderr
286
287
288       --storage-driver-buffer-duration=1m0s      Writes in the storage driver
289       will  be  buffered  for  this duration, and committed to the non memory
290       backends as a single transaction
291
292
293       --storage-driver-db="cadvisor"      database name
294
295
296       --storage-driver-host="localhost:8086"      database host:port
297
298
299       --storage-driver-password="root"      database password
300
301
302       --storage-driver-secure=false      use secure connection with database
303
304
305       --storage-driver-table="stats"      table name
306
307
308       --storage-driver-user="root"      database username
309
310
311       --tls-server-name=""      Server name to  use  for  server  certificate
312       validation.  If  it  is  not provided, the hostname used to contact the
313       server is used
314
315
316       --token=""      Bearer token for authentication to the API server
317
318
319       --update-machine-info-interval=5m0s      Interval between machine  info
320       updates.
321
322
323       --user=""      The name of the kubeconfig user to use
324
325
326       --username=""      Username for basic authentication to the API server
327
328
329       -v, --v=0      number for the log level verbosity
330
331
332       --version=false      Print version information and quit
333
334
335       --vmodule=        comma-separated   list   of  pattern=N  settings  for
336       file-filtered logging
337
338
339       --warnings-as-errors=false      Treat warnings received from the server
340       as errors and exit with a non-zero exit code
341
342
343

EXAMPLE

345                # Mark the nginx deployment as paused. Any current state of
346                # the deployment will continue its function, new updates to the deployment will not
347                # have an effect as long as the deployment is paused.
348                kubectl rollout pause deployment/nginx
349
350
351
352

SEE ALSO

354       kubectl-rollout(1),
355
356
357

HISTORY

359       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
360       com) based on the kubernetes source material, but hopefully  they  have
361       been automatically generated since!
362
363
364
365Manuals                              User            KUBERNETES(1)(kubernetes)
Impressum