whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Watch bookmarks to GA (#17026)

Browse Source
This commit is contained in:
Wojciech Tyczynski
2019-11-02 03:27:40 +01:00
committed by Bob Killen
parent dde56f2463
commit 877978350f
2 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/reference/using-api/api-concepts.md
+1 -3
View File
@@ -89,8 +89,6 @@ A given Kubernetes server will only preserve a historical list of changes for a
### Watch bookmarks
{{< feature-state for_k8s_version="v1.16" state="beta" >}}
To mitigate the impact of short history window, we introduced a concept of `bookmark` watch event. It is a special kind of event to pass an information that all changes up to a given `resourceVersion` client is requesting has already been send. Object returned in that event is of the type requested by the request, but only `resourceVersion` field is set, e.g.:
GET /api/v1/namespaces/test/pods?watch=1&resourceVersion=10245&allowWatchBookmarks=true
@@ -108,7 +106,7 @@ To mitigate the impact of short history window, we introduced a concept of `book
"object": {"kind": "Pod", "apiVersion": "v1", "metadata": {"resourceVersion": "12746"} }
}
`Bookmark` events can be requested by `allowWatchBookmarks=true` option in watch requests, but clients shouldn't assume bookmarks are returned at any specific interval, nor may they assume the server will send any `bookmark` event. Since version 1.16, watch bookmarks feature is enabled by default.
`Bookmark` events can be requested by `allowWatchBookmarks=true` option in watch requests, but clients shouldn't assume bookmarks are returned at any specific interval, nor may they assume the server will send any `bookmark` event.
## Retrieving large results sets in chunks