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       --insecure-skip-tls-verify=false      If true, the server's certificate
107       will not be checked for validity. This will make your HTTPS connections
108       insecure
109
110
111       --kubeconfig=""       Path  to  the  kubeconfig file to use for CLI re‐
112       quests.
113
114
115       --match-server-version=false       Require  server  version  to   match
116       client version
117
118
119       -n,  --namespace=""       If  present, the namespace scope for this CLI
120       request
121
122
123       --password=""      Password for basic authentication to the API server
124
125
126       --profile="none"        Name   of   profile   to   capture.   One    of
127       (none|cpu|heap|goroutine|threadcreate|block|mutex)
128
129
130       --profile-output="profile.pprof"       Name  of  the  file to write the
131       profile to
132
133
134       --request-timeout="0"      The length of time to wait before giving  up
135       on  a  single  server  request. Non-zero values should contain a corre‐
136       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
137       out requests.
138
139
140       -s, --server=""      The address and port of the Kubernetes API server
141
142
143       --tls-server-name=""       Server  name  to  use for server certificate
144       validation. If it is not provided, the hostname  used  to  contact  the
145       server is used
146
147
148       --token=""      Bearer token for authentication to the API server
149
150
151       --user=""      The name of the kubeconfig user to use
152
153
154       --username=""      Username for basic authentication to the API server
155
156
157       --version=false      Print version information and quit
158
159
160       --warnings-as-errors=false      Treat warnings received from the server
161       as errors and exit with a non-zero exit code
162
163
164

EXAMPLE

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

HISTORY

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