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

Versioning CRD yaml to simplify only installing v1alpha2 #789

Merged
merged 1 commit into from
Aug 19, 2021

Conversation

robscott
Copy link
Member

@robscott robscott commented Aug 18, 2021

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
This moves CRD yaml to version specific directories that will simplify installing only v1alpha2 CRDs. This also adds the ReferencePolicy CRD to kustomize config. Although I'd initially tried to remove the v1alpha1 CRDs entirely, we rely on them to verify our v1alpha1 examples. Until we release v1alpha2, I think we need to leave that verification, and therefore the v1alpha1 CRDs in place, even though we should be encouraging only installing v1alpha2 CRDs post-release.

Some reasons for this:

  • Since the v1alpha1 and v1alpha2 CRDs exist in different API groups, having both in a cluster will be confusing when using kubectl. (kubectl get httproute may return v1alpha1 or v1alpha2 resources, but never both). Users will also not see any warning about the duplicate resource names in their cluster.
  • The existing v1alpha1 CRDs are frozen and can still be installed by following the documentation: https://gateway-api.sigs.k8s.io/v1alpha1/guides/getting-started/#installing-gateway-api-crds-manually.
  • Many/most implementations plan to move directly to only supporting v1alpha2 CRDs.

Of course we could take this a step further and remove the entirety of the v1alpha1 APIs and related codegen, but I think it's helpful to leave both in place if any implementations do want to concurrently support both versions.

Note: This also removes hack/verify-crds.sh. I spent some time trying to make it work with this new structure before I realized hack/verify-codegen.sh already completely covers this in a simpler way.

Does this PR introduce a user-facing change?:

v1alpha1 CRD yaml has been removed in preparation for v1alpha2 release. These CRDs can still be installed from v0.3.0.

@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 18, 2021
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 18, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: howardjohn, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 18, 2021
@howardjohn howardjohn mentioned this pull request Aug 18, 2021
10 tasks
@robscott robscott changed the title Removing v1alpha1 CRD yaml Versioning CRD yaml to make to simplify only installing v1alpha2 Aug 18, 2021
@robscott robscott changed the title Versioning CRD yaml to make to simplify only installing v1alpha2 Versioning CRD yaml to simplify only installing v1alpha2 Aug 18, 2021
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 18, 2021
@youngnick
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 19, 2021
@k8s-ci-robot k8s-ci-robot merged commit db18d56 into kubernetes-sigs:master Aug 19, 2021
@robscott robscott deleted the v1alpha1-crds branch January 8, 2022 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants