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

feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] #1382

Merged
merged 5 commits into from
Apr 17, 2024

Conversation

binbin-li
Copy link
Collaborator

@binbin-li binbin-li commented Apr 11, 2024

Description

What this PR does / why we need it:

This is the 5th PR for multi-tenancy support. Please review #1380 first. Check diff between PR 4 and PR 5 at: binbin-li#120

  1. Add a CertStoreManager interface to wrap operations on namespaced certStore resources.
  2. Update certStore references to use the new CertStoreManager interface instead of directly accessing cert stores.
  3. Move the CertificatesMap under controllers to resource_map.go so that it can be shared by clustered and namespaced controllers in the future.
  4. Updated unit tests. Some unit tests are not added in this PR as we'll change the behavior soon.
  5. For the interface implementation, it's in a transition stage that keeps the old behavior. Will update the implementation once Ratify fully supports multi-tenancy.

Note:
The nested certStore map is like:

	 {
	   "namespace1": {
	     "namespace1/store1": []*x509.Certificate,
	     "namespace1/store2": []*x509.Certificate
	   },
	   "namespace2": {
	     "namespace2/store1": []*x509.Certificate,
	     "namespace2/store2": []*x509.Certificate
	   }
	 }

We keep the namespace prefix for inner map key to faciliate accessing from verifier.

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 #

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Copy link

codecov bot commented Apr 11, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 65.52%. Comparing base (73ef709) to head (a58cd72).
Report is 19 commits behind head on staging.

Files Patch % Lines
pkg/manager/manager.go 0.00% 3 Missing ⚠️
pkg/controllers/certificatestore_controller.go 0.00% 2 Missing ⚠️
pkg/controllers/policy_controller.go 50.00% 1 Missing ⚠️
pkg/controllers/store_controller.go 50.00% 1 Missing ⚠️
pkg/controllers/verifier_controller.go 50.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           staging    #1382      +/-   ##
===========================================
+ Coverage    65.31%   65.52%   +0.21%     
===========================================
  Files          105      109       +4     
  Lines         5458     5570     +112     
===========================================
+ Hits          3565     3650      +85     
- Misses        1535     1565      +30     
+ Partials       358      355       -3     

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

@binbin-li binbin-li force-pushed the multi-tenancy-pr-5 branch from b206dc3 to 1904b01 Compare April 12, 2024 07:43
@binbin-li binbin-li changed the title feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] [WIP] feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] Apr 12, 2024
@binbin-li binbin-li force-pushed the multi-tenancy-pr-5 branch from 1904b01 to bedadfa Compare April 12, 2024 13:18
@binbin-li binbin-li changed the title [WIP] feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] Apr 12, 2024
@binbin-li binbin-li changed the title feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] [WIP] feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] Apr 12, 2024
@binbin-li binbin-li force-pushed the multi-tenancy-pr-5 branch 2 times, most recently from 29322ca to 1e62aca Compare April 15, 2024 02:33
@binbin-li binbin-li changed the title [WIP] feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] feat: add certStoreManager interface to wrap operations on namespaced certStores [multi-tenancy PR 5] Apr 15, 2024
@binbin-li binbin-li force-pushed the multi-tenancy-pr-5 branch from 1e62aca to f3f2d13 Compare April 15, 2024 03:07
@binbin-li binbin-li force-pushed the multi-tenancy-pr-5 branch from 1d3450e to b22785c Compare April 17, 2024 02:47
susanshi
susanshi previously approved these changes Apr 17, 2024
Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

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

Looks good to me. thanks!

@binbin-li binbin-li enabled auto-merge (squash) April 17, 2024 06:02
@binbin-li binbin-li merged commit 3e656b1 into ratify-project:staging Apr 17, 2024
17 checks passed
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.

2 participants