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

129 lines
4.7 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_describe.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
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
## kubectl describe
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
Show details of a specific resource or group of resources
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
### 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
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
Show details of a specific resource or group of resources.
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
This command joins many API calls together to form a detailed description of a
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
given resource or group of resources.
Use TYPE instead of RESOURCE in help string For commands in kubectl, use TYPE in help string.
2015-07-06 11:31:27 +00:00
$ kubectl describe TYPE NAME_PREFIX
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
Use TYPE instead of RESOURCE in help string For commands in kubectl, use TYPE in help string.
2015-07-06 11:31:27 +00:00
will first check for an exact match on TYPE and NAME_PREFIX. If no such resource
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
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
Synchronize help message between describe and get small nits, change 'resources' to 'resource types'
2015-08-06 07:30:20 +00:00
Possible resource types include (case insensitive): pods (po), services (svc),
Better help message for get and describe Add tips for shortcut ns and ep.
2015-07-30 08:43:42 +00:00
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns) or secrets.
Add a better help message for kubectl describe When resource type isn't given in the command, print the possible resource types. Also added the resource type description in help strings.
2015-07-07 03:14:28 +00:00
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
```
Kubectl describe command accepts a filename param
2015-07-07 07:31:08 +00:00
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
Add examples for kubectl describe, and make gendocs less spammy Makes hack/{run/verify}-gendocs.sh ignore generated-timestamp-only changes so minor changes to kubectl don't have to touch the entire set of md docs.
2015-04-23 21:21:13 +00:00
```
### Examples
```
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Describe a node
Add examples for kubectl describe, and make gendocs less spammy Makes hack/{run/verify}-gendocs.sh ignore generated-timestamp-only changes so minor changes to kubectl don't have to touch the entire set of md docs.
2015-04-23 21:21:13 +00:00
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Describe a pod
Add examples for kubectl describe, and make gendocs less spammy Makes hack/{run/verify}-gendocs.sh ignore generated-timestamp-only changes so minor changes to kubectl don't have to touch the entire set of md docs.
2015-04-23 21:21:13 +00:00
$ kubectl describe pods/nginx
Add label support for kubectl describe Add -l option to kubectl describe command, allow it return multiple results filtered by label selector.
2015-06-12 07:08:28 +00:00
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Describe a pod using the data in pod.json.
Kubectl describe command accepts a filename param
2015-07-07 07:31:08 +00:00
$ kubectl describe -f pod.json
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Describe all pods
kubectl describe <kind> work with no arguments Add describe_resource_assert to test describe <kind> with no object arg
2015-08-04 07:12:29 +00:00
$ kubectl describe pods
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Describe pods by label name=myLabel
Add label support for kubectl describe Add -l option to kubectl describe command, allow it return multiple results filtered by label selector.
2015-06-12 07:08:28 +00:00
$ kubectl describe po -l name=myLabel
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# 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).
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
$ kubectl describe pods frontend
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
Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation."" This reverts commit 69432e8b2fd5f29c8a9d6c08a7eafcef896eee4f. COMMIT_BLOCKED_ON_GENDOCS
2015-03-16 18:23:02 +00:00
### Options
```
Kubectl describe command accepts a filename param
2015-07-07 07:31:08 +00:00
-f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe
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
-h, --help[=false]: help for describe
Add label support for kubectl describe Add -l option to kubectl describe command, allow it return multiple results filtered by label selector.
2015-06-12 07:08:28 +00:00
-l, --selector="": Selector (label query) to filter on
Revert "Revert "Update cobra/pflag. Also update generated kubectl documentation."" This reverts commit 69432e8b2fd5f29c8a9d6c08a7eafcef896eee4f. COMMIT_BLOCKED_ON_GENDOCS
2015-03-16 18:23:02 +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
```
--alsologtostderr=false: log to standard error as well as files
--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
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
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
--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
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
--validate[=false]: If true, use a schema to validate the input before sending it
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
--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
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
###### Auto generated by spf13/cobra at 2015-08-12 17:00:51.070612795 +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_describe.md?pixel)]()
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->