1singularity(1) singularity(1)
2
6 singularity-instance-start - Start a named instance of the given con‐
7 tainer image
8
12 singularity instance start [start options...] [startscript args...]
13
17 The instance start command allows you to create a new named instance
18 from an
19 existing container image that will begin running in the background.
20 If a
21 startscript is defined in the container metadata the commands in that
22 script
23 will be executed with the instance start command as well. You can op‐
24 tionally
25 pass arguments to startscript
26 singularity instance start accepts the following container formats
29 *.sif Singularity Image Format (SIF). Native to Singular‐
32 ity 3.0+
33 *.sqsh SquashFS format. Native to Singularity 2.4+
36 *.img ext3 format. Native to Singularity versions < 2.4.
39 directory/ sandbox format. Directory containing a valid root
42 file
43 system and optionally Singularity meta-data.
44 instance://* A local running instance of a container. (See the
47 instance
48 command group.)
49 library://* A SIF container hosted on a Library
52 (default https://cloud.sylabs.io/library)
53 docker://* A Docker/OCI container hosted on Docker Hub or an‐
56 other
57 OCI registry.
58 shub://* A container hosted on Singularity Hub.
61 oras://* A SIF container hosted on an OCI registry that sup‐
64 ports
65 the OCI Registry As Storage (ORAS) specification.
66
70 --add-caps="" a comma separated capability list to add
71 --allow-setuid[=false] allow setuid binaries in container (root
74 only)
75 --apply-cgroups="" apply cgroups from file for container processes
78 (root only)
79 -B, --bind=[] 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 de‐
85 fault). Multiple bind paths can be given by a comma separated list.
86 --blkio-weight=0 Block IO relative weight in range 10-1000, 0 to
89 disable
90 --blkio-weight-device=[] Device specific block IO relative weight
93 --boot[=false] execute /sbin/init to boot container (root only)
96 -e, --cleanenv[=false] clean environment before running container
99 --compat[=false] apply settings for increased OCI/Docker compati‐
102 bility. Infers --containall, --no-init, --no-umask, --no-eval,
103 --writable-tmpfs.
104 -c, --contain[=false] use minimal /dev and empty other directories
107 (e.g. /tmp and $HOME) instead of sharing filesystems from your host
108 -C, --containall[=false] contain not only file systems, but also
111 PID, IPC, and environment
112 --cpu-shares=-1 CPU shares for container
115 --cpus="" Number of CPUs available to container
118 --cpuset-cpus="" List of host CPUs available to container
121 --cpuset-mems="" List of host memory nodes available to container
124 --disable-cache[=false] dont use cache, and dont create cache
127 --dns="" list of DNS server separated by commas to add in re‐
130 solv.conf
131 --docker-host="" specify a custom Docker daemon host
134 --docker-login[=false] login to a Docker Repository interactively
137 --drop-caps="" a comma separated capability list to drop
140 --env=[] pass environment variable to contained process
143 --env-file="" pass environment variables from file to contained
146 process
147 -f, --fakeroot[=false] run container in new user namespace as uid
150 0
151 --fusemount=[] A FUSE filesystem mount specification of the form
154 ': ' - where is 'container' or 'host', specifying where the mount will
155 be performed ('container-daemon' or 'host-daemon' will run the FUSE
156 process detached). is the path to the FUSE executable, plus options
157 for the mount. is the location in the container to which the FUSE
158 mount will be attached. E.g. 'container:sshfs 10.0.0.1:/ /sshfs'. Im‐
159 plies --pid.
160 -h, --help[=false] help for start
163 -H, --home="/builddir" a home directory specification. spec can
166 either be a src path or src:dest pair. src is the source path of the
167 home directory outside the container and dest overrides the home direc‐
168 tory within the container.
169 --hostname="" set container hostname. Infers --uts.
172 -i, --ipc[=false] run container in a new IPC namespace
175 --keep-privs[=false] let root user keep privileges in container
178 (root only)
179 --memory="" Memory limit in bytes
182 --memory-reservation="" Memory soft limit in bytes
185 --memory-swap="" Swap limit, use -1 for unlimited swap
188 --mount=[] a mount specification e.g. 'type=bind,source=/opt,des‐
191 tination=/hostopt'.
192 -n, --net[=false] run container in a new network namespace (sets
195 up a bridge network interface by default)
196 --network="bridge" specify desired network type separated by com‐
199 mas, each network will bring up a dedicated interface inside container
200 --network-args=[] specify network arguments to pass to CNI plugins
203 --no-eval[=false] do not shell evaluate env vars or OCI container
206 CMD/ENTRYPOINT/ARGS
207 --no-home[=false] do NOT mount users home directory if /home is
210 not the current working directory
211 --no-https[=false] use http instead of https for docker:// oras://
214 and library:///... URIs
215 --no-init[=false] do NOT start shim process with --pid
218 --no-mount=[] disable one or more 'mount xxx' options set in sin‐
221 gularity.conf, specify absolute destination path to disable a bind path
222 entry, or 'bind-paths' to disable all bind path entries.
223 --no-privs[=false] drop all privileges from root user in con‐
226 tainer)
227 --no-setgroups[=false] disable setgroups when entering --fakeroot
230 user namespace
231 --no-umask[=false] do not propagate umask to the container, set
234 default 0022 umask
235 --nv[=false] enable Nvidia support
238 --nvccli[=false] use nvidia-container-cli for GPU setup (experi‐
241 mental)
242 --oom-kill-disable[=false] Disable OOM killer
245 -o, --overlay=[] use an overlayFS image for persistent data stor‐
248 age or as read-only layer of container
249 --passphrase[=false] prompt for an encryption passphrase
252 --pem-path="" enter an path to a PEM formatted RSA key for an en‐
255 crypted container
256 --pid-file="" write instance PID to the file with the given name
259 --pids-limit=0 Limit number of container PIDs, use -1 for unlim‐
262 ited
263 --rocm[=false] enable experimental Rocm support
266 -S, --scratch=[] include a scratch directory within the container
269 that is linked to a temporary dir (use -W to force location)
270 --security=[] enable security features (SELinux, Apparmor, Sec‐
273 comp)
274 -u, --userns[=false] run container in a new user namespace, allow‐
277 ing Singularity to run completely unprivileged on recent kernels. This
278 disables some features of Singularity, for example it only works with
279 sandbox images.
280 --uts[=false] run container in a new UTS namespace
283 -W, --workdir="" working directory to be used for /tmp, /var/tmp
286 and $HOME (if -c/--contain was also used)
287 -w, --writable[=false] by default all Singularity containers are
290 available as read only. This option makes the file system accessible as
291 read/write.
292 --writable-tmpfs[=false] makes the file system accessible as read-
295 write with non persistent data (with overlay support only)
296
300 $ singularity instance start /tmp/my-sql.sif mysql
301 $ singularity shell instance://mysql
303 Singularity my-sql.sif> pwd
304 /home/mibauer/mysql
305 Singularity my-sql.sif> ps
306 PID TTY TIME CMD
307 1 pts/0 00:00:00 sinit
308 2 pts/0 00:00:00 bash
309 3 pts/0 00:00:00 ps
310 Singularity my-sql.sif>
311 $ singularity instance stop /tmp/my-sql.sif mysql
313 Stopping /tmp/my-sql.sif mysql
314
319 singularity-instance(1)
320
324 18-Sep-2023 Auto generated by spf13/cobra
325Auto generated by spf13/cobra Sep 2023 singularity(1)