Show details of a specific resource or group of resources.
Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: $ kubectl describe TYPE NAME_PREFIX
will first check for an exact match on TYPE
and NAME_PREFIX
. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
.
Use kubectl api-resources
for a complete list of supported resources.
Syntax
werf kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) [options]
Examples
# Describe a node
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
# Describe a pod
kubectl describe pods/nginx
# Describe a pod identified by type and name in "pod.json"
kubectl describe -f pod.json
# Describe all pods
kubectl describe pods
# Describe pods by label name=myLabel
kubectl describe pods -l name=myLabel
# Describe all pods managed by the 'frontend' replication controller
# (rc-created pods get the name of the rc as a prefix in the pod name)
kubectl describe pods frontend
Options
-A, --all-namespaces=false
If present, list the requested object(s) across all namespaces. Namespace in current
context is ignored even if specified with --namespace.
--chunk-size=500
Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is
beta and may change in the future.
-f, --filename=[]
Filename, directory, or URL to files containing the resource to describe
-k, --kustomize=''
Process the kustomization directory. This flag can`t be used together with -f or -R.
-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you want to
manage related manifests organized within the same directory.
-l, --selector=''
Selector (label query) to filter on, supports `=`, `==`, and `!=`.(e.g. -l
key1=value1,key2=value2). Matching objects must satisfy all of the specified label
constraints.
--show-events=true
If true, display events related to the described object.
Options inherited from parent commands
--as=''
Username to impersonate for the operation. User could be a regular user or a service
account in a namespace.
--as-group=[]
Group to impersonate for the operation, this flag can be repeated to specify multiple
groups.
--as-uid=''
UID to impersonate for the operation.
--cache-dir='~/.kube/cache'
Default cache directory
--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 (default $WERF_KUBE_CONTEXT)
--disable-compression=false
If true, opt-out of response compression for all requests to the server
--home-dir=''
Use specified dir to store werf cache files and dirs (default $WERF_HOME or ~/.werf)
--insecure-skip-tls-verify=false
If true, the server`s certificate will not be checked for validity. This will make your
HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
--kube-config-base64=''
Kubernetes config data as base64 string (default $WERF_KUBE_CONFIG_BASE64 or
$WERF_KUBECONFIG_BASE64 or $KUBECONFIG_BASE64)
--kubeconfig=''
Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or
$WERF_KUBECONFIG, or $KUBECONFIG). Ignored if kubeconfig passed as base64.
--log-flush-frequency=5s
Maximum number of seconds between log flushes
--match-server-version=false
Require server version to match client version
-n, --namespace=''
If present, the namespace scope for this CLI request
--password=''
Password for basic authentication to the API server
--profile='none'
Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)
--profile-output='profile.pprof'
Name of the file to write the profile to
--request-timeout='0'
The length of time to wait before giving up on a single server request. Non-zero values
should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don`t
timeout requests.
-s, --server=''
The address and port of the Kubernetes API server
--tls-server-name=''
Server name to use for server certificate validation. If it is not provided, the
hostname used to contact the server is used
--tmp-dir=''
Use specified dir to store tmp files and dirs (default $WERF_TMP_DIR or system tmp dir)
--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, --v=0
number for the log level verbosity
--vmodule=
comma-separated list of pattern=N settings for file-filtered logging (only works for
the default text log format)
--warnings-as-errors=false
Treat warnings received from the server as errors and exit with a non-zero exit code