Skip to content

Commit 3794a9a

Browse files
committed
Update documentation for the WatchList feature
1 parent b92deb4 commit 3794a9a

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

content/en/docs/reference/command-line-tools-reference/feature-gates/watch-list.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,9 @@ stages:
99
- stage: alpha
1010
defaultValue: false
1111
fromVersion: "1.27"
12+
toVersion: "1.31"
13+
- stage: beta
14+
defaultValue: true
15+
fromVersion: "1.32"
1216
---
1317
Enable support for [streaming initial state of objects in watch requests](/docs/reference/using-api/api-concepts/#streaming-lists).

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -400,13 +400,11 @@ the API server will send any `BOOKMARK` event even when requested.
400400

401401
On large clusters, retrieving the collection of some resource types may result in
402402
a significant increase of resource usage (primarily RAM) on the control plane.
403-
In order to alleviate its impact and simplify the user experience of the **list** + **watch**
404-
pattern, Kubernetes v1.27 introduces as an alpha feature the support
405-
for requesting the initial state (previously requested via the **list** request) as part of
406-
the **watch** request.
403+
To alleviate the impact and simplify the user experience of the **list** + **watch**
404+
pattern, Kubernetes v1.32 promotes to beta the feature that allows requesting the initial state
405+
(previously requested via the **list** request) as part of the **watch** request.
407406

408-
Provided that the `WatchList` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
409-
is enabled, this can be achieved by specifying `sendInitialEvents=true` as query string parameter
407+
On the client-side the initial state can be requested by specifying `sendInitialEvents=true` as query string parameter
410408
in a **watch** request. If set, the API server starts the watch stream with synthetic init
411409
events (of type `ADDED`) to build the whole state of all existing objects followed by a
412410
[`BOOKMARK` event](/docs/reference/using-api/api-concepts/#watch-bookmarks)

0 commit comments

Comments
 (0)