1KUBERNETES(1)                      Jan 2015                      KUBERNETES(1)
2
3
4

NAME

6       kubectl rollout pause - Mark the provided resource as paused
7
8
9

SYNOPSIS

11       kubectl rollout pause [OPTIONS]
12
13
14

DESCRIPTION

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

OPTIONS

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

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

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

SEE ALSO

355       kubectl-rollout(1),
356
357
358

HISTORY

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