tubbz-alt / smurf2mce-docker

Docker image with smurf2mce for the SMuRF project

Docker image with smurf2mce for the SMuRF project

Description

This docker image, named smurf2mce contains smurf2mce, firmware files (mcs and pyrogue tarball) and default configuration files for stable firmware versions.

It is based on the smurf2mce-base docker image.

Source code

The firmware files are checkout from the SLAC's github repositories https://github.com/slaclab/cryo-det.

The configuration files are checkout from the SMuRF's configuration repository https://github.com/slaclab/smurf_cfg.git.

If needed files are not available on any of the github repositories, then then are added to this repository under the local_files directory.

Tag convention

The tags used on this repository have the following 5-digit format:

R<A>.<B>.<C>.<D>.<E>

Where:

• A: is incremented when a new smurf2mce-base image version is used,
• B: is incremented when a new firmware MCS files is used,
• C: is incremented when a new firmware pyrogue tarball file is used,
• D: is incremented when a new configuration file is used,
• E: is incremented when defaults server arguments are changed.

Notes:

• All digits start at zero, expect for A which starts at one,
• Whenever a digit in incremented, all the rightmost digits are reset to zero.

For example, assume that version R3.0.0.1.0 correspond to a certain release version; if the smurf2mce-base image version is upgraded, then the following release version will be R4.0.0.0.0. If later, the MCS file is changed, then the following release version will be R4.1.0.0.0. If later the pyrogue tarball file is change, the next release version will be R4.1.1.0.0. Updating the configuration file will generate a release version R4.1.1.1.0. Finally, modifying the server arguments (like for example adding/removing --disable-bayX) will generated a release version R4.1.1.1.1. And so on.

The file RELEASES.md contains a list of released version with a description for each one. Similar information can be found in the repository's releases page.

Building the image

When a tag is pushed to this github repository, a new Docker image is automatically built and push to its Dockerhub repository using travis.

The resulting docker image is tagged with the same git tag string (as returned by git describe --tags --always).

How to get the container

To get the docker image, first you will need to install the docker engine in you host OS. Then you can pull a copy by running:

docker pull tidair/smurf2mce:<TAG>

Where TAG represents the specific tagged version you want to use.

Running the container

Each docker image defined which it's entry point. Usually the entry point calls the start_server.sh (which comes within the smurf2mce-base image) script with some pre-defined arguments. You can however, overwrite any of the arguments and/or adding new one by passing them at the end of the docker run command.

You start the container with a command like this one:

docker run -ti --rm \
    -v <local_data_dir>:/data \
    tidair/smurf2mce:<TAG> \
    <server_arguments>

Where:

• local_data_dir: is a local directory in the host CPU which contains the directories smurf_data where the data is going to be written to, and smurf2mce_config with the smurf2mce configuration files,
• TAG: is the tagged version of the container your want to run,
• server_arguments: additional and/or redefined server arguments.