1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl - kubectl controls the Kubernetes cluster manager
10
11
12

SYNOPSIS

14       kubectl [OPTIONS]
15
16
17

DESCRIPTION

19       kubectl controls the Kubernetes cluster manager.
20
21
22       Find    more    information    at:    https://kubernetes.io/docs/refer‐
23       ence/kubectl/overview/
24
25
26

OPTIONS

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

SEE ALSO

306       kubectl-alpha(1),    kubectl-annotate(1),     kubectl-api-resources(1),
307       kubectl-api-versions(1),      kubectl-apply(1),      kubectl-attach(1),
308       kubectl-auth(1),     kubectl-autoscale(1),      kubectl-certificate(1),
309       kubectl-cluster-info(1),    kubectl-completion(1),   kubectl-config(1),
310       kubectl-cordon(1), kubectl-cp(1), kubectl-create(1),  kubectl-debug(1),
311       kubectl-delete(1),         kubectl-describe(1),        kubectl-diff(1),
312       kubectl-drain(1), kubectl-edit(1), kubectl-exec(1), kubectl-explain(1),
313       kubectl-expose(1),  kubectl-get(1),  kubectl-kustomize(1),  kubectl-la‐
314       bel(1),    kubectl-logs(1),    kubectl-options(1),    kubectl-patch(1),
315       kubectl-plugin(1),      kubectl-port-forward(1),      kubectl-proxy(1),
316       kubectl-replace(1),         kubectl-rollout(1),         kubectl-run(1),
317       kubectl-scale(1),   kubectl-set(1),  kubectl-taint(1),  kubectl-top(1),
318       kubectl-uncordon(1), kubectl-version(1), kubectl-wait(1),
319
320
321

HISTORY

323       January 2015, Originally compiled by Eric Paris (eparis at  redhat  dot
324       com)  based  on the kubernetes source material, but hopefully they have
325       been automatically generated since!
326
327
328
329Manuals                              User            KUBERNETES(1)(kubernetes)