diff --git a/docs/HowTos.md b/docs/HowTos.md index 06be64bcd79862cffc6808abf72d9c218ad5a4c7..a35b3a34aac7da6437f353f28cd299c2e1eb07fd 100644 --- a/docs/HowTos.md +++ b/docs/HowTos.md @@ -1,3 +1,4 @@ - [Event displays HowTo](eventdisplay/HowTo.md) - [Histogram servers HowTo](histservs/HowTo.md) +- [Online Container HowTo](online/container/HowTo.md) diff --git a/algo/containers/README b/docs/online/container/HowTo.md similarity index 74% rename from algo/containers/README rename to docs/online/container/HowTo.md index 60277c7e124844ddd6b60797e5c7c96f9a7c6b99..c4089c65bdaff1e7a86dd6cf072bc454de66f398 100644 --- a/algo/containers/README +++ b/docs/online/container/HowTo.md @@ -1,3 +1,7 @@ +# Online Container + +This document provides an overview over the containers currently used for CBM online operations, how to build them and test the reconstruction container. + ## Build container ### Login @@ -30,19 +34,26 @@ Building the online code and creating a new image, happens inside a container vi To build new cbm_online-images locally, you first have to create a new build-image: ``` cd <CbmRoot> -./algo/containers/cbm_online/make_build_image.sh <gitlab_user> <gitlab_password> +./algo/containers/cbm_online/make_build_image.sh <gitlab_user> <gitlab_password> <tag> ``` **This will store your password in plain text in the container. Make sure to delete after you're done.** +The image tag is optional. If no tag is provided, defaults to `<gitlab_user>-debug`. + Then run the new container, to build a new cbm_online-image: ``` docker run -it --rm cbm_online_builder ``` -This will push a new container image `cbm_online:<gitlab_user>-debug` to the CbmRoot registry. +This will push a new container image `cbm_online:<tag>` to the CbmRoot registry. + +Pull the new image first with: +``` +docker pull hub.cbm.gsi.de/computing/cbmroot/cbm_online:<tag> +``` You can use `test_run.sh` or `test_run_gpu.sh` scripts to test the image locally. -Make sure to pull the new image first with: `docker pull hub.cbm.gsi.de/computing/cbmroot/cbm_online:<gitlab_user>-debug` + ## Test on virgo @@ -63,4 +74,6 @@ MR `N`. Run the container on the virgo debug partition with GPUs: -```srun --constraint=mi50 -p debug apptainer exec cbm_online.sif cbmreco -p /lustre/cbm/online/params -i /lustre/cbm/online/data/2391_node8_0_0000.tsa -d hip0 -n1``` +``` +srun --constraint=mi50 -p debug apptainer exec cbm_online.sif cbmreco -p /lustre/cbm/online/params -i /lustre/cbm/online/data/2391_node8_0_0000.tsa -d hip0 -n1 +```