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

Conversation

Ritikaa96
Copy link
Contributor

Description

Adding Annotation kubernetes.io/initial-events-list-blueprint in the document.

Issue

Closes: #49011

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 24, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign natalisucks for approval. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jan 24, 2025
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 24, 2025
@Ritikaa96
Copy link
Contributor Author

@Ritikaa96
Copy link
Contributor Author

/sig api-machinery
/language en

@k8s-ci-robot k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Jan 24, 2025

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

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??

Copy link

netlify bot commented Jan 24, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 68189b2
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/679344b63d0a8e000868c34f
😎 Deploy Preview https://deploy-preview-49545--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Comment on lines +918 to +921
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.

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.


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.

@Ritikaa96
Copy link
Contributor Author

Hmm. I got the reference for this annotation from reference: KEP-3157
&&
k8s/k8s..types.go

I'll re-investigate and edit this .
thanks for your reviews @sftim @tengqm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document watch event annotation kubernetes.io/initial-events-list-blueprint
4 participants