81 lines
3.0 KiB
Markdown
81 lines
3.0 KiB
Markdown
---
|
|
---
|
|
|
|
## kubectl explain
|
|
|
|
Documentation of resources.
|
|
|
|
### Synopsis
|
|
|
|
|
|
Documentation of resources.
|
|
|
|
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
|
|
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
|
|
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
|
|
serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
|
|
componentstatuses (cs), endpoints (ep), and secrets.
|
|
|
|
```
|
|
kubectl explain RESOURCE
|
|
```
|
|
|
|
### Examples
|
|
|
|
```
|
|
# Get the documentation of the resource and its fields
|
|
kubectl explain pods
|
|
|
|
# Get the documentation of a specific field of a resource
|
|
kubectl explain pods.spec.containers
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
--include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true]
|
|
--recursive[=false]: Print the fields of fields (Currently only 1 level deep)
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
--alsologtostderr[=false]: log to standard error as well as files
|
|
--as="": Username to impersonate for the operation.
|
|
--certificate-authority="": Path to a cert. file for the certificate authority.
|
|
--client-certificate="": Path to a client certificate file for TLS.
|
|
--client-key="": Path to a client key file for TLS.
|
|
--cluster="": The name of the kubeconfig cluster to use
|
|
--context="": The name of the kubeconfig context to use
|
|
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
|
|
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
|
|
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
|
|
--log-dir="": If non-empty, write log files in this directory
|
|
--log-flush-frequency=5s: Maximum number of seconds between log flushes
|
|
--logtostderr[=true]: log to standard error instead of files
|
|
--match-server-version[=false]: Require server version to match client version
|
|
--namespace="": If present, the namespace scope for this CLI request.
|
|
--password="": Password for basic authentication to the API server.
|
|
-s, --server="": The address and port of the Kubernetes API server
|
|
--stderrthreshold=2: logs at or above this threshold go to stderr
|
|
--token="": Bearer token for authentication to the API server.
|
|
--user="": The name of the kubeconfig user to use
|
|
--username="": Username for basic authentication to the API server.
|
|
--v=0: log level for V logs
|
|
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
|
|
```
|
|
|
|
### SEE ALSO
|
|
|
|
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
|
|
|
|
###### Auto generated by spf13/cobra on 12-Aug-2016
|
|
|
|
|
|
|
|
|
|
|
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
|
[]()
|
|
<!-- END MUNGE: GENERATED_ANALYTICS -->
|