Skip to content

Document approaches for site builds on top of EESSI - #778

Merged
Neves-P merged 40 commits into
EESSI:mainfrom
casparvl:site_builds
Sep 30, 2026
Merged

Neves-P merged 40 commits into
EESSI:mainfrom
casparvl:site_builds

Conversation

@casparvl

@casparvl casparvl commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@casparvl casparvl changed the title Add initial files for each site-building approach Document approaches for site builds on top of EESSI Jun 4, 2026
ocaisa
ocaisa previously requested changes Jun 9, 2026

@ocaisa ocaisa left a comment

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.

Found some typos

Comment thread docs/site_build/overview.md Outdated
Comment thread docs/site_build/overview.md Outdated
Comment thread docs/site_build/overview.md Outdated
Comment thread docs/site_build/overview.md Outdated
Comment thread docs/site_build/overview.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md
@casparvl
casparvl marked this pull request as ready for review June 30, 2026 14:36
Caspar van Leeuwen and others added 2 commits July 1, 2026 17:36
…cript. Also, added a full, copyable script combining all the previous components.

@Neves-P Neves-P left a comment

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.

Looks really nice! This is my first pass of comments, as of know I only focused on the text. This week I will follow the documentation in practice and review again.

Comment thread docs/site_build/site_cvmfs.md
Comment thread docs/site_build/shared_fs.md Outdated
Comment thread docs/site_build/shared_fs.md Outdated
Comment thread docs/site_build/shared_fs.md Outdated
Comment thread docs/site_build/site_cvmfs.md
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
bedroge and others added 2 commits September 2, 2026 09:53
Co-authored-by: Pedro Santos Neves <10762799+Neves-P@users.noreply.github.com>
Co-authored-by: Bob Dröge <b.e.droge@rug.nl>
Comment thread docs/site_build/site_cvmfs.md Outdated
Co-authored-by: Bob Dröge <b.e.droge@rug.nl>

@Neves-P Neves-P left a comment

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.

Suggestions with updates accounting for VERSIONS_SUBPATH workflow in ingest-tarball.sh.

Comment thread docs/site_build/site_cvmfs.md
Comment thread docs/site_build/site_cvmfs.md
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md
Comment thread docs/site_build/site_cvmfs.md
@Neves-P
Neves-P requested a review from bedroge September 18, 2026 13:02
Co-authored-by: Pedro Santos Neves <10762799+Neves-P@users.noreply.github.com>
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment on lines +1214 to +1218
# We will leverage a script from eessi-bot-software-layer (for signature verification - optional)
git clone https://github.com/EESSI/eessi-bot-software-layer.git

# We will leverage a script from filesystem-layer (for tarball ingestion)
git clone https://github.com/EESSI/filesystem-layer.git

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Having these here will break things for a second run, as these dirs will already exist. We should either add a check, or maybe just let people do this manually and add a variable for the paths to these dirs at the top? I think I'd prefer the latter, makes it a bit more flexible in case you want to (temporarily) modify these scripts, e.g. for testing.

Comment thread docs/site_build/site_cvmfs.md Outdated
Comment on lines +1317 to +1323
if [ $? -eq 0 ]; then
echo "Tarball signature file downloaded."
else
echo "WARNING: Failed to download tarball signature file. Continuing to next tarball (not ingesting ${filename})."
# No point in continuing this loop iteration, we'll fail the signature verification check anyway
continue
fi

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This basically does mean that it's not optional, as it will now entirely skip tarballs with a signature file. Maybe we should have another variable at the top that allows people to enable/disable the signature checking? If it's enabled but the sig file(s) cannot be downloaded -> hard error for that tarball. If it's disabled, don't even try.

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.

I tried addressing this in the last batch of suggestions.

@Neves-P Neves-P left a comment

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.

I haven't tested this in the wild yet, but here's a simple proposal for handling cases when we don't want to sign the files. It ignores that step if $ALLOWED_SIGNERS is not set and writes a message saying so. If the file is there, it carries on with the signature workflow as usual.

Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
Comment thread docs/site_build/site_cvmfs.md Outdated
bedroge and others added 2 commits September 25, 2026 15:57
Co-authored-by: Pedro Santos Neves <10762799+Neves-P@users.noreply.github.com>
Co-authored-by: Pedro Santos Neves <10762799+Neves-P@users.noreply.github.com>
Comment thread docs/site_build/site_cvmfs.md Outdated
@Neves-P
Neves-P requested a review from bedroge September 25, 2026 15:58
@Neves-P

Neves-P commented Sep 25, 2026

Copy link
Copy Markdown
Member

I think I got everything now, @bedroge 🤞

@bedroge bedroge left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The current version of the auto-ingestion script worked fine for me (I didn't use/test the signing part, though). Note that I haven't checked the other parts in detail, but it looks like @Neves-P did that (?). So, if you're also okay with it, I'd say we merge this and improve things later if necessary. Given the size of this document, it's hard to read/review the unrendered document anyway 😄

@Neves-P

Neves-P commented Sep 29, 2026

Copy link
Copy Markdown
Member

I think we should merge this indeed!

We've collectively reviewed and tried this a lot. We may find small issues along the way as more and more sites test it, but I think we're at a stage where the information is tried in the wild for a couple of sites, RUG included. As more sysadmins implement it we will probably find out edge cases or inaccuracies we haven't spotted yet, but we can should always keep improving the docs anyway.

@Neves-P
Neves-P enabled auto-merge September 29, 2026 14:36
@Neves-P

Neves-P commented Sep 29, 2026

Copy link
Copy Markdown
Member

I think we also need @ocaisa's approval here ;)

@bedroge

bedroge commented Sep 29, 2026

Copy link
Copy Markdown
Collaborator

I think we also need @ocaisa's approval here ;)

He better reads the entire document and tests all the steps 🤣
But I think all his comments have been addressed, so otherwise we can probably dismiss his review.

@Neves-P

Neves-P commented Sep 29, 2026

Copy link
Copy Markdown
Member

I didn't know we could dismiss comments 😆

Then sure, that makes sense (unless you're looking for a new book to read, Alan 😆 )

@Neves-P
Neves-P dismissed ocaisa’s stale review September 30, 2026 11:36

I think these have all been addressed already in subsequent reviews.

@Neves-P
Neves-P disabled auto-merge September 30, 2026 11:37
@Neves-P
Neves-P merged commit 72e5d54 into EESSI:main Sep 30, 2026
1 check passed
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.

Add documentation on how to build on top of EESSI as a site - and include the use of EESSI_SITE_SOFTWARE_PREFIX in that

4 participants