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