blob: 582480f82b64e0ed1413529df9a0b9b2f444b243 [file] [log] [blame]
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001Singularity is a container platform based on the principle of mobility of
2compute, and it is designed for use within HPC clusters. For more info see
3singularity.lbl.gov.
4
5To test whether the software functions correctly, you can use `singularity
6selftest`. This is what you would expect to see:
7
8~# singularity selftest
9 + sh -c test -f /etc/singularity/singularity.conf (retval=0) OK
10 + test -u /usr/libexec/singularity/bin/action-suid (retval=0) OK
11 + test -u /usr/libexec/singularity/bin/create-suid (retval=0) OK
12 + test -u /usr/libexec/singularity/bin/expand-suid (retval=0) OK
13 + test -u /usr/libexec/singularity/bin/export-suid (retval=0) OK
14 + test -u /usr/libexec/singularity/bin/import-suid (retval=0) OK
15 + test -u /usr/libexec/singularity/bin/mount-suid (retval=0) OK
16
17You can also pull a container from Docker Hub to prove full functionality
18(Test was performed on a Raspberry Pi 3, hence the arm32v7 part of the Docker
19link. Make sure you pull an image which is compatible with your hardware.)
20For instance:
21
22~# singularity pull docker://arm32v7/debian:latest
23Initializing Singularity image subsystem
24Opening image file: debian-latest.img
25Creating 200MiB image
26Binding image to loop
27Creating file system within image
28Image is done: debian-latest.img
29Docker image path: index.docker.io/arm32v7/debian:latest
30Cache folder set to /home/root/.singularity/docker
31[1/1] |===================================| 100.0%
32Importing: base Singularity environment
33Importing: /home/root/.singularity/docker/sha256:ed4f1f0d0a0457e7f76ffb25a8d6a193007709dd312b7647cb44fc6979ec4a53.tar.gz
34Importing: /home/root/.singularity/metadata/sha256:89997b2c16b29c5a3a316e314172ef21b36f67cc3200b1c4d95927f716dbee83.tar.gz
35Done. Container is at: debian-latest.img
36~# singularity shell debian-latest.img
37Singularity: Invoking an interactive shell within container...
38
39Singularity debian-latest.img:~> echo "Hello from within the container!"
40Hello from within the container!
41Singularity debian-latest.img:~> ls /
42bin dev home lost+found mnt proc run singularity sys usr
43boot etc lib media opt root sbin srv tmp var
44Singularity debian-latest.img:~> exit
45exit
46~#