kubectl-rollout-pause(1)

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, jsonpath-as-
48       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       -l, --selector=""      Selector (label query) to  filter  on,  supports
57       '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects
58       must satisfy all of the specified label constraints.
59
60
61       --show-managed-fields=false      If true, keep the  managedFields  when
62       printing objects in JSON or YAML format.
63
64
65       --template=""      Template string or path to template file to use when
66       -o=go-template, -o=go-template-file. The template format is golang tem‐
67       plates [http://golang.org/pkg/text/template/#pkg-overview].
68
69
70

OPTIONS INHERITED FROM PARENT COMMANDS

72       --as=""      Username to impersonate for the operation. User could be a
73       regular user or a service account in a namespace.
74
75
76       --as-group=[]      Group to impersonate for the  operation,  this  flag
77       can be repeated to specify multiple groups.
78
79
80       --as-uid=""      UID to impersonate for the operation.
81
82
83       --azure-container-registry-config=""       Path  to the file containing
84       Azure container registry configuration information.
85
86
87       --cache-dir="/builddir/.kube/cache"      Default cache directory
88
89
90       --certificate-authority=""      Path to a cert file for the certificate
91       authority
92
93
94       --client-certificate=""      Path to a client certificate file for TLS
95
96
97       --client-key=""      Path to a client key file for TLS
98
99
100       --cluster=""      The name of the kubeconfig cluster to use
101
102
103       --context=""      The name of the kubeconfig context to use
104
105
106       --disable-compression=false       If true, opt-out of response compres‐
107       sion for all requests to the server
108
109
110       --insecure-skip-tls-verify=false      If true, the server's certificate
111       will not be checked for validity. This will make your HTTPS connections
112       insecure
113
114
115       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
116       quests.
117
118
119       --match-server-version=false        Require  server  version  to  match
120       client version
121
122
123       -n, --namespace=""      If present, the namespace scope  for  this  CLI
124       request
125
126
127       --password=""      Password for basic authentication to the API server
128
129
130       --profile="none"         Name   of   profile   to   capture.   One   of
131       (none|cpu|heap|goroutine|threadcreate|block|mutex)
132
133
134       --profile-output="profile.pprof"      Name of the  file  to  write  the
135       profile to
136
137
138       --request-timeout="0"       The length of time to wait before giving up
139       on a single server request. Non-zero values  should  contain  a  corre‐
140       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
141       out requests.
142
143
144       -s, --server=""      The address and port of the Kubernetes API server
145
146
147       --tls-server-name=""      Server name to  use  for  server  certificate
148       validation.  If  it  is  not provided, the hostname used to contact the
149       server is used
150
151
152       --token=""      Bearer token for authentication to the API server
153
154
155       --user=""      The name of the kubeconfig user to use
156
157
158       --username=""      Username for basic authentication to the API server
159
160
161       --version=false      Print version information and quit
162
163
164       --warnings-as-errors=false      Treat warnings received from the server
165       as errors and exit with a non-zero exit code
166
167
168

EXAMPLE

170                # Mark the nginx deployment as paused
171                # Any current state of the deployment will continue its function; new updates
172                # to the deployment will not have an effect as long as the deployment is paused
173                kubectl rollout pause deployment/nginx
174
175
176
177

HISTORY

184       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
185       com) based on the kubernetes source material, but hopefully  they  have
186       been automatically generated since!
187
188
189
190Manuals                              User            KUBERNETES(1)(kubernetes)