mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-10-31 13:50:01 +00:00
238 lines
6.4 KiB
Groff
238 lines
6.4 KiB
Groff
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
|
|
|
|
|
|
.SH NAME
|
|
.PP
|
|
kubectl get \- Display one or many resources
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBkubectl get\fP [OPTIONS]
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
Display one or many resources.
|
|
|
|
.PP
|
|
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.
|
|
|
|
.PP
|
|
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).
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB\-\-all\-namespaces\fP=false
|
|
If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace.
|
|
|
|
.PP
|
|
\fB\-\-export\fP=false
|
|
If true, use 'export' for the resources. Exported resources are stripped of cluster\-specific information.
|
|
|
|
.PP
|
|
\fB\-f\fP, \fB\-\-filename\fP=[]
|
|
Filename, directory, or URL to a file identifying the resource to get from a server.
|
|
|
|
.PP
|
|
\fB\-\-include\-extended\-apis\fP=true
|
|
If true, include definitions of new APIs via calls to the API server. [default true]
|
|
|
|
.PP
|
|
\fB\-L\fP, \fB\-\-label\-columns\fP=[]
|
|
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...
|
|
|
|
.PP
|
|
\fB\-\-no\-headers\fP=false
|
|
When using the default output, don't print headers.
|
|
|
|
.PP
|
|
\fB\-o\fP, \fB\-\-output\fP=""
|
|
Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [
|
|
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [
|
|
\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]].
|
|
|
|
.PP
|
|
\fB\-\-output\-version\fP=""
|
|
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
|
|
|
.PP
|
|
\fB\-R\fP, \fB\-\-recursive\fP=false
|
|
If true, process directory recursively.
|
|
|
|
.PP
|
|
\fB\-l\fP, \fB\-\-selector\fP=""
|
|
Selector (label query) to filter on
|
|
|
|
.PP
|
|
\fB\-a\fP, \fB\-\-show\-all\fP=false
|
|
When printing, show all resources (default hide terminated pods.)
|
|
|
|
.PP
|
|
\fB\-\-show\-labels\fP=false
|
|
When printing, show all labels as the last column (default hide labels column)
|
|
|
|
.PP
|
|
\fB\-\-sort\-by\fP=""
|
|
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.
|
|
|
|
.PP
|
|
\fB\-\-template\fP=""
|
|
Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [
|
|
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]].
|
|
|
|
.PP
|
|
\fB\-w\fP, \fB\-\-watch\fP=false
|
|
After listing/getting the requested object, watch for changes.
|
|
|
|
.PP
|
|
\fB\-\-watch\-only\fP=false
|
|
Watch for changes to the requested object(s), without listing/getting first.
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.PP
|
|
\fB\-\-alsologtostderr\fP=false
|
|
log to standard error as well as files
|
|
|
|
.PP
|
|
\fB\-\-api\-version\fP=""
|
|
DEPRECATED: The API version to use when talking to the server
|
|
|
|
.PP
|
|
\fB\-\-as\fP=""
|
|
Username to impersonate for the operation.
|
|
|
|
.PP
|
|
\fB\-\-certificate\-authority\fP=""
|
|
Path to a cert. file for the certificate authority.
|
|
|
|
.PP
|
|
\fB\-\-client\-certificate\fP=""
|
|
Path to a client certificate file for TLS.
|
|
|
|
.PP
|
|
\fB\-\-client\-key\fP=""
|
|
Path to a client key file for TLS.
|
|
|
|
.PP
|
|
\fB\-\-cluster\fP=""
|
|
The name of the kubeconfig cluster to use
|
|
|
|
.PP
|
|
\fB\-\-context\fP=""
|
|
The name of the kubeconfig context to use
|
|
|
|
.PP
|
|
\fB\-\-insecure\-skip\-tls\-verify\fP=false
|
|
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
|
|
|
|
.PP
|
|
\fB\-\-kubeconfig\fP=""
|
|
Path to the kubeconfig file to use for CLI requests.
|
|
|
|
.PP
|
|
\fB\-\-log\-backtrace\-at\fP=:0
|
|
when logging hits line file:N, emit a stack trace
|
|
|
|
.PP
|
|
\fB\-\-log\-dir\fP=""
|
|
If non\-empty, write log files in this directory
|
|
|
|
.PP
|
|
\fB\-\-log\-flush\-frequency\fP=5s
|
|
Maximum number of seconds between log flushes
|
|
|
|
.PP
|
|
\fB\-\-logtostderr\fP=true
|
|
log to standard error instead of files
|
|
|
|
.PP
|
|
\fB\-\-match\-server\-version\fP=false
|
|
Require server version to match client version
|
|
|
|
.PP
|
|
\fB\-\-namespace\fP=""
|
|
If present, the namespace scope for this CLI request.
|
|
|
|
.PP
|
|
\fB\-\-password\fP=""
|
|
Password for basic authentication to the API server.
|
|
|
|
.PP
|
|
\fB\-s\fP, \fB\-\-server\fP=""
|
|
The address and port of the Kubernetes API server
|
|
|
|
.PP
|
|
\fB\-\-stderrthreshold\fP=2
|
|
logs at or above this threshold go to stderr
|
|
|
|
.PP
|
|
\fB\-\-token\fP=""
|
|
Bearer token for authentication to the API server.
|
|
|
|
.PP
|
|
\fB\-\-user\fP=""
|
|
The name of the kubeconfig user to use
|
|
|
|
.PP
|
|
\fB\-\-username\fP=""
|
|
Username for basic authentication to the API server.
|
|
|
|
.PP
|
|
\fB\-\-v\fP=0
|
|
log level for V logs
|
|
|
|
.PP
|
|
\fB\-\-vmodule\fP=
|
|
comma\-separated list of pattern=N settings for file\-filtered logging
|
|
|
|
|
|
.SH EXAMPLE
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
# 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
|
|
|
|
.fi
|
|
.RE
|
|
|
|
|
|
.SH SEE ALSO
|
|
.PP
|
|
\fBkubectl(1)\fP,
|
|
|
|
|
|
.SH HISTORY
|
|
.PP
|
|
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!
|