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 oras://* A container hosted on a supporting OCI registry
64
68 --add-caps=""
69 a comma separated capability list to add
70 --allow-setuid[=false]
73 allow setuid binaries in container (root only)
74 --apply-cgroups=""
77 apply cgroups from file for container processes (root only)
78 -B, --bind=[]
81 a user-bind path specification. spec has the format
82 src[:dest[:opts]], where src and dest are outside and inside paths. If
83 dest is not given, it is set equal to src. Mount options ('opts') may
84 be specified as 'ro' (read-only) or 'rw' (read/write, which is the
85 default). Multiple bind paths can be given by a comma separated list.
86 --boot[=false]
89 execute /sbin/init to boot container (root only)
90 -e, --cleanenv[=false]
93 clean environment before running container
94 -c, --contain[=false]
97 use minimal /dev and empty other directories (e.g. /tmp and $HOME)
98 instead of sharing filesystems from your host
99 -C, --containall[=false]
102 contain not only file systems, but also PID, IPC, and environment
103 --disable-cache[=false]
106 dont use cache, and dont create cache
107 --dns=""
110 list of DNS server separated by commas to add in resolv.conf
111 --docker-login[=false]
114 login to a Docker Repository interactively
115 --drop-caps=""
118 a comma separated capability list to drop
119 -f, --fakeroot[=false]
122 run container in new user namespace as uid 0
123 -h, --help[=false]
126 help for start
127 -H, --home="/builddir"
130 a home directory specification. spec can either be a src path or
131 src:dest pair. src is the source path of the home directory outside
132 the container and dest overrides the home directory within the
133 container.
134 --hostname=""
137 set container hostname
138 -i, --ipc[=false]
141 run container in a new IPC namespace
142 --keep-privs[=false]
145 let root user keep privileges in container (root only)
146 -n, --net[=false]
149 run container in a new network namespace (sets up a bridge network
150 interface by default)
151 --network="bridge"
154 specify desired network type separated by commas, each network will
155 bring up a dedicated interface inside container
156 --network-args=[]
159 specify network arguments to pass to CNI plugins
160 --no-home[=false]
163 do NOT mount users home directory if home is not the current
164 working directory
165 --no-init[=false]
168 do NOT start shim process with --pid
169 --no-nv[=false]
172 --no-privs[=false]
175 drop all privileges from root user in container)
176 --nohttps[=false]
179 do NOT use HTTPS with the docker:// transport (useful for local
180 docker registries without a certificate)
181 --nv[=false]
184 enable experimental Nvidia support
185 -o, --overlay=[]
188 use an overlayFS image for persistent data storage or as read-only
189 layer of container
190 --passphrase[=false]
193 prompt for an encryption passphrase
194 --pem-path=""
197 enter an path to a PEM formated RSA key for an encrypted container
198 -p, --pid[=false]
201 run container in a new PID namespace
202 --pid-file=""
205 write instance PID to the file with the given name
206 --rocm[=false]
209 enable experimental Rocm support
210 -S, --scratch=[]
213 include a scratch directory within the container that is linked to
214 a temporary dir (use -W to force location)
215 --security=[]
218 enable security features (SELinux, Apparmor, Seccomp)
219 -u, --userns[=false]
222 run container in a new user namespace, allowing Singularity to run
223 completely unprivileged on recent kernels. This disables some features
224 of Singularity, for example it only works with sandbox images.
225 --uts[=false]
228 run container in a new UTS namespace
229 -W, --workdir=""
232 working directory to be used for /tmp, /var/tmp and $HOME (if
233 -c/--contain was also used)
234 -w, --writable[=false]
237 by default all Singularity containers are available as read only.
238 This option makes the file system accessible as read/write.
239 --writable-tmpfs[=false]
242 makes the file system accessible as read-write with non persistent
243 data (with overlay support only)
244
248 $ singularity instance start /tmp/my-sql.sif mysql
249 $ singularity shell instance://mysql
251 Singularity my-sql.sif> pwd
252 /home/mibauer/mysql
253 Singularity my-sql.sif> ps
254 PID TTY TIME CMD
255 1 pts/0 00:00:00 sinit
256 2 pts/0 00:00:00 bash
257 3 pts/0 00:00:00 ps
258 Singularity my-sql.sif>
259 $ singularity instance stop /tmp/my-sql.sif mysql
261 Stopping /tmp/my-sql.sif mysql
262
267 singularity-instance(1)
268
272 18-Feb-2020 Auto generated by spf13/cobra
273Auto generated by spf13/cobra Feb 2020 singularity(1)