github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/man/man1/kubectl-logs.1

183 lines
4.0 KiB
Groff
Raw Normal View History

automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
kubectl logs \- Print the logs for a container in a pod.
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.SH SYNOPSIS
.PP
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
\fBkubectl logs\fP [OPTIONS]
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.SH DESCRIPTION
.PP
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
.SH OPTIONS
Enable -c for kubectl logs container arg
2015-06-30 00:48:00 +00:00
.PP
\fB\-c\fP, \fB\-\-container\fP=""
Container name
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
.PP
\fB\-f\fP, \fB\-\-follow\fP=false
Specify if the logs should be streamed.
Prompt the user to select a container if they don't provide one and we can't infer it.
2015-02-24 14:50:22 +00:00
.PP
\fB\-\-interactive\fP=true
If true, prompt the user for input when required. Default true.
Support extended pod logging options Increase the supported controls on pod logging. Add validaiton to pod log options. Ensure the Kubelet is using a consistent, structured way to process pod log arguments. Add ?sinceSeconds=<durationInSeconds>, &sinceTime=<RFC3339>, ?timestamps=<bool>, ?tailLines=<number>, and ?limitBytes=<number>
2015-09-10 03:46:11 +00:00
.PP
\fB\-\-limit\-bytes\fP=0
Maximum bytes of logs to return. Defaults to no limit.
Introduce --previous option to kubectl log
2015-04-22 22:35:49 +00:00
.PP
\fB\-p\fP, \fB\-\-previous\fP=false
If true, print the logs for the previous instance of the container in a pod if it exists.
Support extended pod logging options Increase the supported controls on pod logging. Add validaiton to pod log options. Ensure the Kubelet is using a consistent, structured way to process pod log arguments. Add ?sinceSeconds=<durationInSeconds>, &sinceTime=<RFC3339>, ?timestamps=<bool>, ?tailLines=<number>, and ?limitBytes=<number>
2015-09-10 03:46:11 +00:00
.PP
\fB\-\-since\fP=0
Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since\-time / since may be used.
.PP
\fB\-\-since\-time\fP=""
Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since\-time / since may be used.
.PP
\fB\-\-tail\fP=\-1
Lines of recent log file to display. Defaults to \-1, showing all log lines.
.PP
\fB\-\-timestamps\fP=false
Include timestamps on each line in the log output
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key 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
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
\fB\-\-log\-backtrace\-at\fP=:0
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
when logging hits line file:N, emit a stack trace
.PP
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
\fB\-\-log\-dir\fP=""
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
If non\-empty, write log files in this directory
.PP
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
\fB\-\-log\-flush\-frequency\fP=5s
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
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
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.PP
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
.SH EXAMPLE
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.PP
.RS
.nf
Support extended pod logging options Increase the supported controls on pod logging. Add validaiton to pod log options. Ensure the Kubelet is using a consistent, structured way to process pod log arguments. Add ?sinceSeconds=<durationInSeconds>, &sinceTime=<RFC3339>, ?timestamps=<bool>, ?tailLines=<number>, and ?limitBytes=<number>
2015-09-10 03:46:11 +00:00
# Return snapshot logs from pod nginx with only one container
$ kubectl logs nginx
# Return snapshot of previous terminated ruby container logs from pod web\-1
$ kubectl logs \-p \-c ruby web\-1
# Begin streaming the logs of the ruby container in pod web\-1
$ kubectl logs \-f \-c ruby web\-1
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
Support extended pod logging options Increase the supported controls on pod logging. Add validaiton to pod log options. Ensure the Kubelet is using a consistent, structured way to process pod log arguments. Add ?sinceSeconds=<durationInSeconds>, &sinceTime=<RFC3339>, ?timestamps=<bool>, ?tailLines=<number>, and ?limitBytes=<number>
2015-09-10 03:46:11 +00:00
# Display only the most recent 20 lines of output in pod nginx
$ kubectl logs \-\-tail=20 nginx
Introduce --previous option to kubectl log
2015-04-22 22:35:49 +00:00
Support extended pod logging options Increase the supported controls on pod logging. Add validaiton to pod log options. Ensure the Kubelet is using a consistent, structured way to process pod log arguments. Add ?sinceSeconds=<durationInSeconds>, &sinceTime=<RFC3339>, ?timestamps=<bool>, ?tailLines=<number>, and ?limitBytes=<number>
2015-09-10 03:46:11 +00:00
# Show all logs from pod nginx written in the last hour
$ kubectl logs \-\-since=1h nginx
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.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!