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 key support to key management provider #1333

Merged

Conversation

akashsinghal
Copy link
Collaborator

@akashsinghal akashsinghal commented Mar 13, 2024

Description

What this PR does / why we need it:

This is the 2nd in a series of PRs to enable a brand new cosign experience.

  • Adds key support to KeyManagementProvider resource
  • Updates KMP API
  • Adds support for key + certs status for AKV provider
  • Updates AKV Provider to fetch a key specified
  • Adds new maps to store keys in a universal addressable map
  • Refactor azure KV client logic to be cert + key agnostic
  • Adds unit tests
  • Adds e2e tests
  • updates helm chart to: deprecate notationCert value (update docs). and deprecate akvCertConfig section in favor of new azurekeyvault section.

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 #1296

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

@akashsinghal akashsinghal self-assigned this Mar 13, 2024
Copy link

codecov bot commented Mar 13, 2024

Codecov Report

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

Project coverage is 65.20%. Comparing base (73ef709) to head (b3fc5b8).
Report is 4 commits behind head on staging.

❗ Current head b3fc5b8 differs from pull request most recent head dae34b6. Consider uploading reports for the commit dae34b6 to get more accurate results

Files Patch % Lines
...kg/keymanagementprovider/azurekeyvault/provider.go 64.00% 25 Missing and 2 partials ⚠️
pkg/keymanagementprovider/inline/provider.go 50.00% 10 Missing ⚠️
...kg/controllers/keymanagementprovider_controller.go 0.00% 9 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           staging    #1333      +/-   ##
===========================================
- Coverage    65.31%   65.20%   -0.12%     
===========================================
  Files          105      105              
  Lines         5458     5521      +63     
===========================================
+ Hits          3565     3600      +35     
- Misses        1535     1567      +32     
+ Partials       358      354       -4     

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

@akashsinghal akashsinghal marked this pull request as ready for review March 26, 2024 23:12
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.

thanks for the PR! left some questions for keys test coverage.

pkg/keymanagementprovider/keymanagementprovider.go Outdated Show resolved Hide resolved
scripts/azure-ci-test.sh Show resolved Hide resolved
@akashsinghal akashsinghal changed the base branch from main to staging April 9, 2024 16:55
Copy link
Collaborator

@binbin-li binbin-li left a comment

Choose a reason for hiding this comment

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

lgtm

@akashsinghal akashsinghal merged commit 2894b51 into ratify-project:staging Apr 10, 2024
11 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.

Add keys support to new key management resource
3 participants