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

fix(AIP-128): clarify usage of annotations field for Declarative-friendly resources #1298

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

amirkaromashkin
Copy link

@amirkaromashkin amirkaromashkin commented Jan 29, 2024

In #1183, guide was moved from AIP-128 to AIP-148.
As a result, the information whether Declarative-friendly interfaces must include annotations field was lost.
This PR or related issue do not justify the reason of recommendation change, therefore I consider it as a bug.

This change returns the recommendation to the one before the change and puts it in both AIP-128 and AIP-148

@amirkaromashkin amirkaromashkin marked this pull request as ready for review January 29, 2024 12:08
@amirkaromashkin amirkaromashkin requested a review from a team as a code owner January 29, 2024 12:08
@amirkaromashkin amirkaromashkin changed the title fix(AIP-128): clarify usage of annotations field fix(AIP-128): clarify usage of annotations field for Declarative-friendly interfaces Jan 29, 2024
@amirkaromashkin amirkaromashkin changed the title fix(AIP-128): clarify usage of annotations field for Declarative-friendly interfaces fix(AIP-128): clarify usage of annotations field for Declarative-friendly resource Jan 29, 2024
@amirkaromashkin amirkaromashkin changed the title fix(AIP-128): clarify usage of annotations field for Declarative-friendly resource fix(AIP-128): clarify usage of annotations field for Declarative-friendly resources Jan 29, 2024
Comment on lines +78 to +80
- Resources **must** include a
`map<string, string> annotations` field to allow clients to store small amounts
of arbitrary data: see AIP-148
Copy link

@yordis yordis Feb 2, 2024

Choose a reason for hiding this comment

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

Would you say that this field has a similar intent as https://stripe.com/docs/api/metadata

Useful for correlation or putting extra metadata that could be used late.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Author

Choose a reason for hiding this comment

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

I can only agree with both comments above :)

Copy link

@yordis yordis Feb 3, 2024

Choose a reason for hiding this comment

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

I understand the usage of annotations in the context of Kubernetes, but I am trying to find the usefulness from the AIP perspective outside that given Domain.

It should be a less technical-focused product and more general in the public domain (fintech, education, etc.).

Related to #1288 (comment)

The topic of transient data and/or user-controlled (external clients own the data) instead of system-controlled (internal to systems, not intended outside programmers that own the system).

The AIPs can clarify and help with the decision-making here.

@bgrant0607
Copy link
Contributor

The intent of moving annotations to AIP 148 was that all resource types should support annotations.

@amirkaromashkin
Copy link
Author

The intent of moving annotations to AIP 148 was that all resource types should support annotations.

Yes, and since #1183, annotations may be added to all resources.

Current PR does not touch this part of the recommendation, but returns a must recommendation for Declarative-friendly resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants