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.

Sign up for GitHub

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

Jump to bottom

Create a KB article on XRD API versioning #478

Closed
plumbis opened this issue Jun 28, 2023 · 2 comments
Closed

Create a KB article on XRD API versioning #478

plumbis opened this issue Jun 28, 2023 · 2 comments
Labels
content request Issues requesting new content kb Knowledge Base related issues and content P3 Nice to have issues. Should be prioritized to be eventually resolved.

Comments

@plumbis
Copy link
Collaborator

plumbis commented Jun 28, 2023

What's Missing?

The new XRD doc talks about API versions and talks briefly about Crossplane's recommendations.

We should have a KB article specifically about XRD versioning and best practices, including:

  • v1alpha1 is a test to see what works and doesn't work.
  • Probably need to delete the v1alpha1 and build the v1beta1 that shouldn't have breaking changes.
  • v1 is full faith in the API

Optionally, but nice to have, would be an example conversion webhook to manage a breaking API change.
@plumbis plumbis added P3 Nice to have issues. Should be prioritized to be eventually resolved. content request Issues requesting new content kb Knowledge Base related issues and content labels Jun 28, 2023
@haarchri
Copy link
Contributor

haarchri commented Aug 2, 2023

@plumbis Is this helpful? Check out the repository at https://github.com/haarchri/xrd-webhook for converting webhooks.

@negz negz mentioned this issue Feb 14, 2024
Open
@plumbis
Copy link
Collaborator Author

plumbis commented Feb 16, 2024

This is discussed (lightly) in the XRD chapter. https://docs.crossplane.io/latest/concepts/composite-resource-definitions/#xrd-versions

@plumbis plumbis closed this as completed Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content request Issues requesting new content kb Knowledge Base related issues and content P3 Nice to have issues. Should be prioritized to be eventually resolved.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@plumbis @haarchri