Skip to content

Commit 6bc8f40

Browse files
authored
Merge pull request #47067 from Ritikaa96/glossary-add-watch
Added watch to glossary
2 parents f532221 + 53dc63a commit 6bc8f40

File tree

6 files changed

+36
-7
lines changed

6 files changed

+36
-7
lines changed

content/en/docs/concepts/overview/working-with-objects/labels.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,11 @@ For example: `partition in (customerA, customerB),environment!=qa`.
201201

202202
### LIST and WATCH filtering
203203

204-
LIST and WATCH operations may specify label selectors to filter the sets of objects
205-
returned using a query parameter. Both requirements are permitted
204+
For **list** and **watch** operations, you can specify label selectors to filter the sets of objects
205+
returned; you specify the filter using a query parameter.
206+
(To learn in detail about watches in Kubernetes, read
207+
[efficient detection of changes](/docs/reference/using-api/api-concepts/#efficient-detection-of-changes)).
208+
Both requirements are permitted
206209
(presented here as they would appear in a URL query string):
207210

208211
* _equality-based_ requirements: `?labelSelector=environment%3Dproduction,tier%3Dfrontend`

content/en/docs/concepts/workloads/controllers/deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -813,9 +813,9 @@ apply multiple fixes in between pausing and resuming without triggering unnecess
813813
```
814814
deployment.apps/nginx-deployment resumed
815815
```
816-
* Watch the status of the rollout until it's done.
816+
* {{< glossary_tooltip text="Watch" term_id="watch" >}} the status of the rollout until it's done.
817817
```shell
818-
kubectl get rs -w
818+
kubectl get rs --watch
819819
```
820820

821821
The output is similar to this:
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Watch
3+
id: watch
4+
date: 2024-07-02
5+
full_link: /docs/reference/using-api/api-concepts/#api-verbs
6+
short_description: >
7+
A verb that is used to track changes to an object in Kubernetes as a stream.
8+
9+
aka:
10+
tags:
11+
- API verb
12+
- fundamental
13+
---
14+
A verb that is used to track changes to an object in Kubernetes as a stream.
15+
It is used for the efficient detection of changes.
16+
17+
<!--more-->
18+
19+
A verb that is used to track changes to an object in Kubernetes as a stream. Watches allow
20+
efficient detection of changes; for example, a
21+
{{< glossary_tooltip term_id="controller" text="controller">}} that needs to know whenever a
22+
ConfigMap has changed can use a watch rather than polling.
23+
24+
See [Efficient Detection of Changes in API Concepts](/docs/reference/using-api/api-concepts/#efficient-detection-of-changes) for more information.

content/en/docs/reference/using-api/api-concepts.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ fine grained authorization (such as separate views for Pod details and
1919
log retrievals), and can accept and serve those resources in different
2020
representations for convenience or efficiency.
2121

22-
Kubernetes supports efficient change notifications on resources via *watches*.
22+
Kubernetes supports efficient change notifications on resources via
23+
_watches_:
24+
{{< glossary_definition prepend="in the Kubernetes API, watch is" term_id="watch" length="short" >}}
2325
Kubernetes also provides consistent list operations so that API clients can
2426
effectively cache, track, and synchronize the state of resources.
2527

content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ hello */1 * * * * False 0 <none> 10s
4949
```
5050

5151
As you can see from the results of the command, the cron job has not scheduled or run any jobs yet.
52-
Watch for the job to be created in around one minute:
52+
{{< glossary_tooltip text="Watch" term_id="watch" >}} for the job to be created in around one minute:
5353

5454
```shell
5555
kubectl get jobs --watch

content/en/docs/tutorials/stateful-application/basic-stateful-set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ It creates a [headless Service](/docs/concepts/services-networking/service/#head
7777
{{% code_sample file="application/web/web.yaml" %}}
7878

7979
You will need to use at least two terminal windows. In the first terminal, use
80-
[`kubectl get`](/docs/reference/generated/kubectl/kubectl-commands/#get) to watch the creation
80+
[`kubectl get`](/docs/reference/generated/kubectl/kubectl-commands/#get) to {{< glossary_tooltip text="watch" term_id="watch" >}} the creation
8181
of the StatefulSet's Pods.
8282

8383
```shell

0 commit comments

Comments
 (0)