Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/access/alternatives.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/access/client.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
7 changes: 7 additions & 0 deletions docs/access/index.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
7 changes: 7 additions & 0 deletions docs/access/proxy.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/access/stratum1.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/appendix/terminology.md
Original file line number Diff line number Diff line change
@@ -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.

---
Expand Down
7 changes: 7 additions & 0 deletions docs/configuration_hpc.md
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
7 changes: 7 additions & 0 deletions docs/containers.md
Original file line number Diff line number Diff line change
@@ -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)).
Expand Down
7 changes: 7 additions & 0 deletions docs/creating-repo.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
7 changes: 7 additions & 0 deletions docs/cvmfs/flagship-repositories.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/cvmfs/index.md
Original file line number Diff line number Diff line change
@@ -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).

<div align="center">
<img src="../img/logos/CernVM-FS_logo_with_name.png" alt="CernVM-FS logo" width="50%"/></br>
</div>
Expand Down
7 changes: 7 additions & 0 deletions docs/cvmfs/technical-details.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/cvmfs/what-is-cvmfs.md
Original file line number Diff line number Diff line change
@@ -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).

<div align="center">
<img src="../../img/logos/CernVM-FS_logo_with_name.png" alt="CernVM-FS logo" width="50%"/></br>
</div>
Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/high-level-design.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/index.md
Original file line number Diff line number Diff line change
@@ -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

<div align="center">
Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/inspiration.md
Original file line number Diff line number Diff line change
@@ -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](
Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/motivation-goals.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/support.md
Original file line number Diff line number Diff line change
@@ -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).

<div align="center">
<a href="https://www.multixscale.eu">
<img src="../../img/logos/multixscale_logo.png" alt="MultiXscale logo" width="50%"/>
Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/using-eessi.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
7 changes: 7 additions & 0 deletions docs/eessi/what-is-eessi.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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).

<p align="center">
<img src="img/cvmfs_hpc.png" alt="CernVM-FS logo" width="40%"/></br>
</p>
Expand Down
7 changes: 7 additions & 0 deletions docs/performance.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down