Skip to content
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

Registered annotation initial-events-list-blueprint #49545

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions content/en/docs/reference/labels-annotations-taints/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -907,6 +907,19 @@ configuration file (default `/etc/cni/net.d`) and ensure that the binary is incl
bin dir (default `/opt/cni/bin`).
{{< /note >}}

### kubernetes.io/initial-events-list-blueprint

Type: Annotation

Example: `"k8s.io/initial-events-embedded-list":"eyJraW5kIjoiUG9kTGlzdCIsImFwaVZlcnNpb24iOiJ2MSIsIm1ldGFkYXRhIjp7fSwiaXRlbXMiOm51bGx9Cg=="`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name doesn't match the heading.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my bad, i'll edit it.


Used on: Bookmark Watch Event
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Used on: Bookmark Watch Event
Used on: Event

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't an annotation used on Events. You find this annotation used on the response to a watch or watchcollection logical verb.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the code here says it is added to bookmark event

	// The annotation is added to a "Bookmark" event and is used by clients
	// to guarantee the format consistency when reconstructing
	// the list during WatchList processing.
	InitialEventsListBlueprintAnnotationKey = "kubernetes.io/initial-events-list-blueprint"
)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but bookmark events are different from Events in the events.k8s.io API group.


This annotation is added to the synthetic "Bookmark" event for the watch stream and
is used by clients to guarantee the format consistency when reconstructing the list during WatchList processing.
The annotation will store an empty, versioned list encoded as a base64 string.
It will be added to the same object the k8s.io/initial-events-end annotation is added.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same object??

Comment on lines +918 to +921
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can add this, but it's hard for readers to understand.

If you can write this in your own words, please do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try changing the words into a simpler version.


### kubernetes.io/egress-bandwidth

Type: Annotation
Expand Down