Skip to content

Commit 1450306

Browse files
committed
Improve docs related to kubectl
1 parent aee5d36 commit 1450306

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/tasks/configure-pod-container/configmap.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ The data source corresponds to a key-value pair in the ConfigMap, where
3636
* key = the file name or the key you provided on the command line, and
3737
* value = the file contents or the literal value you provided on the command line.
3838

39-
You can use [`kubectl describe`](/docs/user-guide/kubectl/{{page.version}}/#describe) or [`kubectl get`](/docs/user-guide/kubectl/{{page.version}}/#get) to retrieve information about a ConfigMap. The former shows a summary of the ConfigMap, while the latter returns the full contents of the ConfigMap.
39+
You can use [`kubectl describe`](/docs/user-guide/kubectl/{{page.version}}/#describe) or
40+
[`kubectl get`](/docs/user-guide/kubectl/{{page.version}}/#get) to retrieve information
41+
about a ConfigMap.
4042

4143
### Create ConfigMaps from directories
4244

docs/user-guide/kubectl-overview.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,17 @@ $ kubectl describe pods <rc-name>
264264
$ kubectl describe pods --include-uninitialized=false
265265
```
266266

267+
**Note:** The `kubectl get` command is usually used for retrieving one or more
268+
resources of the same resource type. It features a rich set of flags that allows
269+
you to customize the output format using the `-o` or `--output` flag, for example.
270+
You can specify the `-w` or `--watch` flag to start watching updates to a particular
271+
object. The `kubectl describe` command is more focused on describing the many
272+
related aspects of a specified resource. It may invoke several API calls to the
273+
API server to build a view for the user. For example, the `kubectl describe node`
274+
command retrieves not only the information about the node, but also a summary of
275+
the pods running on it, the events generated for the node etc.
276+
{: .note}
277+
267278
`kubectl delete` - Delete resources either from a file, stdin, or specifying label selectors, names, resource selectors, or resources.
268279

269280
```shell

0 commit comments

Comments
 (0)