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

NAME

6       kubectl plugin - Provides utilities for interacting with plugins.
7
8
9

SYNOPSIS

11       kubectl plugin [OPTIONS]
12
13
14

DESCRIPTION

16       Provides utilities for interacting with plugins.
17
18
19       Plugins provide extended functionality that is not part of the major
20       command-line distribution. Please refer to the documentation and
21       examples for more information about how write your own plugins.
22
23
24       The easiest way to discover and install plugins is via the kubernetes
25       sub-project krew. To install krew,
26       visithttps://github.com/kubernetes-sigs/krew/#installation
27
28
29

OPTIONS INHERITED FROM PARENT COMMANDS

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

SEE ALSO

333       kubectl(1), kubectl-plugin-list(1),
334
335
336

HISTORY

338       January 2015, Originally compiled by Eric Paris (eparis at redhat dot
339       com) based on the kubernetes source material, but hopefully they have
340       been automatically generated since!
341
342
343
344Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum