-
Notifications
You must be signed in to change notification settings - Fork 14.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added watch to glossary #47067
Added watch to glossary #47067
Conversation
/kind feature |
I'll add the Usage in the second commit to keep the changes seperate. |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Watches are however not objects.
|
||
aka: | ||
tags: | ||
- core-object |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- core-object |
Watches are verbs, not objects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah! yes . thanks for the correction.
|
||
<!--more--> | ||
|
||
A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes when this request is made to Kubernetes API or when HTTP GET request is made with watch query. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(optionally)
A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes when this request is made to Kubernetes API or when HTTP GET request is made with watch query. | |
A verb that is used to track changes to an object in Kubernetes as a stream. Watches allow | |
efficient detection of changes; for example, a | |
{{< glossary_tooltip term_id="controller" text="controller">}} that needs to know whenever a | |
ConfigMap has changed can use a watch rather than polling. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess an example will be beneficial. Thanks , I'll incorporate the changes.
Feel free to add another commit that makes an example use of this term. |
The most i have seen |
Hi @sftim PTAL i added some changes and the examples for using it also. |
848e148
to
530c394
Compare
I have added the example use for the first occurrence of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Definitely OK to merge as-is.
I have tweaks to suggest.
@@ -61,7 +61,7 @@ Kubernetes reviews only the following API request attributes: | |||
* **extra** - A map of arbitrary string keys to string values, provided by the authentication layer. | |||
* **API** - Indicates whether the request is for an API resource. | |||
* **Request path** - Path to miscellaneous non-resource endpoints like `/api` or `/healthz`. | |||
* **API request verb** - API verbs like `get`, `list`, `create`, `update`, `patch`, `watch`, `delete`, and `deletecollection` are used for resource requests. To determine the request verb for a resource API endpoint, see [request verbs and authorization](/docs/reference/access-authn-authz/authorization/#determine-the-request-verb). | |||
* **API request verb** - API verbs like `get`, `list`, `create`, `update`, `patch`, `{{< glossary_tooltip text="watch" term_id="watch" >}}`, `delete`, and `deletecollection` are used for resource requests. To determine the request verb for a resource API endpoint, see [request verbs and authorization](/docs/reference/access-authn-authz/authorization/#determine-the-request-verb). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't use the tooltip here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted. Thanks for the review.
@@ -813,7 +813,7 @@ apply multiple fixes in between pausing and resuming without triggering unnecess | |||
``` | |||
deployment.apps/nginx-deployment resumed | |||
``` | |||
* Watch the status of the rollout until it's done. | |||
* {{< glossary_tooltip text="Watch" term_id="watch" >}} the status of the rollout until it's done. | |||
```shell | |||
kubectl get rs -w |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(nit / optional extra)
kubectl get rs -w | |
kubectl get rs --watch |
@@ -19,7 +19,7 @@ fine grained authorization (such as separate views for Pod details and | |||
log retrievals), and can accept and serve those resources in different | |||
representations for convenience or efficiency. | |||
|
|||
Kubernetes supports efficient change notifications on resources via *watches*. | |||
Kubernetes supports efficient change notifications on resources via *{{< glossary_tooltip text="watches" term_id="watch" >}}*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use the glossary definition here:
Kubernetes supports efficient change notifications on resources via *{{< glossary_tooltip text="watches" term_id="watch" >}}*. | |
Kubernetes supports efficient change notifications on resources via | |
_watches_: | |
{{< glossary_definition prepend="in the Kubernetes API, watch is an" term_id="watch" length="short" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright. I'll add this.
@@ -406,7 +406,7 @@ the bundle with their own arbitrary but stable ordering. | |||
ClusterTrustBundle objects should be considered world-readable within the | |||
cluster. If your cluster uses [RBAC](/docs/reference/access-authn-authz/rbac/) | |||
authorization, all ServiceAccounts have a default grant that allows them to | |||
**get**, **list**, and **watch** all ClusterTrustBundle objects. | |||
**get**, **list**, and **{{< glossary_tooltip text="watch" term_id="watch" >}}** all ClusterTrustBundle objects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't use the tooltip here; it will make the verb look different from others and that may confuse readers more than it helps.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah.. ok . Noted
@@ -201,7 +201,7 @@ For example: `partition in (customerA, customerB),environment!=qa`. | |||
|
|||
### LIST and WATCH filtering | |||
|
|||
LIST and WATCH operations may specify label selectors to filter the sets of objects | |||
LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects | |
For **list** and **watch** operations, you can specify label selectors to filter the sets of objects |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok . I'll remove the glossary tooltip from here as well.
@@ -201,7 +201,7 @@ For example: `partition in (customerA, customerB),environment!=qa`. | |||
|
|||
### LIST and WATCH filtering | |||
|
|||
LIST and WATCH operations may specify label selectors to filter the sets of objects | |||
LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects | |||
returned using a query parameter. Both requirements are permitted |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
returned using a query parameter. Both requirements are permitted | |
returned; you specify the filter using a query parameter. | |
(To learn in detail about watches in Kubernetes, read | |
[efficient detection of changes](/docs/reference/using-api/api-concepts/#efficient-detection-of-changes)). | |
Both kinds of requirement are permitted |
LGTM label has been added. Git tree hash: dc3b6ba8c8845275e4bbfb41590b976cd8756143
|
Hi @sftim , made the suggested changes, PTAL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
LGTM label has been added. Git tree hash: 8b499ee6b066cefb3de96a159a790e3b4ecd32ee
|
Kubernetes supports efficient change notifications on resources via *watches*. | ||
Kubernetes supports efficient change notifications on resources via | ||
_watches_: | ||
{{< glossary_definition prepend="in the Kubernetes API, watch is an" term_id="watch" length="short" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more thing to change:
{{< glossary_definition prepend="in the Kubernetes API, watch is an" term_id="watch" length="short" >}} | |
{{< glossary_definition prepend="in the Kubernetes API, watch is" term_id="watch" length="short" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted. yes. that needs to be removed.
- API verb | ||
- fundamental | ||
--- | ||
A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(nit)
A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes. | |
A verb that is used to track changes to an object in Kubernetes as a stream. | |
It is used for the efficient detection of changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cool. thanks for the reviews.
Signed-off-by: Ritikaa96 <ritika@india.nec.com>
Signed-off-by: Ritikaa96 <ritika@india.nec.com>
Signed-off-by: Ritikaa96 <ritika@india.nec.com>
c470bec
to
53dc63a
Compare
Hi @dipesh-rawat @sftim Made the changes again. Thanks for the reviews. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
LGTM label has been added. Git tree hash: 923f963287d62c5404e9966498cb69c1770a593d
|
This is a good addition to the docs. Thank you |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: reylejano The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Fixes: #47015
Added
watch
to glossary.