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:
20       ⟨https://kubernetes.io/docs/reference/kubectl/overview/⟩
21
22
23

OPTIONS

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

SEE ALSO

327       kubectl-alpha(1), kubectl-annotate(1), kubectl-api-resources(1),
328       kubectl-api-versions(1), kubectl-apply(1), kubectl-attach(1),
329       kubectl-auth(1), kubectl-autoscale(1), kubectl-certificate(1),
330       kubectl-cluster-info(1), kubectl-completion(1), kubectl-config(1),
331       kubectl-convert(1), kubectl-cordon(1), kubectl-cp(1),
332       kubectl-create(1), kubectl-delete(1), kubectl-describe(1),
333       kubectl-diff(1), kubectl-drain(1), kubectl-edit(1), kubectl-exec(1),
334       kubectl-explain(1), kubectl-expose(1), kubectl-get(1),
335       kubectl-kustomize(1), kubectl-label(1), kubectl-logs(1),
336       kubectl-options(1), kubectl-patch(1), kubectl-plugin(1),
337       kubectl-port-forward(1), kubectl-proxy(1), kubectl-replace(1),
338       kubectl-rollout(1), kubectl-run(1), kubectl-scale(1), kubectl-set(1),
339       kubectl-taint(1), kubectl-top(1), kubectl-uncordon(1),
340       kubectl-version(1), kubectl-wait(1),
341
342
343

HISTORY

345       January 2015, Originally compiled by Eric Paris (eparis at redhat dot
346       com) based on the kubernetes source material, but hopefully they have
347       been automatically generated since!
348
349
350
351Eric Paris                  kubernetes User Manuals              KUBERNETES(1)