openshift-kube-describe man page

openshift kube describe — Show details of a specific resource or group of resources

Synopsis

openshift kube describe [Options]

Description

Show details of a specific resource or group of resources. This command joins many API calls together to form a detailed description of a given resource or group of resources.

$ 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.

Valid resource types include:

· buildconfigs (aka 'bc')

· builds

· clusters (valid only for federation apiservers)

· componentstatuses (aka 'cs')

· configmaps (aka 'cm')

· daemonsets (aka 'ds')

· deployments (aka 'deploy')

· deploymentconfigs (aka 'dc')

· endpoints (aka 'ep')

· events (aka 'ev')

· horizontalpodautoscalers (aka 'hpa')

· imagestreamimages (aka 'isimage')

· imagestreams (aka 'is')

· imagestreamtags (aka 'istag')

· ingresses (aka 'ing')

· groups

· jobs

· limitranges (aka 'limits')

· namespaces (aka 'ns')

· networkpolicies

· nodes (aka 'no')

· persistentvolumeclaims (aka 'pvc')

· persistentvolumes (aka 'pv')

· pods (aka 'po')

· podsecuritypolicies (aka 'psp')

· podtemplates

· policies

· projects

· replicasets (aka 'rs')

· replicationcontrollers (aka 'rc')

· resourcequotas (aka 'quota')

· rolebindings

· routes

· secrets

· serviceaccounts (aka 'sa')

· services (aka 'svc')

· statefulsets

· users

· storageclasses

· thirdpartyresources

Options

--all-namespaces=false

If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.

-f, --filename=[]

Filename, directory, or URL to files containing the resource to describe

--include-extended-apis=true

If true, include definitions of new APIs via calls to the API server. [default true]

-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

--show-events=true

If true, display events related to the described object.

Options Inherited from Parent Commands

--allow-verification-with-non-compliant-keys=false

Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.

--alsologtostderr=false

log to standard error as well as files

--api-version=""

DEPRECATED: The API version to use when talking to the server

--application-metrics-count-limit=100

Max number of application metrics to store (per container)

--as=""

Username to impersonate for the operation

--azure-container-registry-config=""

Path to the file container Azure container registry configuration information.

--boot-id-file="/proc/sys/kernel/random/boot_id"

Comma-separated list of files to check for boot-id. Use the first one that exists.

--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

--config=""

Path to the config file to use for CLI requests.

--container-hints="/etc/cadvisor/container_hints.json"

location of the container hints file

--context=""

The name of the kubeconfig context to use

--docker="unix:///var/run/docker.sock"

docker endpoint

--docker-env-metadata-whitelist=""

a comma-separated list of environment variable keys that needs to be collected for docker containers

--docker-only=false

Only report docker containers in addition to root stats

--docker-root="/var/lib/docker"

DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)

--enable-load-reader=false

Whether to enable cpu load reader

--event-storage-age-limit="default=0"

Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types

--event-storage-event-limit="default=0"

Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types

--global-housekeeping-interval=0

Interval between global housekeepings

--google-json-key=""

The Google Cloud Platform Service Account JSON Key to use for authentication.

--housekeeping-interval=0

Interval between container housekeepings

--httptest.serve=""

if non-empty, httptest.NewServer serves on this address and blocks

--insecure-skip-tls-verify=false

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--ir-data-source="influxdb"

Data source used by InitialResources. Supported options: influxdb, gcm.

--ir-dbname="k8s"

InfluxDB database name which contains metrics required by InitialResources

--ir-hawkular=""

Hawkular configuration URL

--ir-influxdb-host="localhost:8080/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb:api"

Address of InfluxDB which contains metrics required by InitialResources

--ir-namespace-only=false

Whether the estimation should be made only based on data from the same namespace.

--ir-password="root"

Password used for connecting to InfluxDB

--ir-percentile=90

Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.

--ir-user="root"

User used for connecting to InfluxDB

--kubeconfig=""

Specify a kubeconfig file to define the configuration

--log-backtrace-at=:0

when logging hits line file:N, emit a stack trace

--log-cadvisor-usage=false

Whether to log the usage of the cAdvisor container

--log-dir=""

If non-empty, write log files in this directory

--log-flush-frequency=0

Maximum number of seconds between log flushes

--logtostderr=true

log to standard error instead of files

--machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"

Comma-separated list of files to check for machine-id. Use the first one that exists.

--match-server-version=false

Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request

--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.

--server=""

The address and port of the Kubernetes API server

--stderrthreshold=2

logs at or above this threshold go to stderr

--storage-driver-buffer-duration=0

Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

--storage-driver-db="cadvisor"

database name

--storage-driver-host="localhost:8086"

database host:port

--storage-driver-password="root"

database password

--storage-driver-secure=false

use secure connection with database

--storage-driver-table="stats"

table name

--storage-driver-user="root"

database username

--token=""

Bearer token for authentication to the API server

--user=""

The name of the kubeconfig user to use

-v, --v=0

log level for V logs

--vmodule=

comma-separated list of pattern=N settings for file-filtered logging

Example

  # 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 po -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 the name).
  kubectl describe pods frontend

See Also

openshift-kube(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-kube(1).

Openshift CLI User Manuals June 2016