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       -o, --output=""
38           Output   format.   One    of:    json|yaml|name|go-template|go-tem‐
39       plate-file|template|templatefile|jsonpath|jsonpath-file.
40
41
42       -R, --recursive=false
43           Process  the  directory  used in -f, --filename recursively. Useful
44       when you want to manage related manifests  organized  within  the  same
45       directory.
46
47
48       --template=""
49           Template  string  or  path  to template file to use when -o=go-tem‐
50       plate, -o=go-template-file. The template format is golang  templates  [
51http://golang.org/pkg/text/template/#pkg-overview⟩].
52
53
54

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

332                # Mark the nginx deployment as paused. Any current state of
333                # the deployment will continue its function, new updates to the deployment will not
334                # have an effect as long as the deployment is paused.
335                kubectl rollout pause deployment/nginx
336
337
338
339

SEE ALSO

341       kubectl-rollout(1),
342
343
344

HISTORY

346       January 2015, Originally compiled by Eric Paris (eparis at  redhat  dot
347       com)  based  on the kubernetes source material, but hopefully they have
348       been automatically generated since!
349
350
351
352Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum