Difference between revisions of "GlueX and Containers"

From GlueXWiki
Jump to: navigation, search
(Categories of Containers)
(Creating a Container for the OSG: dd historical note)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Categories of Containers ==
+
== Terms to Describe Containers ==
  
The container world is not monolithic, so we have to define some terms. The container type, installed software level, and /group/halld binding style (described below) are independent degrees of freedom when categorizing containers.
+
The container world is not monolithic, so we have to define some terms.  
  
=== Container Types ===
+
=== Categories of Containers ===
 +
 
 +
The container type, installed software level, and /group/halld binding style (described below) are independent degrees of freedom when categorizing containers.
 +
 
 +
==== Container Types ====
  
 
There are three types: Docker, Singularity, and [https://docs.nersc.gov/development/shifter/ Shifter]
 
There are three types: Docker, Singularity, and [https://docs.nersc.gov/development/shifter/ Shifter]
Line 9: Line 13:
 
For Singularity there are two sub-types: Sandbox and Singularity Image Format (SIF)
 
For Singularity there are two sub-types: Sandbox and Singularity Image Format (SIF)
  
=== Installed Software Levels ===
+
==== Installed Software Levels ====
  
 
There are three levels: raw, gluex-prereqs, and gluex-software
 
There are three levels: raw, gluex-prereqs, and gluex-software
Line 17: Line 21:
 
* '''gluex-with-software'''. Starting from gluex-prereqs, the GlueX software stack itself is built into the container.
 
* '''gluex-with-software'''. Starting from gluex-prereqs, the GlueX software stack itself is built into the container.
  
=== Group Binding Styles ===
+
==== Group Binding Styles ====
  
 
There are two styles for binding /group/halld: system-binds-group (SBG) and user-binds-group (UBG)
 
There are two styles for binding /group/halld: system-binds-group (SBG) and user-binds-group (UBG)
  
== Distribution Systems ==
+
=== Distribution Systems ===
  
 
There are three methods we use for distributing containers: DockerHub, Web, CVMFS.
 
There are three methods we use for distributing containers: DockerHub, Web, CVMFS.
  
== Container Use at Various Sites ==
+
=== Container Use at Various Sites ===
  
 
{| border
 
{| border
Line 35: Line 39:
 
| OSG || Singularity(Sandbox)/gluex-prereqs-only/SBG || CVMFS
 
| OSG || Singularity(Sandbox)/gluex-prereqs-only/SBG || CVMFS
 
|-
 
|-
| PSG || Singularity(Sandbox)/gluex-prereqs-only/SBG || CVMFS
+
| PSC || Singularity(Sandbox)/gluex-prereqs-only/SBG || CVMFS
 
|-
 
|-
 
| Big Red (IU) || Singularity(Sandbox)/gluex-prereqs-only/SBG || CVMFS[?]
 
| Big Red (IU) || Singularity(Sandbox)/gluex-prereqs-only/SBG || CVMFS[?]
Line 41: Line 45:
  
 
At this writing there is no standard container-use practice at JLab.
 
At this writing there is no standard container-use practice at JLab.
 +
 +
== Creating a Container for the OSG ==
 +
 +
Let us assume that we want to make version 2 of the production container.
 +
 +
Steps 1-6 create the new Docker container on DockerHub.
 +
 +
1. clone the repo with the Dockerfile
 +
 +
git clone https://github.com/jeffersonlab/gluex_docker_prod
 +
 +
2. modify the Dockerfile
 +
 +
cd gluex_docker_prod
 +
vi Dockerfile
 +
 +
3. build the new Docker container
 +
 +
docker build -t gluex_prod:v2 .
 +
 +
4. login into DockerHub
 +
 +
docker login -u my_dockerhub_username
 +
 +
5. tag the new local container with a name on DockerHub
 +
 +
docker tag gluex_prod:v2 jeffersonlab/gluex_prod:v2
 +
 +
6. push the container to DockerHub
 +
 +
docker push jeffersonlab/gluex_prod:v2
 +
 +
Steps 7-9 record the changes to the Dockerfile back at the GitHub repository.
 +
 +
7. commit the new Dockerfile to your local git repository
 +
 +
git commit -a -m "this is version 2"
 +
 +
8. push to GitHub
 +
 +
git push
 +
 +
9. create a release on the GitHub site tagging this version as "v2" for documentation purposes
 +
 +
Steps 10-16 publish the new container as a Singularity container on CVMFS.
 +
 +
10. fork the OSG Singularity container list repository on GitHub () to your personal GitHub account. The OSG repository is opensciencegrid/cvms-singularity-sync.
 +
 +
11. clone your fork
 +
 +
cd /dir/to/contain/git/repo
 +
git clone https://github.com/my_github_username/cvmfs-singularity-sync
 +
 +
12. edit the list of docker containers adding a line with "jeffersonlab/gluex_prod:v2"
 +
 +
cd cvmfs-singularity-sync
 +
vi docker_images.txt
 +
 +
13. commit the change
 +
 +
git commit -a "adding new container, gluex_prod:v2"
 +
 +
14. push the change back to your fork
 +
 +
git push
 +
 +
15. create a pull request to the opensciencegrid parent repository from the mygithubusername/cvmfs-singularity-sync page on GitHub.
 +
 +
16. After the OSG folks merge the pull request, the new container should appear on CVMFS as /cvmfs/singularity.opensciencegrid.org/jeffersonlab/gluex_prod:v2.
 +
 +
=== Historical Note ===
 +
 +
This procedure is not the one employed prior to March 2022. Before that Docker supported automatic builds from Dockerfiles hosted at GitHub for free accounts and that feature was used.

Latest revision as of 00:09, 30 April 2022

Terms to Describe Containers

The container world is not monolithic, so we have to define some terms.

Categories of Containers

The container type, installed software level, and /group/halld binding style (described below) are independent degrees of freedom when categorizing containers.

Container Types

There are three types: Docker, Singularity, and Shifter

For Singularity there are two sub-types: Sandbox and Singularity Image Format (SIF)

Installed Software Levels

There are three levels: raw, gluex-prereqs, and gluex-software

  • raw. This a vanilla OS direct (or nearly so) from the distributer, with only the basic, default set of packages.
  • gluex-prereqs-only. Starting from raw, packages needed to build and run the GlueX software stack are added. The GlueX software itself is not included and needs to be provided external to the container, usually with a "bind" directive.
  • gluex-with-software. Starting from gluex-prereqs, the GlueX software stack itself is built into the container.

Group Binding Styles

There are two styles for binding /group/halld: system-binds-group (SBG) and user-binds-group (UBG)

Distribution Systems

There are three methods we use for distributing containers: DockerHub, Web, CVMFS.

Container Use at Various Sites

Site Category (type/level/style) Distribution System
NERSC Shifter/gluex-prereqs-only/SBG DockerHub
OSG Singularity(Sandbox)/gluex-prereqs-only/SBG CVMFS
PSC Singularity(Sandbox)/gluex-prereqs-only/SBG CVMFS
Big Red (IU) Singularity(Sandbox)/gluex-prereqs-only/SBG CVMFS[?]

At this writing there is no standard container-use practice at JLab.

Creating a Container for the OSG

Let us assume that we want to make version 2 of the production container.

Steps 1-6 create the new Docker container on DockerHub.

1. clone the repo with the Dockerfile

git clone https://github.com/jeffersonlab/gluex_docker_prod

2. modify the Dockerfile

cd gluex_docker_prod
vi Dockerfile

3. build the new Docker container

docker build -t gluex_prod:v2 .

4. login into DockerHub

docker login -u my_dockerhub_username

5. tag the new local container with a name on DockerHub

docker tag gluex_prod:v2 jeffersonlab/gluex_prod:v2

6. push the container to DockerHub

docker push jeffersonlab/gluex_prod:v2

Steps 7-9 record the changes to the Dockerfile back at the GitHub repository.

7. commit the new Dockerfile to your local git repository

git commit -a -m "this is version 2"

8. push to GitHub

git push

9. create a release on the GitHub site tagging this version as "v2" for documentation purposes

Steps 10-16 publish the new container as a Singularity container on CVMFS.

10. fork the OSG Singularity container list repository on GitHub () to your personal GitHub account. The OSG repository is opensciencegrid/cvms-singularity-sync.

11. clone your fork

cd /dir/to/contain/git/repo
git clone https://github.com/my_github_username/cvmfs-singularity-sync

12. edit the list of docker containers adding a line with "jeffersonlab/gluex_prod:v2"

cd cvmfs-singularity-sync
vi docker_images.txt

13. commit the change

git commit -a "adding new container, gluex_prod:v2"

14. push the change back to your fork

git push

15. create a pull request to the opensciencegrid parent repository from the mygithubusername/cvmfs-singularity-sync page on GitHub.

16. After the OSG folks merge the pull request, the new container should appear on CVMFS as /cvmfs/singularity.opensciencegrid.org/jeffersonlab/gluex_prod:v2.

Historical Note

This procedure is not the one employed prior to March 2022. Before that Docker supported automatic builds from Dockerfiles hosted at GitHub for free accounts and that feature was used.