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 slsa provenance documentation #3375

Merged
merged 10 commits into from
Jan 5, 2023

Conversation

jedevc
Copy link
Member

@jedevc jedevc commented Dec 8, 2022

🛠️ Fixes #3335.
⬆️ Follow up to #3240 (comment).

We should revisit both this and the sbom docs once docker/buildx#1444 is merged, so we can give more detailed commands about how to view the example outputs.

@jedevc jedevc added this to the v0.11.0 milestone Dec 8, 2022
@jedevc jedevc requested a review from tonistiigi December 8, 2022 11:55
@jedevc jedevc force-pushed the attestations-provenance-docs branch from daa0989 to fb72ae8 Compare December 8, 2022 12:14
@jedevc jedevc force-pushed the attestations-provenance-docs branch from fb72ae8 to c35741d Compare December 16, 2022 11:33
docs/slsa.md Outdated
| -------------- | -------------- | ---------------- | ----------------------------------------------------------------------------------------------------------- |
| `mode` | `min`,`max` | `max` | Configures the amount of provenance to be generated. See [mode](#mode) |
| `builder-id` | String | | Explicitly set SLSA [`builder.id`](https://slsa.dev/provenance/v0.2#builder.id) field |
| `reproducible` | `true`,`false` | `false` | Explicitly set SLSA [`metadata.reproducible`](https://slsa.dev/provenance/v0.2#metadata.reproducible) field |
Copy link
Member

Choose a reason for hiding this comment

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

Setting SOURCE_DATE_EPOCH might influence this field as well as build timestamps?

@tonistiigi
Copy link
Member

Added another commit with updates.

PTAL @dvdksn (feel free to update directly)

docs/slsa.md Outdated Show resolved Hide resolved
@dvdksn
Copy link
Collaborator

dvdksn commented Dec 22, 2022

Couldn't push directly to this branch so I opened a PR: jedevc#3

jedevc and others added 7 commits January 4, 2023 10:05
Signed-off-by: Justin Chadwell <me@jedevc.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: David Karlsson <david.karlsson@docker.com>
Signed-off-by: David Karlsson <david.karlsson@docker.com>
Signed-off-by: David Karlsson <david.karlsson@docker.com>
@jedevc jedevc force-pushed the attestations-provenance-docs branch from fa99051 to 4664605 Compare January 4, 2023 10:06
@jedevc
Copy link
Member Author

jedevc commented Jan 4, 2023

Merged @dvdksn's fixes, this should be ready to merge now.

@dvdksn
Copy link
Collaborator

dvdksn commented Jan 4, 2023

as discussed yesterday on sync, we might want to make the cross-links between the slsa and slsa-definitions pages more prominent. could you add a link in the top section for each page?

not sure if there is any issue with relative cross-linking when the page gets pulled in the docs repo, if the cross-linked page is not included but another one exists in it's place. Hopefully it's fine, I guess we'll find out :-)

jedevc added 2 commits January 5, 2023 10:49
Signed-off-by: Justin Chadwell <me@jedevc.com>
Signed-off-by: Justin Chadwell <me@jedevc.com>
docs/slsa.md Outdated
@@ -0,0 +1,99 @@
# SLSA provenance
Copy link
Member

Choose a reason for hiding this comment

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

Should the file be named slsa-provenance.md instead?

Also as discussed, we could replace this section https://github.com/moby/buildkit/blob/master/docs/build-repro.md#build-dependencies and link to this file?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we can do the build dependencies update as a follow-up? I think the whole page probably needs reworking with the introduction of provenance, since we're reworking how buildinfo works entirely.

Agreed on the slsa-provenance.md rename 🎉

Copy link
Member

Choose a reason for hiding this comment

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

Fine to me as follow-up

Signed-off-by: Justin Chadwell <me@jedevc.com>
@jedevc jedevc merged commit 2c88c6f into moby:master Jan 5, 2023
@tonistiigi tonistiigi mentioned this pull request Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for SLSA provenance attestations
4 participants