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

Add documentation about package signing model #30939

Merged
merged 5 commits into from
Jun 7, 2023

Conversation

kotfic
Copy link
Contributor

@kotfic kotfic commented May 31, 2022

This PR provides documentation for the current AWS based package signing approach and serves as part of a larger data integrity assurance case.

@kotfic kotfic added documentation Improvements or additions to documentation security ci Issues related to Continuous Integration labels May 31, 2022
Copy link
Contributor

@scottwittenburg scottwittenburg left a comment

Choose a reason for hiding this comment

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

Thanks @kotfic this is looking really great 🎉

I've requested some minor changes, but the main issue might be that the docs build is failing. There are a few places where double backtics are not closed, which might account for most of the doc build errors. Also, this needs to be linked from somewhere in the table of contents or somewhere doesn't it? I think that's causing the final error.

Doc build errors:

/home/docs/checkouts/readthedocs.org/user_builds/spack/checkouts/30939/lib/spack/docs/signing.rst:307: WARNING: Inline literal start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/spack/checkouts/30939/lib/spack/docs/signing.rst:349: WARNING: Inline literal start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/spack/checkouts/30939/lib/spack/docs/signing.rst:427: WARNING: Inline literal start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/spack/checkouts/30939/lib/spack/docs/signing.rst:427: WARNING: Inline literal start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/spack/checkouts/30939/lib/spack/docs/signing.rst:427: WARNING: Inline literal start-string without end-string.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/spack/checkouts/30939/lib/spack/docs/signing.rst: WARNING: document isn't included in any toctree

lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
lib/spack/docs/signing.rst Outdated Show resolved Hide resolved
@kotfic
Copy link
Contributor Author

kotfic commented Jun 3, 2022

This appears to be passing now except for a warning about not being included in any toctree. @tgamblin Where would you like this documentation linked from? Thanks!

@spackbot-app spackbot-app bot added the core PR affects Spack core functionality label Jan 9, 2023
@kotfic kotfic changed the title [WIP] Add documentation about package signing model Add documentation about package signing model Jan 9, 2023
@alalazo alalazo added this to the v0.19.1 milestone Jan 17, 2023
@haampie haampie modified the milestones: v0.19.1, v0.19.2 Feb 9, 2023
@alalazo
Copy link
Member

alalazo commented Feb 15, 2023

Is this PR just waiting for another review?

@scottwittenburg
Copy link
Contributor

Is this PR just waiting for another review?

Also appears from a comment above that @kotfic wanted to know where this should be linked from.

@alalazo
Copy link
Member

alalazo commented Feb 15, 2023

What about inserting it below the sections on CI pipelines? That seems the appropriate place to me since we would introduce CI pipelines first, and then explain how we are signing the buildcaches from our public pipelines. Does that seem fine?

@scottwittenburg
Copy link
Contributor

What about inserting it below the sections on CI pipelines?

Yes, that makes sense to me.

@alalazo alalazo self-assigned this Feb 16, 2023
@alalazo
Copy link
Member

alalazo commented Feb 16, 2023

@kotfic If you have time to push this forward, I'll try to prioritize review to it.

@alalazo alalazo modified the milestones: v0.19.2, v0.19.3 Apr 4, 2023
@alalazo alalazo removed this from the v0.19.3 milestone Jun 7, 2023
@alalazo
Copy link
Member

alalazo commented Jun 7, 2023

@scottwittenburg @zackgalbreath Can you double check if what is written here is still up to date? If so I'll take care of fixing the readthedocs failure and merge the PR.

@scottwittenburg
Copy link
Contributor

I just read through it again, and yes, this is still an accurate and complete description of our package signing model.

@alalazo
Copy link
Member

alalazo commented Jun 7, 2023

Thanks @scottwittenburg I'll try to merge this one asap then

@alalazo alalazo merged commit 785c1a2 into spack:develop Jun 7, 2023
30 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Issues related to Continuous Integration core PR affects Spack core functionality documentation Improvements or additions to documentation security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants