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="unix:///var/run/containerd.sock"
81           containerd endpoint
82
83
84       --context=""
85           The name of the kubeconfig context to use
86
87
88       --default-not-ready-toleration-seconds=300
89           Indicates   the   tolerationSeconds   of   the    toleration    for
90       notReady:NoExecute  that is added by default to every pod that does not
91       already have such a toleration.
92
93
94       --default-unreachable-toleration-seconds=300
95           Indicates the tolerationSeconds  of  the  toleration  for  unreach‐
96       able:NoExecute  that  is  added  by  default to every pod that does not
97       already have such a toleration.
98
99
100       --docker="unix:///var/run/docker.sock"
101           docker endpoint
102
103
104       --docker-env-metadata-whitelist=""
105           a comma-separated list of environment variable keys that  needs  to
106       be collected for docker containers
107
108
109       --docker-only=false
110           Only report docker containers in addition to root stats
111
112
113       --docker-root="/var/lib/docker"
114           DEPRECATED:  docker  root is read from docker info (this is a fall‐
115       back, default: /var/lib/docker)
116
117
118       --docker-tls=false
119           use TLS to connect to docker
120
121
122       --docker-tls-ca="ca.pem"
123           path to trusted CA
124
125
126       --docker-tls-cert="cert.pem"
127           path to client certificate
128
129
130       --docker-tls-key="key.pem"
131           path to private key
132
133
134       --enable-load-reader=false
135           Whether to enable cpu load reader
136
137
138       --event-storage-age-limit="default=0"
139           Max length of time for which to store events (per type). Value is a
140       comma  separated  list  of  key  values, where the keys are event types
141       (e.g.: creation, oom) or "default" and the value is a duration. Default
142       is applied to all non-specified event types
143
144
145       --event-storage-event-limit="default=0"
146           Max  number  of  events to store (per type). Value is a comma sepa‐
147       rated list of key values, where the keys are event  types  (e.g.:  cre‐
148       ation,  oom)  or  "default"  and  the  value  is an integer. Default is
149       applied to all non-specified event types
150
151
152       --global-housekeeping-interval=1m0s
153           Interval between global housekeepings
154
155
156       --housekeeping-interval=10s
157           Interval between container housekeepings
158
159
160       --insecure-skip-tls-verify=false
161           If true, the server's certificate will not be checked for validity.
162       This will make your HTTPS connections insecure
163
164
165       --kubeconfig=""
166           Path to the kubeconfig file to use for CLI requests.
167
168
169       --log-backtrace-at=:0
170           when logging hits line file:N, emit a stack trace
171
172
173       --log-cadvisor-usage=false
174           Whether to log the usage of the cAdvisor container
175
176
177       --log-dir=""
178           If non-empty, write log files in this directory
179
180
181       --log-file=""
182           If non-empty, use this log file
183
184
185       --log-flush-frequency=5s
186           Maximum number of seconds between log flushes
187
188
189       --logtostderr=true
190           log to standard error instead of files
191
192
193       --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
194           Comma-separated  list  of  files  to  check for machine-id. Use the
195       first one that exists.
196
197
198       --match-server-version=false
199           Require server version to match client version
200
201
202       --mesos-agent="127.0.0.1:5051"
203           Mesos agent address
204
205
206       --mesos-agent-timeout=10s
207           Mesos agent timeout
208
209
210       -n, --namespace=""
211           If present, the namespace scope for this CLI request
212
213
214       --password=""
215           Password for basic authentication to the API server
216
217
218       --profile="none"
219           Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
220       create|block|mutex)
221
222
223       --profile-output="profile.pprof"
224           Name of the file to write the profile to
225
226
227       --request-timeout="0"
228           The  length  of  time  to  wait before giving up on a single server
229       request. Non-zero values should contain a corresponding time unit (e.g.
230       1s, 2m, 3h). A value of zero means don't timeout requests.
231
232
233       -s, --server=""
234           The address and port of the Kubernetes API server
235
236
237       --skip-headers=false
238           If true, avoid header prefixes in the log messages
239
240
241       --stderrthreshold=2
242           logs at or above this threshold go to stderr
243
244
245       --storage-driver-buffer-duration=1m0s
246           Writes  in  the  storage driver will be buffered for this duration,
247       and committed to the non memory backends as a single transaction
248
249
250       --storage-driver-db="cadvisor"
251           database name
252
253
254       --storage-driver-host="localhost:8086"
255           database host:port
256
257
258       --storage-driver-password="root"
259           database password
260
261
262       --storage-driver-secure=false
263           use secure connection with database
264
265
266       --storage-driver-table="stats"
267           table name
268
269
270       --storage-driver-user="root"
271           database username
272
273
274       --token=""
275           Bearer token for authentication to the API server
276
277
278       --user=""
279           The name of the kubeconfig user to use
280
281
282       --username=""
283           Username for basic authentication to the API server
284
285
286       -v, --v=0
287           log level for V logs
288
289
290       --version=false
291           Print version information and quit
292
293
294       --vmodule=
295           comma-separated list of pattern=N settings for  file-filtered  log‐
296       ging
297
298
299

SEE ALSO

301       kubectl-alpha(1),     kubectl-annotate(1),    kubectl-api-resources(1),
302       kubectl-api-versions(1),      kubectl-apply(1),      kubectl-attach(1),
303       kubectl-auth(1),      kubectl-autoscale(1),     kubectl-certificate(1),
304       kubectl-cluster-info(1),   kubectl-completion(1),    kubectl-config(1),
305       kubectl-convert(1),   kubectl-cordon(1),   kubectl-cp(1),  kubectl-cre‐
306       ate(1),   kubectl-delete(1),   kubectl-describe(1),    kubectl-diff(1),
307       kubectl-drain(1), kubectl-edit(1), kubectl-exec(1), kubectl-explain(1),
308       kubectl-expose(1), kubectl-get(1),  kubectl-label(1),  kubectl-logs(1),
309       kubectl-options(1),         kubectl-patch(1),        kubectl-plugin(1),
310       kubectl-port-forward(1),     kubectl-proxy(1),      kubectl-replace(1),
311       kubectl-rolling-update(1),      kubectl-rollout(1),     kubectl-run(1),
312       kubectl-scale(1),  kubectl-set(1),  kubectl-taint(1),   kubectl-top(1),
313       kubectl-uncordon(1), kubectl-version(1), kubectl-wait(1),
314
315
316

HISTORY

318       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
319       com) based on the kubernetes source material, but hopefully  they  have
320       been automatically generated since!
321
322
323
324Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum