-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Ritikaa96 <[email protected]>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/sig api-machinery |
|
||
Example: `"k8s.io/initial-events-embedded-list":"eyJraW5kIjoiUG9kTGlzdCIsImFwaVZlcnNpb24iOiJ2MSIsIm1ldGFkYXRhIjp7fSwiaXRlbXMiOm51bGx9Cg=="` | ||
|
||
Used on: Bookmark Watch Event |
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.
Used on: Bookmark Watch Event | |
Used on: Event |
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.
This isn't an annotation used on Events. You find this annotation used on the response to a watch or watchcollection logical 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.
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"
)
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.
Also 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.
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. |
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.
The same object??
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
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. |
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.
We can add this, but it's hard for readers to understand.
If you can write this in your own words, please do that.
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'll try changing the words into a simpler version.
|
||
Type: Annotation | ||
|
||
Example: `"k8s.io/initial-events-embedded-list":"eyJraW5kIjoiUG9kTGlzdCIsImFwaVZlcnNpb24iOiJ2MSIsIm1ldGFkYXRhIjp7fSwiaXRlbXMiOm51bGx9Cg=="` |
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.
The name doesn't match the heading.
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.
my bad, i'll edit it.
Hmm. I got the reference for this annotation from reference: KEP-3157 I'll re-investigate and edit this . |
Description
Adding Annotation
kubernetes.io/initial-events-list-blueprint
in the document.Issue
Closes: #49011