kubectl-explain(1)

1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl explain - Get documentation for a resource
10
11
12

SYNOPSIS

14       kubectl explain [OPTIONS]
15
16
17

DESCRIPTION

19       List the fields for supported resources.
20
21
22       This  command  describes  the fields associated with each supported API
23       resource. Fields are identified via a simple JSONPath identifier:
24
25
26       .[.]
27
28
29       Add the --recursive flag to display all of the fields at  once  without
30       descriptions. Information about each field is retrieved from the server
31       in OpenAPI format.
32
33
34       Use "kubectl api-resources" for a complete list of supported resources.
35
36
37

OPTIONS

39       --api-version=""      Get different  explanations  for  particular  API
40       version (API group/version)
41
42
43       --recursive=false       Print  the  fields  of fields (Currently only 1
44       level deep)
45
46
47

OPTIONS INHERITED FROM PARENT COMMANDS

49       --as=""      Username to impersonate for the operation. User could be a
50       regular user or a service account in a namespace.
51
52
53       --as-group=[]       Group  to  impersonate for the operation, this flag
54       can be repeated to specify multiple groups.
55
56
57       --as-uid=""      UID to impersonate for the operation.
58
59
60       --azure-container-registry-config=""      Path to the  file  containing
61       Azure container registry configuration information.
62
63
64       --cache-dir="/builddir/.kube/cache"      Default cache directory
65
66
67       --certificate-authority=""      Path to a cert file for the certificate
68       authority
69
70
71       --client-certificate=""      Path to a client certificate file for TLS
72
73
74       --client-key=""      Path to a client key file for TLS
75
76
77       --cluster=""      The name of the kubeconfig cluster to use
78
79
80       --context=""      The name of the kubeconfig context to use
81
82
83       --insecure-skip-tls-verify=false      If true, the server's certificate
84       will not be checked for validity. This will make your HTTPS connections
85       insecure
86
87
88       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
89       quests.
90
91
92       --match-server-version=false        Require  server  version  to  match
93       client version
94
95
96       -n, --namespace=""      If present, the namespace scope  for  this  CLI
97       request
98
99
100       --password=""      Password for basic authentication to the API server
101
102
103       --profile="none"         Name   of   profile   to   capture.   One   of
104       (none|cpu|heap|goroutine|threadcreate|block|mutex)
105
106
107       --profile-output="profile.pprof"      Name of the  file  to  write  the
108       profile to
109
110
111       --request-timeout="0"       The length of time to wait before giving up
112       on a single server request. Non-zero values  should  contain  a  corre‐
113       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
114       out requests.
115
116
117       -s, --server=""      The address and port of the Kubernetes API server
118
119
120       --tls-server-name=""      Server name to  use  for  server  certificate
121       validation.  If  it  is  not provided, the hostname used to contact the
122       server is used
123
124
125       --token=""      Bearer token for authentication to the API server
126
127
128       --user=""      The name of the kubeconfig user to use
129
130
131       --username=""      Username for basic authentication to the API server
132
133
134       --version=false      Print version information and quit
135
136
137       --warnings-as-errors=false      Treat warnings received from the server
138       as errors and exit with a non-zero exit code
139
140
141

EXAMPLE

143                # Get the documentation of the resource and its fields
144                kubectl explain pods
145
146                # Get the documentation of a specific field of a resource
147                kubectl explain pods.spec.containers
148
149
150
151

HISTORY

158       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
159       com) based on the kubernetes source material, but hopefully  they  have
160       been automatically generated since!
161
162
163
164Manuals                              User            KUBERNETES(1)(kubernetes)