Skip to content

Commit 86ed3f5

Browse files
authored
Merge pull request #48512 from p0lyn0mial/doc-update-watch-list-1-32
Document KEP 3157 (watch-list) for milestone 1.32
2 parents f904ca1 + 45ef572 commit 86ed3f5

File tree

3 files changed

+25
-6
lines changed

3 files changed

+25
-6
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: WatchListClient
3+
content_type: feature_gate
4+
_build:
5+
list: never
6+
render: false
7+
8+
stages:
9+
- stage: beta
10+
defaultValue: false
11+
fromVersion: "1.30"
12+
---
13+
Allows an API client to request a stream of data rather than fetching a full list.
14+
This functionality is available in `client-go` and requires the
15+
[WatchList](/docs/reference/command-line-tools-reference/feature-gates/)
16+
feature to be enabled on the server.
17+
If the `WatchList` is not supported on the server, the client will seamlessly fall back to a standard list request.

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
@@ -443,13 +443,11 @@ the API server will send any `BOOKMARK` event even when requested.
443443

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

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

0 commit comments

Comments
 (0)