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

EXAMPLE

325                # Print the supported API Resources
326                kubectl api-resources
327
328                # Print the supported API Resources with more information
329                kubectl api-resources -o wide
330
331                # Print the supported namespaced resources
332                kubectl api-resources --namespaced=true
333
334                # Print the supported non-namespaced resources
335                kubectl api-resources --namespaced=false
336
337                # Print the supported API Resources with specific APIGroup
338                kubectl api-resources --api-group=extensions
339
340
341
342

SEE ALSO

344       kubectl(1),
345
346
347

HISTORY

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