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

NAME

6       kubectl - kubectl controls the Kubernetes cluster manager
7
8
9

SYNOPSIS

11       kubectl [OPTIONS]
12
13
14

DESCRIPTION

16       kubectl controls the Kubernetes cluster manager.
17
18
19       Find    more    information    at:   ⟨https://kubernetes.io/docs/refer‐
20       ence/kubectl/overview/⟩
21
22
23

OPTIONS

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

SEE ALSO

310       kubectl-alpha(1),    kubectl-annotate(1),     kubectl-api-resources(1),
311       kubectl-api-versions(1),      kubectl-apply(1),      kubectl-attach(1),
312       kubectl-auth(1),     kubectl-autoscale(1),      kubectl-certificate(1),
313       kubectl-cluster-info(1),    kubectl-completion(1),   kubectl-config(1),
314       kubectl-convert(1),  kubectl-cordon(1),   kubectl-cp(1),   kubectl-cre‐
315       ate(1),    kubectl-delete(1),   kubectl-describe(1),   kubectl-diff(1),
316       kubectl-drain(1), kubectl-edit(1), kubectl-exec(1), kubectl-explain(1),
317       kubectl-expose(1),         kubectl-get(1),        kubectl-kustomize(1),
318       kubectl-label(1),         kubectl-logs(1),          kubectl-options(1),
319       kubectl-patch(1),      kubectl-plugin(1),      kubectl-port-forward(1),
320       kubectl-proxy(1),    kubectl-replace(1),     kubectl-rolling-update(1),
321       kubectl-rollout(1),  kubectl-run(1),  kubectl-scale(1), kubectl-set(1),
322       kubectl-taint(1),  kubectl-top(1),  kubectl-uncordon(1),   kubectl-ver‐
323       sion(1), kubectl-wait(1),
324
325
326

HISTORY

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