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  exam‐
21       ples for more information about how write your own plugins.
22
23
24

OPTIONS INHERITED FROM PARENT COMMANDS

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

SEE ALSO

302       kubectl(1), kubectl-plugin-list(1),
303
304
305

HISTORY

307       January 2015, Originally compiled by Eric Paris (eparis at  redhat  dot
308       com)  based  on the kubernetes source material, but hopefully they have
309       been automatically generated since!
310
311
312
313Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum