diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 1dc1bfc..bc55bc9 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -15,7 +15,7 @@ jobs: - name: set up Python uses: actions/setup-python@v1 with: - python-version: 3.9 + python-version: '3.10' - name: install mkdocs run: | diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 816e57b..b6d3ec2 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,7 @@ jobs: - name: set up Python uses: actions/setup-python@v1 with: - python-version: 3.9 + python-version: '3.10' - name: Codespell action uses: codespell-project/actions-codespell@master diff --git a/docs/access/alternatives.md b/docs/access/alternatives.md index ca3d23d..e03bcc3 100644 --- a/docs/access/alternatives.md +++ b/docs/access/alternatives.md @@ -1,5 +1,12 @@ # Alternative ways to access CernVM-FS repositories +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + While a [native installation of CernVM-FS on the client system](client.md), along with a [proxy server](proxy.md) and/or [Stratum 1 replica server](stratum1.md) for large-scale production setups, is recommended, there are other alternatives available for getting access to CernVM-FS repositories. diff --git a/docs/access/client.md b/docs/access/client.md index a1f4ef4..7faf2ca 100644 --- a/docs/access/client.md +++ b/docs/access/client.md @@ -1,5 +1,12 @@ # CernVM-FS client system +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + The recommended way to gain access to CernVM-FS repositories is to set up a *system-wide native installation* of CernVM-FS on the [client system(s)](../appendix/terminology.md#client), which comes down to: diff --git a/docs/access/index.md b/docs/access/index.md index 33d2896..ac6e650 100644 --- a/docs/access/index.md +++ b/docs/access/index.md @@ -1,5 +1,12 @@ # Accessing CernVM-FS repositories +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + - [Setting up a CernVM-FS client system](client.md) - [Setting up a proxy server](proxy.md) - [Setting up a Stratum 1 replica server](stratum1.md) diff --git a/docs/access/proxy.md b/docs/access/proxy.md index c1a11b9..20bc7db 100644 --- a/docs/access/proxy.md +++ b/docs/access/proxy.md @@ -1,5 +1,12 @@ # Squid proxy server +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + As a first step towards a production-ready CernVM-FS setup we can install a [Squid forward proxy server](http://www.squid-cache.org), which is strongly recommended in the context of HPC systems. diff --git a/docs/access/stratum1.md b/docs/access/stratum1.md index e19da33..9f8905c 100644 --- a/docs/access/stratum1.md +++ b/docs/access/stratum1.md @@ -1,5 +1,12 @@ # Private Stratum 1 replica server +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + In this section of the tutorial, we will set up a [Stratum 1 replica server]( ../appendix/terminology.md#stratum1), which is the next step towards a production-ready CernVM-FS setup. diff --git a/docs/appendix/terminology.md b/docs/appendix/terminology.md index e0212a2..0cf17a9 100644 --- a/docs/appendix/terminology.md +++ b/docs/appendix/terminology.md @@ -1,5 +1,12 @@ # CernVM-FS Terminology +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + An overview of terms used in the context of CernVM-FS, in alphabetical order. --- diff --git a/docs/configuration_hpc.md b/docs/configuration_hpc.md index 7f41f15..26fa628 100644 --- a/docs/configuration_hpc.md +++ b/docs/configuration_hpc.md @@ -1,5 +1,12 @@ # Configuring CernVM-FS on HPC infrastructure +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + In the [previous section](access/index.md) we have outlined how to set up a robust CernVM-FS infrastructure, by having a private Stratum 1 replica server and/or dedicated Squid proxy servers. While this approach will work for many HPC systems, some may have slightly more esoteric setups that require specific solutions, which we will discuss in this section. diff --git a/docs/containers.md b/docs/containers.md index 70e5344..ddcd00f 100644 --- a/docs/containers.md +++ b/docs/containers.md @@ -1,5 +1,12 @@ # Containers and CernVM-FS +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + CernVM-FS can also be used to distribute container images, providing many of the same benefits that come with any CernVM-FS installation. Especially the on-demand download of accessed files means that containers start nearly instantly, and are more efficient for large images when only a fraction of the files are read, which is typically the case. Any CernVM-FS repository can be used to distribute container images (although often, dedicated repositories are used, like [`/cvmfs/unpacked.cern.ch`](cvmfs/flagship-repositories.md#unpacked-containers)). diff --git a/docs/creating-repo.md b/docs/creating-repo.md index 24cbd78..0e3c399 100644 --- a/docs/creating-repo.md +++ b/docs/creating-repo.md @@ -1,5 +1,12 @@ # Creating a CernVM-FS repository +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + Although creating a new CernVM-FS repository and making it available to the world is not in scope for this tutorial, we do want to give a (very) brief overview of what that entails. diff --git a/docs/cvmfs/flagship-repositories.md b/docs/cvmfs/flagship-repositories.md index 8436f9e..b8aacc2 100644 --- a/docs/cvmfs/flagship-repositories.md +++ b/docs/cvmfs/flagship-repositories.md @@ -1,5 +1,12 @@ # Flagship CernVM-FS repositories +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + Here we list a couple of flagship CernVM-FS repositories, all of which are **publicly available**. ## LHC experiments diff --git a/docs/cvmfs/index.md b/docs/cvmfs/index.md index 460091a..6b6c4fa 100644 --- a/docs/cvmfs/index.md +++ b/docs/cvmfs/index.md @@ -1,5 +1,12 @@ # Introduction to CernVM-FS +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). +
CernVM-FS logo
diff --git a/docs/cvmfs/technical-details.md b/docs/cvmfs/technical-details.md index c849d98..e9dd067 100644 --- a/docs/cvmfs/technical-details.md +++ b/docs/cvmfs/technical-details.md @@ -1,5 +1,12 @@ # Technical details of CernVM-FS +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + CernVM-FS is implemented as a *POSIX read-only [filesystem in user space (FUSE)](https://en.wikipedia.org/wiki/Filesystem_in_Userspace)* with [repositories](../appendix/terminology.md#repository) of files that are served via outgoing [HTTP](https://en.wikipedia.org/wiki/HTTP) connections only, thus avoiding problems with firewalls. diff --git a/docs/cvmfs/what-is-cvmfs.md b/docs/cvmfs/what-is-cvmfs.md index ef13af8..4ac738f 100644 --- a/docs/cvmfs/what-is-cvmfs.md +++ b/docs/cvmfs/what-is-cvmfs.md @@ -1,5 +1,12 @@ # What is CernVM-FS? +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). +
CernVM-FS logo
diff --git a/docs/eessi/high-level-design.md b/docs/eessi/high-level-design.md index 61e9a6b..d2743f9 100644 --- a/docs/eessi/high-level-design.md +++ b/docs/eessi/high-level-design.md @@ -1,5 +1,12 @@ # High-level design of EESSI +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + The design of EESSI is very similar to that of the [Compute Canada software stack](inspiration.md) it is inspired by, and is aligned with the [motivation and goals](motivation-goals.md) of the project. diff --git a/docs/eessi/index.md b/docs/eessi/index.md index 84e539c..2506c17 100644 --- a/docs/eessi/index.md +++ b/docs/eessi/index.md @@ -1,5 +1,12 @@ # EESSI +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + ## European Environment for Scientific Software Installations
diff --git a/docs/eessi/inspiration.md b/docs/eessi/inspiration.md index 63d9b2a..06de670 100644 --- a/docs/eessi/inspiration.md +++ b/docs/eessi/inspiration.md @@ -1,5 +1,12 @@ # Inspiration for EESSI +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + The EESSI concept is heavily inspired by software stack provided by the [Digital Research Alliance of Canada](https://alliancecan.ca/en/about/alliance) (a.k.a. The Alliance, formerly known as *Compute Canada*), which is a shared software stack used on all [national host sites for Advanced Research Computing in Canada]( diff --git a/docs/eessi/motivation-goals.md b/docs/eessi/motivation-goals.md index 253babc..d62bda8 100644 --- a/docs/eessi/motivation-goals.md +++ b/docs/eessi/motivation-goals.md @@ -1,5 +1,12 @@ # Motivation & Goals of EESSI +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + ## Motivation EESSI is motivated by the observation that the landscape of computational science is changing in various diff --git a/docs/eessi/support.md b/docs/eessi/support.md index b88ad5e..4a0a9e9 100644 --- a/docs/eessi/support.md +++ b/docs/eessi/support.md @@ -1,5 +1,12 @@ # Getting support for EESSI +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). +
MultiXscale logo diff --git a/docs/eessi/using-eessi.md b/docs/eessi/using-eessi.md index 557d14e..fd9fb46 100644 --- a/docs/eessi/using-eessi.md +++ b/docs/eessi/using-eessi.md @@ -1,5 +1,12 @@ # Using EESSI +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + Using the software installations provided by the EESSI CernVM-FS repository `software.eessi.io` is fairly straightforward. diff --git a/docs/eessi/what-is-eessi.md b/docs/eessi/what-is-eessi.md index 5135796..1317034 100644 --- a/docs/eessi/what-is-eessi.md +++ b/docs/eessi/what-is-eessi.md @@ -1,5 +1,12 @@ # What is EESSI? +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + The [European Environment for Scientific Software Installations](https://www.eessi.io) (EESSI, pronounced as "easy") is a collaboration between different European partners in the HPC (High Performance Computing) community. diff --git a/docs/index.md b/docs/index.md index 44a528e..6559fd4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,12 @@ # Best Practices for CernVM-FS in HPC +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). +

CernVM-FS logo

diff --git a/docs/performance.md b/docs/performance.md index 6bd9bab..9777c98 100644 --- a/docs/performance.md +++ b/docs/performance.md @@ -1,5 +1,12 @@ # Performance aspects of CernVM-FS +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + One aspect we can not ignore in the context of software on HPC infrastructure is *performance* (the P in HPC). ## Start-up performance diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index eeac80a..6a7c324 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,5 +1,12 @@ # Troubleshooting for CernVM-FS +!!! tip "Updated version available!" + + This tutorial was held in Dec 2023, some aspects of it are now outdated. + + An updated version of this tutorial was presented in May 2025, + see [here](https://eessi.io/docs/training-events/2025/tutorial-best-practices-cvmfs-hpc). + When you experience problems with getting access to a CernVM-FS repository, it can be tricky to figure out what the actual underlying cause is, given the complexity of a typical CernVM-FS setup.