openshift-kube-get man page

openshift kube get — Display one or many resources

Synopsis

openshift kube get [Options]

Description

Display one or many 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.

By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resource(s).

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.
--export=false
If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information.
-f, --filename=[]
Filename, directory, or URL to a file identifying the resource to get from a server.
--include-extended-apis=true
If true, include definitions of new APIs via calls to the API server. [default true]
-L, --label-columns=[]
Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag statements like -L label1 -L label2...
--no-headers=false
When using the default output, don't print headers.
-o, --output=""
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs…⟩].
--output-version=""
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--raw=""
Raw URI to request from the server. Uses the transport specified by the kubeconfig file.
-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
-a, --show-all=false
When printing, show all resources (default hide terminated pods.)
--show-kind=false
If present, list the kind of each requested resource.
--show-labels=false
When printing, show all labels as the last column (default hide labels column)
--sort-by=""
If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
--template=""
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pk…⟩].
-w, --watch=false
After listing/getting the requested object, watch for changes.
--watch-only=false
Watch for changes to the requested object(s), without listing/getting first.

Options Inherited from Parent Commands

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

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

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

# List all pods in ps output format.
kubectl get pods

# List all pods in ps output format with more information (such as node name).
kubectl get pods -o wide

# List a single replication controller with specified NAME in ps output format.
kubectl get replicationcontroller web

# List a single pod in JSON output format.
kubectl get -o json pod web-pod-13je7

# List a pod identified by type and name specified in "pod.yaml" in JSON output format.
kubectl get -f pod.yaml -o json

# Return only the phase value of the specified pod.
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}

# List all replication controllers and services together in ps output format.
kubectl get rc,services

# List one or more resources by their type and names.
kubectl get rc/web service/frontend pods/web-pod-13je7

See Also

openshift-kube(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-kube(1).

Openshift CLI User Manuals Openshift June 2016