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

docs: add examples for using AWS Signer #875

Merged
merged 5 commits into from
Jun 19, 2023

Conversation

byronchien
Copy link
Contributor

Description

What this PR does / why we need it:

Adds documentation on using Gatekeeper/Ratify to verify signatures with notation and AWS Signer.

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

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

@codecov
Copy link

codecov bot commented Jun 10, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (0d03e79) 54.87% compared to head (2ab1e5a) 54.87%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #875   +/-   ##
=======================================
  Coverage   54.87%   54.87%           
=======================================
  Files          81       81           
  Lines        4798     4798           
=======================================
  Hits         2633     2633           
  Misses       1883     1883           
  Partials      282      282           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: Byron Chien <byronc@ucla.edu>
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.

lgtm

@susanshi
Copy link
Collaborator

thanks for the PR @byronchien , the content looks good to me! wondering if AWS Signer is the currently recommended approach , and if we should highlight that. @jimmyraywv , let us know if you have any feedback before we merge this. thanks!

@byronchien
Copy link
Contributor Author

thanks for the PR @byronchien , the content looks good to me! wondering if AWS Signer is the currently recommended approach , and if we should highlight that. @jimmyraywv , let us know if you have any feedback before we merge this. thanks!

yes, using AWS Signer with notation on AWS is the recommended approach.

@akashsinghal akashsinghal merged commit 2001dfe into ratify-project:main Jun 19, 2023
bspaans pushed a commit to bspaans/ratify that referenced this pull request Oct 17, 2023
Signed-off-by: Byron Chien <byronc@ucla.edu>
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.

[Doc] Update documentation for using Ratify with AWS Signer
4 participants