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       --template=""      Template string or path to template file to use when
57       -o=go-template, -o=go-template-file. The template format is golang tem‐
58       plates [http://golang.org/pkg/text/template/#pkg-overview].
59
60
61

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

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

SEE ALSO

350       kubectl-rollout(1),
351
352
353

HISTORY

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