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

Migrate Project layout to Kubebuilder v4 #130

Closed
2 of 3 tasks
pmalek opened this issue Feb 16, 2024 · 9 comments
Closed
2 of 3 tasks

Migrate Project layout to Kubebuilder v4 #130

pmalek opened this issue Feb 16, 2024 · 9 comments
Assignees
Labels
area/maintenance breaking-change migrated-from-archive Issues migrated from the archived KGO repository
Milestone

Comments

@pmalek
Copy link
Member

pmalek commented Feb 16, 2024

Problem statement

This project has used Kubebuilder's v3 layout for quite some time now.

There already exists a new version of that: v4 which has several benefits (described e.g. in Kong/gateway-operator-archive#1455).

The biggest one is that it makes the controller code be placed in internal/ and hence precluding OSS users from relying on our implementation. This would most definitely save some headaches in the future.

Kong/gateway-operator#1455 has been merged with the above in mind (and more, see PR description for more details) but has proven to be disruptive to 1.2 work.

This issue tries to capture the effort to migrate to Kubebuilder v4 layout in a better time frame. Potentially after Kong/gateway-operator-enterprise#68 and Kong/gateway-operator-enterprise#70 (and its potential sub-issues) are complete and all the EE work has also been completed.

Adding nice-to-have label as that's what this issue is. Ideally, targeting 1.2 release.

Proposed solution

  • reapply patch from Kong/gateway-operator#1455, Kong/gateway-operator-archive#1462 and Kong/gateway-operator-archive#1463

Important notes

This change will incur a breaking change for Go API consumers and has to be properly communicated and coordinated for internal users, specifically CG dataplane-controller (see: https://github.com/search?q=repo%3AKong%2Fdataplane-controller%20github.com%2Fkong%2Fgateway-operator%2Fapis&type=code)

Acceptance criteria

@pmalek
Copy link
Member Author

pmalek commented Apr 17, 2024

I've updated the acceptance criteria in this issue.

This is a breaking change for Go API consumers and needs to be documented as such.

Most importantly CG dataplane controller code has to be updated to include this change (https://github.com/search?q=repo%3AKong%2Fdataplane-controller%20github.com%2Fkong%2Fgateway-operator%2Fapis&type=code)

cc: @programmer04

@programmer04
Copy link
Member

PR for CG dataplane has been created https://github.com/Kong/dataplane-controller/pull/554

@czeslavo czeslavo transferred this issue from another repository Apr 23, 2024
@mlavacca mlavacca added this to the KGO v1.3.x milestone Apr 23, 2024
@pmalek
Copy link
Member Author

pmalek commented May 27, 2024

To be done after release:

@randmonkey
Copy link
Contributor

@pmalek I see the acceptance criteria are all met in the issue. Should we close this?

@pmalek
Copy link
Member Author

pmalek commented Jun 21, 2024

The comment above captures what needs to be done in dataplane controller. The intention was to leave this open until that is done.

Wie can also move this part of the task to team-K8s repo and close those one here

@programmer04
Copy link
Member

I'm on it, just after the Monday release I'll make https://github.com/Kong/dataplane-controller/pull/554 ready to merge

@lahabana lahabana modified the milestones: KGO v1.3.x, KGO v1.4.x Jun 24, 2024
@programmer04 programmer04 modified the milestones: KGO v1.4.x, KGO v1.3.x Jun 24, 2024
@lahabana
Copy link
Contributor

@programmer04 should we push for the PR to be merged?

@programmer04
Copy link
Member

Yes, I think sooner is better

@programmer04
Copy link
Member

The PR https://github.com/Kong/dataplane-controller/pull/660 has been merged it's resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/maintenance breaking-change migrated-from-archive Issues migrated from the archived KGO repository
Projects
None yet
Development

No branches or pull requests

6 participants