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: allow multiple notationCert in default chart #1151

Merged
merged 12 commits into from
Nov 8, 2023

Conversation

susanshi
Copy link
Collaborator

@susanshi susanshi commented Oct 27, 2023

Doc updates are pushed to PR , ratify-project/ratify-web#31

Description

  • update deployment template to create multiple inline cert provider
  • extract release name into global variable
  • updated e2e test for using cert array
  • add note about deprecation for notationCert value

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

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

Mutiple cert scenario covered by e2e install commands
helmfile still uses single cert value to provide some coverage

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

@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9efd50b) 52.44% compared to head (63465b8) 52.39%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1151      +/-   ##
==========================================
- Coverage   52.44%   52.39%   -0.05%     
==========================================
  Files         101      101              
  Lines        6344     6344              
==========================================
- Hits         3327     3324       -3     
- Misses       2697     2699       +2     
- Partials      320      321       +1     

see 1 file with indirect coverage changes

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

@susanshi susanshi changed the title fix: allow multi notationCert fix: allow multiple notationCert in default chart Oct 27, 2023
@susanshi susanshi marked this pull request as ready for review November 1, 2023 23:22
notation.crt Outdated Show resolved Hide resolved
@susanshi
Copy link
Collaborator Author

susanshi commented Nov 2, 2023

Still investining e2e failure, Looks like references to ratify-notation-inline-cert, needs to be updated

@susanshi
Copy link
Collaborator Author

susanshi commented Nov 2, 2023

Still investining e2e failure, Looks like references to ratify-notation-inline-cert, needs to be updated

Fixed! :)

Copy link
Collaborator

@junczhu junczhu 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
Copy link
Collaborator

@susanshi I think some of our website quickstarts might need to be updated? Should we hold off on that until next release?

@akashsinghal
Copy link
Collaborator

@susanshi not a block change but I think we should consider updating our helmfiles to use the new array-based helm value.

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.

general question, when users provide both notationCert and notationCerts, current implementation will take both. Wonder if we should enforce users to select one of them, which could guide users deprecate notatiionCert gradually. It's not a strong opinion, not a blocker for this pr.

@@ -43,7 +43,8 @@ $ helm upgrade -n gatekeeper-system [RELEASE_NAME] ratify/ratify
| replicaCount | The number of Ratify replicas in deployment | 1 |
| affinity | Pod affinity for the Ratify deployment | `{}` |
| tolerations | Pod tolerations for the Ratify deployment | `[]` |
| notationCert | Public certificate/certificate chain used to create inline certstore used by Notation verifier. | `` |
| notationCert | Public certificate/certificate chain used to create inline certstore used by Notation verifier. This value will be ***deprecated*** in Ratify 1.3 release. Please switch to using notationCerts to specify an array of verification certificates | `` |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I might miss the related discussion, did we make the decision to deprecate it in 1.3 release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is value is deprecated, and will be removed in future releases for Ratify

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixed.

notation.crt Outdated Show resolved Hide resolved
Copy link
Collaborator

@akashsinghal akashsinghal 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 update!

@susanshi
Copy link
Collaborator Author

susanshi commented Nov 8, 2023

Doc updates are pushed to PR , ratify-project/ratify-web#31

@susanshi susanshi enabled auto-merge (squash) November 8, 2023 01:27
@susanshi susanshi merged commit 22b0076 into ratify-project:main Nov 8, 2023
19 of 20 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.

[helm] Make default verifier more configurable
4 participants