Singularity: Difference between revisions

From Research Computing Center Wiki
Jump to navigation Jump to search
(Created page with "== Using Singularity containers on Sapelo2 == The Sapelo2 cluster has the ability to run Singularity containers. [http://singularity.lbl.gov/ Singularity] containers are dock...")
 
Line 2: Line 2:


The Sapelo2 cluster has the ability to run Singularity containers. [http://singularity.lbl.gov/ Singularity] containers are docker like containers that are HPC friendly.
The Sapelo2 cluster has the ability to run Singularity containers. [http://singularity.lbl.gov/ Singularity] containers are docker like containers that are HPC friendly.
=== Loading Singularity ===
Singularity is installed on all compute nodes on Sapelo2. In order to access that executables you have to load the Singularity module.
<pre>
$ module load Singularity
$ singularity --help
USAGE: singularity [global options...] <command> [command options...] ...
GLOBAL OPTIONS:
    -d|--debug    Print debugging information
    -h|--help    Display usage summary
    -s|--silent  Only print errors
    -q|--quiet    Suppress all normal output
      --version  Show application version
    -v|--verbose  Increase verbosity +1
    -x|--sh-debug Print shell wrapper debugging information
GENERAL COMMANDS:
    help      Show additional help for a command or container                 
    selftest  Run some self tests for singularity install                     
CONTAINER USAGE COMMANDS:
    exec      Execute a command within container                             
    run        Launch a runscript within container                             
    shell      Run a Bourne shell within container                             
    test      Launch a testscript within container                           
CONTAINER MANAGEMENT COMMANDS:
    apps      List available apps within a container                         
    bootstrap  *Deprecated* use build instead                                 
    build      Build a new Singularity container                               
    check      Perform container lint checks                                   
    inspect    Display container's metadata                                   
    mount      Mount a Singularity container image                             
    pull      Pull a Singularity/Docker container to $PWD                     
COMMAND GROUPS:
    image      Container image command group                                   
    instance  Persistent instance command group                               
CONTAINER USAGE OPTIONS:
    see singularity help <command>
For any additional help or support visit the Singularity
website: http://singularity.lbl.gov/
</pre>

Revision as of 12:23, 22 December 2017

Using Singularity containers on Sapelo2

The Sapelo2 cluster has the ability to run Singularity containers. Singularity containers are docker like containers that are HPC friendly.


Loading Singularity

Singularity is installed on all compute nodes on Sapelo2. In order to access that executables you have to load the Singularity module.

$ module load Singularity
$ singularity --help
USAGE: singularity [global options...] <command> [command options...] ...

GLOBAL OPTIONS:
    -d|--debug    Print debugging information
    -h|--help     Display usage summary
    -s|--silent   Only print errors
    -q|--quiet    Suppress all normal output
       --version  Show application version
    -v|--verbose  Increase verbosity +1
    -x|--sh-debug Print shell wrapper debugging information

GENERAL COMMANDS:
    help       Show additional help for a command or container                  
    selftest   Run some self tests for singularity install                      

CONTAINER USAGE COMMANDS:
    exec       Execute a command within container                               
    run        Launch a runscript within container                              
    shell      Run a Bourne shell within container                              
    test       Launch a testscript within container                             

CONTAINER MANAGEMENT COMMANDS:
    apps       List available apps within a container                           
    bootstrap  *Deprecated* use build instead                                   
    build      Build a new Singularity container                                
    check      Perform container lint checks                                    
    inspect    Display container's metadata                                     
    mount      Mount a Singularity container image                              
    pull       Pull a Singularity/Docker container to $PWD                      

COMMAND GROUPS:
    image      Container image command group                                    
    instance   Persistent instance command group                                


CONTAINER USAGE OPTIONS:
    see singularity help <command>

For any additional help or support visit the Singularity
website: http://singularity.lbl.gov/