Running a cluster software stack on Windows with EESSI¶

The goal of the EESSI project is to make a full software stack available with binaries optimised for several popular architectures via a read-only web based file system. So software is served on demand and does not require installing the complete stack on your PC.

To this end it uses the so-called CernVM-FS file system. This requires the installation of some additional software in WSL 2 that does not come from the standard software libaries. WSL 2 also for a long time did not support the mechanisms that are needed to start the file system daemons automatically so a manual intervention may be needed each time you restart WSL 2.

At the time of writing of the last revision (December 2023), EESI is still very much in a prototype phase. However, it got some funding through the EuroHPC Centre of Excellence MultiXScale for further development so the speed may pick up a little. The EESSI documentation was outdated and did not yet cover the new setup that requires far fewer steps to get CernVM-FS working, so the instructions below are the result of some experimenting als.

Getting it to work (without using a container, which would also require installing additional software in most if not all WSL Linux distributions) does require an initial effort.

Example: Setup on OpenSUSE in WSL2¶

Last update: 4 May 2024

The "Getting Started" section of the CernVM-FS manual unfortunately does not contain instructions for SUSE Linux. There are relevant files though in the CVMFS repository @ CERN. In particular, look for the files in the newest cvmfs-* subdirectory and the cvmfs-config subdirectory.

This setup is for openSUSE 15 (tested with 15.5) on WSL2 with systemd enabled so that the automounter can be used and so that it is no longer needed to call cvmfs_config wsl2_start every time the openSUSE distribution in WSL is restarted.

Ensure you have a openSUSE WSL2 setup with systemd running. We'll enable autofs after installing EESSI (as it is installed as a dependency of EESSI if it has not yet been installed for other reasons).
- Ensure that the wsl_systemd pattern is installed to fully enable systemd:
```
sudo zypper install -n -t pattern wsl_systemd
```
  There are other useful patterns also and they do not always play nice with updating /etc/wsl.conf...
- Ensure that /etc/wsl.conf exists and that the [boot] section contains the line systemd=true. The minimal such file would be
```
[boot]
systemd=true
```
- Right now it is time to restart the openSUSE WSL2 distribution, e.g., from a normal bash command line:
```
wsl.exe --terminate $WSL_DISTRO_NAME
```
  or from powershell (terminating all WSL2 distros)
```
wsl --shutdown
```
Similarly to what is done on Fedora in the official installation instructions, install directly from this repository.

First check the version in a browser by checkint the cvmfs-* subdirectories at ecsft.cern.ch/dist/cvmfs.

Let's set the version in an environment variable:
```
version='2.11.3`
```
So we can now install the necessary packages with:
```
sudo zypper --no-gpg-checks install \
    https://ecsft.cern.ch/dist/cvmfs/cvmfs-config/cvmfs-config-default-2.1-1.noarch.rpm \
    https://ecsft.cern.ch/dist/cvmfs/cvmfs-$version/cvmfs-$version-1.sle15.x86_64.rpm \
    https://ecsft.cern.ch/dist/cvmfs/cvmfs-$version/cvmfs-libs-$version-1.sle15.x86_64.rpm
```
(You'll have to check the version of cvmfs-config-default also, there is a -latest version but when checking this was actually a rather old file.)
Note that it is no longer needed to install the EESSI configuration file for CernVM-FS (cvmfs-config-eessi-latest.noarch.rpm) as the new EESSI repository is included in the configurations of CVMFS.

Create (you'll have to run in a bash shell as root or run the editor using sudo) the file /etc/cvmfs/default.local. If you're experimenting on a workstation with no nearby cache server for CernVM-FS, then the following would be appropriate:

CVMFS_CLIENT_PROFILE="single"
CVMFS_HTTP_PROXY="DIRECT"
CVMFS_QUOTA_LIMIT=10000

or with bash commands:

sudo bash -c "echo 'CVMFS_CLIENT_PROFILE="single"'  > /etc/cvmfs/default.local"
sudo bash -c "echo 'CVMFS_HTTP_PROXY="DIRECT"'     >> /etc/cvmfs/default.local"
sudo bash -c "echo 'CVMFS_QUOTA_LIMIT=10000'       >> /etc/cvmfs/default.local"

Ensure everybody has read access to the file.

Run the setup of cvmfs:
```
sudo cvmfs_config setup
```

Now edit /etc/auto.master and uncomment the line #+dir:/etc/auto.master.d/. E.g.,

sudo sed -i 's%#+dir:/etc/auto.master.d%+dir:/etc/auto.master.d%' /etc/auto.master

Enable and start the autofs service:
```
sudo systemctl enable autofs.service
sudo systemctl start autofs
```
Or restart the autofs service if it was already present so that the above change takes effect:
```
sudo systemctl restart autofs
```
You should now be able to go into the /cvmfs/software.eessi.io subdirectory even if it is not shown immediately if you do an ls in /cvmfs as it will only be mounted on access.

You can now make EESSI available in a shell with

source /cvmfs/software.eessi.io/versions/2023.06/init/bash

Example: Setup on Fedora Remix in WSL2¶

Last update: 16 December 2023

The "Getting Started" section of the CernVM-FS manual does contain instructions for the Fedora Linux distribution. However, there is no automatic updating of versions and one has to look for the available versions in in the CVMFS repository @ CERN. In particular, look for the files in the newest cvmfs-* subdirectory and the cvmfs-config subdirectory.

This setup is was tested with Fedora Remix version 39 on WSL2 with systemd enabled so that the automounter can be used and so that it is no longer needed to call cvmfs_config wsl2_start every time the Fedora Remix distribution in WSL is restarted.

Ensure you have a Fedora Remix WSL2 setup with systemd running. We'll enable autofs after installing EESSI as it may not yet be on the system but would be pulled in as a dependency of EESSI anyway.
- Ensure that /etc/wsl.conf exists and that the [boot] section contains the line systemd=true. The minimal [boot] section of this file would be
```
[boot]
systemd=true
```
- Right now it is time to restart the Fedora Remix WSL2 distribution, e.g., from a normal bash command line:
```
/mnt/c/Windows/system32/wsl.exe --terminate $WSL_DISTRO_NAME
```
  or from powershell (terminating all WSL2 distros)
```
wsl --shutdown
```

Following the Fedora installation instructions, install directly from this repository.

cvmfs_version='2.11.3'
fedora_version='38'
config_version='2.1-1'
$SUDO dnf --assumeyes install \
    https://ecsft.cern.ch/dist/cvmfs/cvmfs-$cvmfs_version/cvmfs-$cvmfs_version-1.fc$fedora_version.x86_64.rpm \
    https://ecsft.cern.ch/dist/cvmfs/cvmfs-config/cvmfs-config-default-$config_version.noarch.rpm \
    https://ecsft.cern.ch/dist/cvmfs/cvmfs-$cvmfs_version/cvmfs-libs-$cvmfs_version-1.fc$fedora_version.x86_64.rpm

(You'll have to check the version of cvmfs-config-default also, there is a -latest version but when checking this was actually a rather old file.)

Note that it is no longer needed to install the EESSI configuration file for CernVM-FS (cvmfs-config-eessi-latest.noarch.rpm) as the new EESSI repository is included in the configurations of CVMFS.

Create (you'll have to run in a bash shell as root or run the editor using sudo) the file /etc/cvmfs/default.local. If you're experimenting on a workstation with no nearby cache server for CernVM-FS, then the following would be appropriate:

CVMFS_CLIENT_PROFILE="single"
CVMFS_HTTP_PROXY="DIRECT"
CVMFS_QUOTA_LIMIT=10000

or with bash commands:

sudo bash -c "echo 'CVMFS_CLIENT_PROFILE="single"'  > /etc/cvmfs/default.local"
sudo bash -c "echo 'CVMFS_HTTP_PROXY="DIRECT"'     >> /etc/cvmfs/default.local"
sudo bash -c "echo 'CVMFS_QUOTA_LIMIT=10000'       >> /etc/cvmfs/default.local"

Ensure everybody has read access to the file.

Run the setup of cvmfs:
```
sudo cvmfs_config setup
```
Enable and start the autofs service:
```
sudo systemctl enable autofs.service
sudo systemctl start autofs
```
Or restart the autofs service if it was already present so that the above change takes effect:
```
sudo systemctl restart autofs
```
You should now be able to go into the /cvmfs/software.eessi.io subdirectory even if it is not shown immediately if you do an ls in /cvmfs as it will only be mounted on access.

You can now make EESSI available in a shell with

source /cvmfs/software.eessi.io/versions/2023.06/init/bash

Example: Setup on Ubuntu in WSL2¶

Last update: 3 October 2024

The "Getting Started" section of the CernVM-FS manual does contain instructions for the Ubuntu Linux distribution. Contrary to Fedora and openSUSE, there is complete support for Ubuntu so the installation process is slightly different: Rather than downloading specific packages, the CERN repositories are added to the reposit list for Ubuntu and then the installation is done from there.

This setup is was tested with Ubuntu 22.04 on WSL2 with systemd enabled so that the automounter can be used and so that it is no longer needed to call cvmfs_config wsl2_start every time the Ubuntu distribution in WSL is restarted.

Ensure you have a Ubuntu WSL2 setup with systemd running. We'll enable autofs after installing EESSI as it may not yet be on the system but would be pulled in as a dependency of EESSI anyway.
- Ensure that /etc/wsl.conf exists and that the [boot] section contains the line systemd=true. The minimal [boot] section of this file would be
```
[boot]
systemd=true
```
- Right now it is time to restart the Ubuntu WSL2 distribution, e.g., from a normal bash command line:
```
wsl.exe --terminate $WSL_DISTRO_NAME
```
  or from powershell (terminating all WSL2 distros)
```
wsl --shutdown
```

Following the Debian/Ubuntu installation instructions, first add the CERN repositories to the repository list..

pushd /tmp
wget https://ecsft.cern.ch/dist/cvmfs/cvmfs-release/cvmfs-release-latest_all.deb
sudo dpkg -i cvmfs-release-latest_all.deb
rm -f cvmfs-release-latest_all.deb
popd

Next we actually install CernVM-FS:

sudo apt update
sudo apt --assume-yes install cvmfs

Note that it is no longer needed to install the EESSI configuration file for CernVM-FS (cvmfs-config-eessi-latest.noarch.rpm) as the new EESSI repository is included in the configurations of CVMFS.

Create (you'll have to run in a bash shell as root or run the editor using sudo) the file /etc/cvmfs/default.local. If you're experimenting on a workstation with no nearby cache server for CernVM-FS, then the following would be appropriate:

CVMFS_CLIENT_PROFILE="single"
CVMFS_HTTP_PROXY="DIRECT"
CVMFS_QUOTA_LIMIT=10000

or with bash commands:

sudo bash -c "echo 'CVMFS_CLIENT_PROFILE="single"'  > /etc/cvmfs/default.local"
sudo bash -c "echo 'CVMFS_HTTP_PROXY="DIRECT"'     >> /etc/cvmfs/default.local"
sudo bash -c "echo 'CVMFS_QUOTA_LIMIT=10000'       >> /etc/cvmfs/default.local"

Ensure everybody has read access to the file.

Run the setup of cvmfs:
```
sudo cvmfs_config setup
```
Enable and start the autofs service:
```
sudo systemctl enable autofs.service
sudo systemctl start autofs
```
Or restart the autofs service if it was already present so that the above change takes effect:
```
sudo systemctl restart autofs
```
You should now be able to go into the /cvmfs/software.eessi.io subdirectory even if it is not shown immediately if you do an ls in /cvmfs as it will only be mounted on access.

You can now make EESSI available in a shell with

source /cvmfs/software.eessi.io/versions/2023.06/init/bash

Useful links¶

EESSI web page
EESSI documentation
EESSI YouTube channel
MultiXscale Center of Excellence:
- Home page
- YouTube channel