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

NAME

6       kubectl api-resources - Print the supported API resources on the server
7
8
9

SYNOPSIS

11       kubectl api-resources [OPTIONS]
12
13
14

DESCRIPTION

16       Print the supported API resources on the server
17
18
19

OPTIONS

21       --api-group=""
22           Limit to resources in the specified API group.
23
24
25       --cached=false
26           Use the cached list of resources if available.
27
28
29       --namespaced=true
30           If  false,  non-namespaced  resources  will  be returned, otherwise
31       returning namespaced resources by default.
32
33
34       --no-headers=false
35           When using the default or custom-column output format, don't  print
36       headers (default print headers).
37
38
39       -o, --output=""
40           Output format. One of: wide|name.
41
42
43       --verbs=[]
44           Limit to resources that support the specified verbs.
45
46
47

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

334                # Print the supported API Resources
335                kubectl api-resources
336
337                # Print the supported API Resources with more information
338                kubectl api-resources -o wide
339
340                # Print the supported namespaced resources
341                kubectl api-resources --namespaced=true
342
343                # Print the supported non-namespaced resources
344                kubectl api-resources --namespaced=false
345
346                # Print the supported API Resources with specific APIGroup
347                kubectl api-resources --api-group=extensions
348
349
350
351

SEE ALSO

353       kubectl(1),
354
355
356

HISTORY

358       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
359       com) based on the kubernetes source material, but hopefully  they  have
360       been automatically generated since!
361
362
363
364Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum