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

Decide if kind should be renamed to resource #816

Closed
hbagdi opened this issue Aug 23, 2021 · 8 comments · Fixed by #870
Closed

Decide if kind should be renamed to resource #816

hbagdi opened this issue Aug 23, 2021 · 8 comments · Fixed by #870
Assignees
Labels
breaking-change kind/feature Categorizes issue or PR as related to a new feature.
Milestone

Comments

@hbagdi
Copy link
Contributor

hbagdi commented Aug 23, 2021

What would you like to be added:

Rename kind to resource for object references as per API conventions: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/2336-OwnerReference-resource-field/README.md

Why this is needed:

Upstream API conventions recommend "resource" over "kind"

Concerns

Some concerns were raise in the community meeting (not exhaustive):

  • Do client-go or controller-runtime supported?
  • This is a change of a large magnitude and nobody on the call really seems to be aware of these details.
@hbagdi hbagdi added kind/feature Categorizes issue or PR as related to a new feature. breaking-change labels Aug 23, 2021
@hbagdi
Copy link
Contributor Author

hbagdi commented Aug 23, 2021

xref #689

@hbagdi hbagdi added this to the v1alpha2 milestone Aug 23, 2021
@robscott
Copy link
Member

As referenced in #689, I think kubernetes/community#5748 (comment) is probably the best summary of the rationale for this change, will continue to follow up on this one.

@youngnick
Copy link
Contributor

I think the biggest thing we, as a community will need to do, is do more education of what users will actually need to put in there. Usually it's lower-case, pluralised, instead of Initialcase, so we should probably put in some examples in the docs for the field.

@robscott
Copy link
Member

Followed up on mailing lists: https://groups.google.com/g/kubernetes-sig-architecture/c/WhHTjTDzcQg

@robscott
Copy link
Member

Working on update to API conventions: kubernetes/community#5973

@hbagdi hbagdi changed the title Rename kind to resource Decide if kind should be renamed to resource Aug 30, 2021
@youngnick
Copy link
Contributor

Feels like we agreed that, as long as the API conventions update goes in, we will not be changing Kind to Resource. Other maintainers thoughts?

@robscott
Copy link
Member

robscott commented Sep 15, 2021

API conventions have been updated (kubernetes/community#5973), I think the only remaining step is to document why we chose Kind over Resource and more importantly, what that means for implementations of this API.

@robscott
Copy link
Member

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants