Skip to content

doc: update to support OCI image manifest#502

Merged
patrickzheng200 merged 10 commits intonotaryproject:mainfrom
yizha1:image-manifest
Jan 13, 2023
Merged

doc: update to support OCI image manifest#502
patrickzheng200 merged 10 commits intonotaryproject:mainfrom
yizha1:image-manifest

Conversation

@yizha1
Copy link
Copy Markdown
Contributor

@yizha1 yizha1 commented Jan 7, 2023

Updates:

  • Add a new section of "Use OCI image manifest to store signatures"
  • Add new usage examples

Signed-off-by: Yi Zha yizha1@microsoft.com

Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1 yizha1 added documentation Improvements or additions to documentation spec Specifications to define the product requirements labels Jan 7, 2023
@yizha1 yizha1 added this to the RC-2 milestone Jan 7, 2023
@yizha1 yizha1 requested a review from shizhMSFT January 7, 2023 12:46
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 7, 2023

Codecov Report

Merging #502 (c4cdb05) into main (6fb9eef) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #502   +/-   ##
=======================================
  Coverage   29.57%   29.57%           
=======================================
  Files          26       26           
  Lines        1515     1515           
=======================================
  Hits          448      448           
  Misses       1050     1050           
  Partials       17       17           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Signed-off-by: Yi Zha <yizha1@microsoft.com>
yizha1 added 2 commits January 8, 2023 09:09
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Copy link
Copy Markdown
Contributor

@patrickzheng200 patrickzheng200 left a comment

Choose a reason for hiding this comment

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

LGTM

--plugin-config strings {key}={value} pairs that are passed as it is to a plugin, refer plugin's documentation to set appropriate values
--signature-format string signature envelope format, options: 'jws', 'cose' (default "jws")
-u, --username string username for registry operations (default to $NOTATION_USERNAME if not specified)
--use-image-manifest optional for using OCI image manifest to store signatures in a registry
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

should we use some user friendly name here instead of internal implementation? like --use-oci-1.1 to reflect that if registry support oci1.1 add this flag ?

I know its not a good name but I'm open to suggestions

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@shizhMSFT @FeynmanZhou any suggestions on the flag name?

Copy link
Copy Markdown
Contributor Author

@yizha1 yizha1 Jan 12, 2023

Choose a reason for hiding this comment

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

how about the pattern --image-spec <version>-<manifest type> @priteshbandi

---image-spec string   specify the manifest type for signatures. options: v1.1-artifact, v1.1-image (default: v1.1-artifact)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1. ORAS CLI uses --image -spec <spec version>-<manifest type> for this kind of scenario.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah --image-spec looks good to me.

@iamsamirzon would like to get your opinion here

Signed-off-by: Yi Zha <yizha1@microsoft.com>
@patrickzheng200
Copy link
Copy Markdown
Contributor

@yizha1 Looks like this PR requires resolving conflicts now.

Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1 yizha1 requested a review from priteshbandi January 13, 2023 06:40
Copy link
Copy Markdown
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Yi Zha <yizha1@microsoft.com>
Copy link
Copy Markdown
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@patrickzheng200 patrickzheng200 left a comment

Choose a reason for hiding this comment

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

LGTM

@patrickzheng200 patrickzheng200 merged commit b72a565 into notaryproject:main Jan 13, 2023
priteshbandi pushed a commit to priteshbandi/notation that referenced this pull request Feb 1, 2023
Signed-off-by: Yi Zha <yizha1@microsoft.com>
7h3-3mp7y-m4n pushed a commit to 7h3-3mp7y-m4n/notation that referenced this pull request Mar 29, 2025
Signed-off-by: Yi Zha <yizha1@microsoft.com>
FeynmanZhou pushed a commit to FeynmanZhou/notation that referenced this pull request May 15, 2025
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation spec Specifications to define the product requirements

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

7 participants