github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/user-guide/kubectl/kubectl_logs.md

106 lines
4.0 KiB
Markdown
Raw Normal View History

Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
Better scary message
2015-07-16 17:02:26 +00:00
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
<strong>
The latest 1.0.x release of this document can be found
[here](http://releases.k8s.io/release-1.0/docs/user-guide/kubectl/kubectl_logs.md).
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
Run gendocs
2015-07-13 22:15:35 +00:00
Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
Run gendocs
2015-07-17 22:35:41 +00:00
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
## kubectl logs
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Print the logs for a container in a pod.
### Synopsis
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
```
Enable -c for kubectl logs container arg
2015-06-30 00:48:00 +00:00
kubectl logs [-f] [-p] POD [-c CONTAINER]
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
### Examples
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
```
Fixes upper case letters in kubectl examples
2015-09-02 09:56:29 +00:00
# Return snapshot of ruby-container logs from pod 123456-7890.
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
$ kubectl logs 123456-7890 ruby-container
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Fixes upper case letters in kubectl examples
2015-09-02 09:56:29 +00:00
# Return snapshot of previous terminated ruby-container logs from pod 123456-7890.
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
$ kubectl logs -p 123456-7890 ruby-container
Introduce --previous option to kubectl log
2015-04-22 22:35:49 +00:00
Fixes upper case letters in kubectl examples
2015-09-02 09:56:29 +00:00
# Start streaming of ruby-container logs from pod 123456-7890.
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
$ kubectl logs -f 123456-7890 ruby-container
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
### Options
```
Enable -c for kubectl logs container arg
2015-06-30 00:48:00 +00:00
-c, --container="": Container name
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
-f, --follow[=false]: Specify if the logs should be streamed.
--interactive[=true]: If true, prompt the user for input when required. Default true.
-p, --previous[=false]: If true, print the logs for the previous instance of the container in a pod if it exists.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
```
Update docs after cobra update (spellling mistake)
2015-04-29 15:26:55 +00:00
### Options inherited from parent commands
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
```
Update docs
2015-08-17 18:06:16 +00:00
--alsologtostderr[=false]: log to standard error as well as files
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--api-version="": The API version to use when talking to the server
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key 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
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
Update docs
2015-08-17 18:06:16 +00:00
--log-dir="": If non-empty, write log files in this directory
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
--log-flush-frequency=5s: Maximum number of seconds between log flushes
Update docs
2015-08-17 18:06:16 +00:00
--logtostderr[=true]: log to standard error instead of files
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--match-server-version[=false]: Require server version to match client version
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--namespace="": If present, the namespace scope for this CLI request.
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
--password="": Password for basic authentication to the API server.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
--username="": Username for basic authentication to the API server.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--v=0: log level for V logs
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
Run gendocs
2015-07-17 22:35:41 +00:00
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Update docs based on new spf13/cobra
2015-09-03 21:07:24 +00:00
###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.470591683 +0000 UTC
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
move kubectl docs to docs/user-guide/kubectl
2015-07-13 17:19:25 +00:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]()
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->