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

Shipwright uses API group *.build.dev #563

Closed
imjasonh opened this issue Feb 1, 2021 · 4 comments · Fixed by #609
Closed

Shipwright uses API group *.build.dev #563

imjasonh opened this issue Feb 1, 2021 · 4 comments · Fixed by #609
Assignees

Comments

@imjasonh
Copy link
Contributor

imjasonh commented Feb 1, 2021

Shipwright's CRD types are defined in the API group build.build.dev (source). Kubernetes' API conventions recommends using a domain that your team owns:

Resources are bound together in API groups - each group may have one or more versions that evolve independent of other API groups, and each version within the group has one or more resources. Group names are typically in domain name form - the Kubernetes project reserves use of the empty group, all single word names ("extensions", "apps"), and any group name ending in "*.k8s.io" for its sole use. When choosing a group name, we recommend selecting a subdomain your group or organization owns, such as "widget.mycompany.com".

Presumably this is to prevent the case where someone acquires the domain later, which can cause confusion at best, and possibly even security concerns down the line. edit: build.dev is available for purchase, coincidentally, but the price tag is a bit high at $64,999... 💰

It might be a good idea to switch this over time to a domain owned by the team, e.g., build.shipwright.io. Since Shipwright is still in early alpha, it'd probably be better to do this soon before you get more usage, which would make changes harder to make in the future.

@sbose78
Copy link
Member

sbose78 commented Feb 1, 2021

Agreed, Jason!

@zhangtbj
Copy link
Contributor

zhangtbj commented Feb 2, 2021

+1 !

@qu1queee qu1queee added this to the release-v1.0.0 milestone Feb 19, 2021
@qu1queee
Copy link
Contributor

Im adding this to our v1.0.0. Do we know if is possible to have a migration mechanism from the old API group to the new one? @imjasonh does this relates to the webhook story in #596 ?

@imjasonh
Copy link
Contributor Author

I don't believe migration using webhooks is possible. 😞

There is a webhook conversion mechanism that converts between versions of the same Kind, but I don't believe it's possible to change the apiVersion.

Since migration will probably require a breaking change for users, I think we should do it sooner while there are relatively fewer users to break. This will be much more painful in 6 months, a year, etc.

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 a pull request may close this issue.

4 participants