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

fix: Move K8scel driver from framework #3570

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

abhipatnala
Copy link
Contributor

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #3500

Special notes for your reviewer:

@abhipatnala abhipatnala requested a review from a team as a code owner October 3, 2024 21:22
@abhipatnala abhipatnala changed the title Fix: Move K8scel driver from framework fix: Move K8scel driver from framework Oct 3, 2024
@codecov-commenter
Copy link

codecov-commenter commented Oct 3, 2024

Codecov Report

Attention: Patch coverage is 47.44318% with 370 lines in your changes missing coverage. Please review.

Project coverage is 47.85%. Comparing base (3350319) to head (78f720f).
Report is 168 commits behind head on master.

Files with missing lines Patch % Lines
pkg/drivers/k8scel/schema/schema.go 33.89% 109 Missing and 8 partials ⚠️
pkg/drivers/k8scel/driver.go 29.13% 100 Missing and 7 partials ⚠️
pkg/drivers/k8scel/transform/vap_util.go 0.00% 67 Missing ⚠️
pkg/drivers/k8scel/transform/make_vap_objects.go 74.52% 18 Missing and 9 partials ⚠️
pkg/drivers/k8scel/transform/request.go 69.76% 21 Missing and 5 partials ⚠️
pkg/drivers/k8scel/transform/cel_snippets.go 87.50% 12 Missing ⚠️
pkg/drivers/k8scel/args.go 0.00% 6 Missing ⚠️
pkg/drivers/k8scel/new.go 55.55% 3 Missing and 1 partial ⚠️
pkg/controller/constraint/constraint_controller.go 0.00% 3 Missing ⚠️
...onstrainttemplate/constrainttemplate_controller.go 66.66% 1 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (3350319) and HEAD (78f720f). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (3350319) HEAD (78f720f)
unittests 2 1
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3570      +/-   ##
==========================================
- Coverage   54.49%   47.85%   -6.64%     
==========================================
  Files         134      229      +95     
  Lines       12329    19330    +7001     
==========================================
+ Hits         6719     9251    +2532     
- Misses       5116     9208    +4092     
- Partials      494      871     +377     
Flag Coverage Δ
unittests 47.85% <47.44%> (-6.64%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@JaydipGabani JaydipGabani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is k8scel driver going to be removed from frameworks after these changes are in GK?

I think we should move "VAP related" code - https://github.com/open-policy-agent/gatekeeper/blob/master/pkg/controller/constraint/constraint_controller.go#L623 to EOF - under transform. wdyt? @open-policy-agent/gatekeeper-maintainers

@ritazh
Copy link
Member

ritazh commented Oct 7, 2024

is k8scel driver going to be removed from frameworks after these changes are in GK?

Ideally this PR should test against a PR in framework that removes the k8scel driver to ensure all k8scel changes are migrated from framework to GK.

I think we should move "VAP related" code - https://github.com/open-policy-agent/gatekeeper/blob/master/pkg/controller/constraint/constraint_controller.go#L623 to EOF - under transform. wdyt? @open-policy-agent/gatekeeper-maintainers

+1 and https://github.com/open-policy-agent/gatekeeper/blob/master/pkg/controller/constrainttemplate/constrainttemplate_controller.go#L750 will need to be moved too

@abhipatnala abhipatnala force-pushed the move_cel_driver branch 4 times, most recently from 639f1b5 to 6efad9d Compare October 14, 2024 20:55
@@ -2,6 +2,8 @@ module github.com/open-policy-agent/gatekeeper/v3

go 1.22.0

replace github.com/open-policy-agent/frameworks/constraint v0.0.0-20240927180816-0f64229c5539 => github.com/abhipatnala/frameworks/constraint v0.0.0-20241010172729-61e15952c5c5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abhipatnala can you pls open a PR on framework as well so we can review and get it merged before merging this one? thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ritazh Here is the Pr for removing cel driver from framework: open-policy-agent/frameworks#486

@JaydipGabani
Copy link
Contributor

is k8scel driver going to be removed from frameworks after these changes are in GK?

I think we should move "VAP related" code - https://github.com/open-policy-agent/gatekeeper/blob/master/pkg/controller/constraint/constraint_controller.go#L623 to EOF - under transform. wdyt? @open-policy-agent/gatekeeper-maintainers

@abhipatnala can you move this code as well and the code block suggested by @ritazh in above comment?

Avinash Patnala added 4 commits October 23, 2024 17:37
Signed-off-by: Avinash Patnala <[email protected]>
…ginal repo for testing

Signed-off-by: Avinash Patnala <[email protected]>
… once we fallback to original framwork repo

Signed-off-by: Avinash Patnala <[email protected]>
Signed-off-by: Avinash Patnala <[email protected]>
Signed-off-by: Avinash Patnala <[email protected]>
@abhipatnala
Copy link
Contributor Author

abhipatnala commented Oct 23, 2024

is k8scel driver going to be removed from frameworks after these changes are in GK?

Ideally this PR should test against a PR in framework that removes the k8scel driver to ensure all k8scel changes are migrated from framework to GK.

I think we should move "VAP related" code - https://github.com/open-policy-agent/gatekeeper/blob/master/pkg/controller/constraint/constraint_controller.go#L623 to EOF - under transform. wdyt? @open-policy-agent/gatekeeper-maintainers

+1 and https://github.com/open-policy-agent/gatekeeper/blob/master/pkg/controller/constrainttemplate/constrainttemplate_controller.go#L750 will need to be moved too

I have updated the pr with those changes @ritazh @JaydipGabani

@maxsmythe
Copy link
Contributor

Actually, reflecting on moving vapForVersion and vapBindingForVersion, I think those should stay with the controller code.

This is because they are entirely used by the controllers as a way to govern which API version they use to communicate with the API server and are tightly coupled to the implementation of the controllers themselves.

Under the theory that centralized code should have official versions that it supports (usually versionless), we should avoid introducing versioning semantics anywhere other than the edge (i.e. immediately before requests are sent to K8s).

Arguably this is also true for the IsVapAPIEnabled as well, but at least there the code is shared, so having a common import path makes sense. I don't like the idea of the drivers/k8scel package interacting with the API server directly (this makes its functionality selectively portable to other use cases like Gator), but there is no great central owner. Leaving it in constraint controller also works.

@maxsmythe
Copy link
Contributor

NOT moving the functions defined in the constraint/template controller would also limit merge conflicts with Jaydip's PR adding time delay to binding creation.

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 this pull request may close these issues.

Move pkg/driver/k8snative from framework
5 participants