1singularity(1) singularity(1)
2
6 singularity-instance-start - Start a named instance of the given
7 container image
8
12 singularity instance start [start options...] <container path>
13 <instance name> [startscript args...]
14
18 The instance start command allows you to create a new named instance
19 from an
20 existing container image that will begin running in the background.
21 If a
22 startscript is defined in the container metadata the commands in that
23 script
24 will be executed with the instance start command as well. You can
25 optionally
26 pass arguments to startscript
27 singularity instance start accepts the following container formats
30 *.sif Singularity Image Format (SIF). Native to
33 Singularity 3.0+
34 *.sqsh SquashFS format. Native to Singularity 2.4+
37 *.img ext3 format. Native to Singularity versions < 2.4.
40 directory/ sandbox format. Directory containing a valid root
43 file
44 system and optionally Singularity meta-data.
45 instance://* A local running instance of a container. (See the
48 instance
49 command group.)
50 library://* A container hosted on a Library (default
53 ⟨https://cloud.sylabs.io/library)⟩
55 docker://* A container hosted on Docker Hub
58 shub://* A container hosted on Singularity Hub
61
65 --add-caps=""
66 a comma separated capability list to add
67 --allow-setuid[=false]
70 allow setuid binaries in container (root only)
71 --apply-cgroups=""
74 apply cgroups from file for container processes (root only)
75 -B, --bind=[]
78 a user-bind path specification. spec has the format
79 src[:dest[:opts]], where src and dest are outside and inside paths. If
80 dest is not given, it is set equal to src. Mount options ('opts') may
81 be specified as 'ro' (read-only) or 'rw' (read/write, which is the
82 default). Multiple bind paths can be given by a comma separated list.
83 --boot[=false]
86 execute /sbin/init to boot container (root only)
87 -e, --cleanenv[=false]
90 clean environment before running container
91 -c, --contain[=false]
94 use minimal /dev and empty other directories (e.g. /tmp and $HOME)
95 instead of sharing filesystems from your host
96 -C, --containall[=false]
99 contain not only file systems, but also PID, IPC, and environment
100 --dns=""
103 list of DNS server separated by commas to add in resolv.conf
104 --docker-login[=false]
107 login to a Docker Repository interactively
108 --drop-caps=""
111 a comma separated capability list to drop
112 -h, --help[=false]
115 help for start
116 -H, --home="/builddir"
119 a home directory specification. spec can either be a src path or
120 src:dest pair. src is the source path of the home directory outside
121 the container and dest overrides the home directory within the
122 container.
123 --hostname=""
126 set container hostname
127 --keep-privs[=false]
130 let root user keep privileges in container (root only)
131 -n, --net[=false]
134 run container in a new network namespace (sets up a bridge network
135 interface by default)
136 --network="bridge"
139 specify desired network type separated by commas, each network will
140 bring up a dedicated interface inside container
141 --network-args=[]
144 specify network arguments to pass to CNI plugins
145 --no-home[=false]
148 do NOT mount users home directory if home is not the current
149 working directory
150 --no-privs[=false]
153 drop all privileges from root user in container
154 --nv[=false]
157 enable experimental Nvidia support
158 -o, --overlay=[]
161 use an overlayFS image for persistent data storage or as read-only
162 layer of container
163 -S, --scratch=[]
166 include a scratch directory within the container that is linked to
167 a temporary dir (use -W to force location)
168 --security=[]
171 enable security features (SELinux, Apparmor, Seccomp)
172 -u, --userns[=false]
175 run container in a new user namespace, allowing Singularity to run
176 completely unprivileged on recent kernels. This disables some features
177 of Singularity, for example it only works with sandbox images.
178 --uts[=false]
181 run container in a new UTS namespace
182 -W, --workdir=""
185 working directory to be used for /tmp, /var/tmp and $HOME (if
186 -c/--contain was also used)
187 -w, --writable[=false]
190 by default all Singularity containers are available as read only.
191 This option makes the file system accessible as read/write.
192 --writable-tmpfs[=false]
195 makes the file system accessible as read-write with non persistent
196 data (with overlay support only)
197
201 $ singularity instance start /tmp/my-sql.sif mysql
202 $ singularity shell instance://mysql
204 Singularity my-sql.sif> pwd
205 /home/mibauer/mysql
206 Singularity my-sql.sif> ps
207 PID TTY TIME CMD
208 1 pts/0 00:00:00 sinit
209 2 pts/0 00:00:00 bash
210 3 pts/0 00:00:00 ps
211 Singularity my-sql.sif>
212 $ singularity instance stop /tmp/my-sql.sif mysql
214 Stopping /tmp/my-sql.sif mysql
215
220 singularity-instance(1)
221
225 29-May-2019 Auto generated by spf13/cobra
226Auto generated by spf13/cobra May 2019 singularity(1)