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: Improve docs for tag-based attachment discovery scheme #1895

Closed
imjasonh opened this issue May 18, 2022 · 1 comment
Closed

docs: Improve docs for tag-based attachment discovery scheme #1895

imjasonh opened this issue May 18, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@imjasonh
Copy link
Member

Description

The tag naming scheme cosign relies on to attach signatures, SBOMs, etc., to images in any OCI registry is not very well documented.

https://github.com/sigstore/cosign/blob/main/specs/SIGNATURE_SPEC.md#tag-based-discovery mentions the .sig suffix for signatures, but there aren't similar docs for attestations or SBOMs.

CLI docs for cosign attach attestation make a brief mention of the attachment prefix, but don't go into much detail about the suffix, i.e., what AttachmentName refers to, or is in the case of attestations.

      --attachment-tag-prefix [AttachmentTagPrefix]sha256-[TargetImageDigest].[AttachmentName]   optional custom prefix to use for attached image tags. Attachment images are tagged as: [AttachmentTagPrefix]sha256-[TargetImageDigest].[AttachmentName]

I think we might want to hoist the tag-based discovery docs out into a separate spec, and reference them from docs for signatures, SBOMs, attestations, etc., as specific examples of attachments.

@imjasonh imjasonh added the enhancement New feature or request label May 18, 2022
@znewman01
Copy link
Contributor

This will be obsoleted by #1397 IIUC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants