Belle II Docker images

This repository contains the scripts to automatically create via pipeline the Docker images used to build and run the Belle II software.

The pipeline creates an image for each of the supported OS (see systems.csv for the list of supported OS). The pipeline is automatically triggered by the buildbot via a Git tag each time the file b2install-prepare in the main branch of the tools repository is updated.

The images are created using kaniko. It is also possible to create the images locally with Docker by using the create_images.sh script.

The images are pushed to both the GitLab Container Registry and Docker Hub. Please refer to the GitLab Container Registry or Docker Hub documentation on how to use the images.

Note that these images do NOT include any of the Belle II software. They are intended to be used to build the Belle II software or to run it with a bind mount of the CernVM-FS at /cvmfs.

Naming convention

Images are named using the following convention:

belle2-base-<OS>:<YYYY-MM-DD>

where <OS> is the short name of the supported operating system (as in the first column of systems.csv) and <YYYY-MM-DD> is the date on which the image was created.

Note that the latest tag is also provided, which automatically points to the most recent image available for the given OS. It is generally recommended to use the latest tag.

Downloading the images

The images can be downloaded and stored locally using Docker itself, skopeo or Apptainer. To download the images from Docker Hub:

• for Docker:
  • with docker as a tar archive: docker pull belle2/belle2-base-<OS>:latest && docker save -o belle2-base-<OS>-latest.tar belle2/belle2-base-<OS>:latest
  • with skopeo as a tar archive: skopeo copy docker://belle2/belle2-base-<OS>:latest docker-archive:belle2-base-<OS>-latest.tar
• for Apptainer:
  • with apptainer as a SIF file: apptainer build belle2-base-<OS>-latest.sif docker://belle2/belle2-base-<OS>:latest
  • with apptainer as a sandbox: apptainer build --fix-perms --sandbox belle2-base-<OS>-latest docker://belle2/belle2-base-<OS>:latest

See also the download-and-inspect-images stage of the pipeline.

Running the Belle II software with Apptainer

The Belle II software can be run with Apptainer using the images built from this repository and mounting the /cvfms volume:

apptainer exec --bind /cvmfs /path/to/belle2-base-<OS>-latest.sif /cvmfs/belle.cern.ch/tools/b2execute -x "basf2 --info" release-XX-YY-ZZ