Skip to content

Document approaches for site builds on top of EESSI#778

Open
casparvl wants to merge 27 commits into
EESSI:mainfrom
casparvl:site_builds
Open

Document approaches for site builds on top of EESSI#778
casparvl wants to merge 27 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 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.


Another thing to consider is to create a secondary user with `aws iam create-user --user-name <name>` and attach a very limited policy to it (e.g. only read/write/list on buckets, nothing else). Then, create credentials for this user with `aws iam create-access-key --user-name <name>` and provide those credentials to the EESSI build bot and Stratum 0 machines. That way, if that token is compromized, the impact is minimized (e.g. the token can at least not be used to create new IAM idententies, etc).

## Setting up the EESSI build bot

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'd consider separating this into a new page. The build bot is somewhat self contained and the page is quite long already.

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

Another thing to consider is to create a secondary user with `aws iam create-user --user-name <name>` and attach a very limited policy to it (e.g. only read/write/list on buckets, nothing else). Then, create credentials for this user with `aws iam create-access-key --user-name <name>` and provide those credentials to the EESSI build bot and Stratum 0 machines. That way, if that token is compromised, the impact is minimized (e.g. the token can at least not be used to create new IAM idententies, etc).

## Setting up the EESSI build bot

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I realize these docs lack one crucial thing: setting up a site_config_script that sets EESSI_SITE_INSTALL_FORCE and EESSI_SITE_SOFTWARE_PATH_PREFIX

@casparvl casparvl Jul 22, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I.e. at SURF, our site_config_script looks like this:

# To build on top of EESSI, we need to software.eessi.io repository to be mounted next to our own repository
# The bot/build.sh script does this when the EESSI_SITE_INSTALL_FORCE environment variable is set
# Other build scripts will also respect this variable where needed in order to make sure that 'building on top'
# of EESSI is possible
export EESSI_SITE_INSTALL_FORCE=1
echo "Value of EESSI_SITE_INSTALL_FORCE: $EESSI_SITE_INSTALL_FORCE"

# We also need to set a prefix that our installations should end up in
# The build scripts should take this prefix, and construct the final EESSI_SITE_SOFTWARE_PATH out of it
# that the EESSI-extend module expects
export EESSI_SITE_SOFTWARE_PATH_PREFIX=/cvmfs/software.surf.nl/versions/2025.06/
echo "Value of EESSI_SITE_SOFTWARE_PATH_PREFIX: $EESSI_SITE_SOFTWARE_PATH_PREFIX"

One thing to figure out might be how to avoid hard-coding the version in here :)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Scratch that, this should not be needed anymore... I think we do this differently now... We automatically set these here https://github.com/EESSI/software-layer-scripts/blob/ca929cd7ef32a9fcd79fafd4e0d5c362a1fff452/bot/build.sh#L156 . That happens if the repo_name in the repos config file is unequal to software.eessi.io or dev.eess.io essentially.

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