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|template|go-template|go-tem‐
39       plate-file|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       --allow-verification-with-non-compliant-keys=false
57           Allow  a  SignatureVerifier  to  use  keys  which  are  technically
58       non-compliant with RFC6962.
59
60
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="unix:///var/run/containerd.sock"
117           containerd endpoint
118
119
120       --context=""
121           The name of the kubeconfig context to use
122
123
124       --default-not-ready-toleration-seconds=300
125           Indicates   the   tolerationSeconds   of   the    toleration    for
126       notReady:NoExecute  that is added by default to every pod that does not
127       already have such a toleration.
128
129
130       --default-unreachable-toleration-seconds=300
131           Indicates the tolerationSeconds  of  the  toleration  for  unreach‐
132       able:NoExecute  that  is  added  by  default to every pod that does not
133       already have such a toleration.
134
135
136       --docker="unix:///var/run/docker.sock"
137           docker endpoint
138
139
140       --docker-env-metadata-whitelist=""
141           a comma-separated list of environment variable keys that  needs  to
142       be collected for docker containers
143
144
145       --docker-only=false
146           Only report docker containers in addition to root stats
147
148
149       --docker-root="/var/lib/docker"
150           DEPRECATED:  docker  root is read from docker info (this is a fall‐
151       back, default: /var/lib/docker)
152
153
154       --docker-tls=false
155           use TLS to connect to docker
156
157
158       --docker-tls-ca="ca.pem"
159           path to trusted CA
160
161
162       --docker-tls-cert="cert.pem"
163           path to client certificate
164
165
166       --docker-tls-key="key.pem"
167           path to private key
168
169
170       --enable-load-reader=false
171           Whether to enable cpu load reader
172
173
174       --event-storage-age-limit="default=0"
175           Max length of time for which to store events (per type). Value is a
176       comma  separated  list  of  key  values, where the keys are event types
177       (e.g.: creation, oom) or "default" and the value is a duration. Default
178       is applied to all non-specified event types
179
180
181       --event-storage-event-limit="default=0"
182           Max  number  of  events to store (per type). Value is a comma sepa‐
183       rated list of key values, where the keys are event  types  (e.g.:  cre‐
184       ation,  oom)  or  "default"  and  the  value  is an integer. Default is
185       applied to all non-specified event types
186
187
188       --global-housekeeping-interval=1m0s
189           Interval between global housekeepings
190
191
192       --google-json-key=""
193           The Google Cloud Platform Service  Account  JSON  Key  to  use  for
194       authentication.
195
196
197       --housekeeping-interval=10s
198           Interval between container housekeepings
199
200
201       --insecure-skip-tls-verify=false
202           If true, the server's certificate will not be checked for validity.
203       This will make your HTTPS connections insecure
204
205
206       --kubeconfig=""
207           Path to the kubeconfig file to use for CLI requests.
208
209
210       --log-backtrace-at=:0
211           when logging hits line file:N, emit a stack trace
212
213
214       --log-cadvisor-usage=false
215           Whether to log the usage of the cAdvisor container
216
217
218       --log-dir=""
219           If non-empty, write log files in this directory
220
221
222       --log-flush-frequency=5s
223           Maximum number of seconds between log flushes
224
225
226       --logtostderr=true
227           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
236           Require server version to match client version
237
238
239       --mesos-agent="127.0.0.1:5051"
240           Mesos agent address
241
242
243       --mesos-agent-timeout=10s
244           Mesos agent timeout
245
246
247       -n, --namespace=""
248           If present, the namespace scope for this CLI request
249
250
251       --request-timeout="0"
252           The  length  of  time  to  wait before giving up on a single server
253       request. Non-zero values should contain a corresponding time unit (e.g.
254       1s, 2m, 3h). A value of zero means don't timeout requests.
255
256
257       -s, --server=""
258           The address and port of the Kubernetes API server
259
260
261       --stderrthreshold=2
262           logs at or above this threshold go to stderr
263
264
265       --storage-driver-buffer-duration=1m0s
266           Writes  in  the  storage driver will be buffered for this duration,
267       and committed to the non memory backends as a single transaction
268
269
270       --storage-driver-db="cadvisor"
271           database name
272
273
274       --storage-driver-host="localhost:8086"
275           database host:port
276
277
278       --storage-driver-password="root"
279           database password
280
281
282       --storage-driver-secure=false
283           use secure connection with database
284
285
286       --storage-driver-table="stats"
287           table name
288
289
290       --storage-driver-user="root"
291           database username
292
293
294       --token=""
295           Bearer token for authentication to the API server
296
297
298       --user=""
299           The name of the kubeconfig user to use
300
301
302       -v, --v=0
303           log level for V logs
304
305
306       --version=false
307           Print version information and quit
308
309
310       --vmodule=
311           comma-separated list of pattern=N settings for  file-filtered  log‐
312       ging
313
314
315

EXAMPLE

317                # Mark the nginx deployment as paused. Any current state of
318                # the deployment will continue its function, new updates to the deployment will not
319                # have an effect as long as the deployment is paused.
320                kubectl rollout pause deployment/nginx
321
322
323
324

SEE ALSO

326       kubectl-rollout(1),
327
328
329

HISTORY

331       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
332       com) based on the kubernetes source material, but hopefully  they  have
333       been automatically generated since!
334
335
336
337Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum