singularity-instance-start - Man Page

Start a named instance of the given container image


singularity instance start [start options...]   [startscript args...]


The instance start command allows you to create a new named instance from an
 existing container image that will begin running in the background. If a
 startscript is defined in the container metadata the commands in that script
 will be executed with the instance start command as well. You can optionally
 pass arguments to startscript

singularity instance start accepts the following container formats

*.sif               Singularity Image Format (SIF). Native to Singularity 3.0+

*.sqsh              SquashFS format.  Native to Singularity 2.4+

*.img               ext3 format. Native to Singularity versions < 2.4.

directory/          sandbox format. Directory containing a valid root file
                     system and optionally Singularity meta-data.

instance://*        A local running instance of a container. (See the instance
                     command group.)

library://*         A SIF container hosted on a Library

docker://*          A Docker/OCI container hosted on Docker Hub or another
                     OCI registry.

shub://*            A container hosted on Singularity Hub.

oras://*            A SIF container hosted on an OCI registry that supports
                     the OCI Registry As Storage (ORAS) specification.


--add-caps="" a comma separated capability list to add

--allow-setuid[=false] allow setuid binaries in container (root only)

--apply-cgroups="" apply cgroups from file for container processes (root only)

-B, --bind=[] a user-bind path specification.  spec has the format src[:dest[:opts]], where src and dest are outside and inside paths.  If dest is not given, it is set equal to src.  Mount options ('opts') may be specified as 'ro' (read-only) or 'rw' (read/write, which is the default). Multiple bind paths can be given by a comma separated list.

--boot[=false] execute /sbin/init to boot container (root only)

-e, --cleanenv[=false] clean environment before running container

-c, --contain[=false] use minimal /dev and empty other directories (e.g. /tmp and $HOME) instead of sharing filesystems from your host

-C, --containall[=false] contain not only file systems, but also PID, IPC, and environment

--disable-cache[=false] dont use cache, and dont create cache

--dns="" list of DNS server separated by commas to add in resolv.conf

--docker-login[=false] login to a Docker Repository interactively

--drop-caps="" a comma separated capability list to drop

--env=[] pass environment variable to contained process

--env-file="" pass environment variables from file to contained process

-f, --fakeroot[=false] run container in new user namespace as uid 0

--fusemount=[] A FUSE filesystem mount specification of the form ': ' - where  is 'container' or 'host', specifying where the mount will be performed ('container-daemon' or 'host-daemon' will run the FUSE process detached).  is the path to the FUSE executable, plus options for the mount.  is the location in the container to which the FUSE mount will be attached. E.g. 'container:sshfs /sshfs'. Implies --pid.

-h, --help[=false] help for start

-H, --home="/builddir" a home directory specification.  spec can either be a src path or src:dest pair.  src is the source path of the home directory outside the container and dest overrides the home directory within the container.

--hostname="" set container hostname

--keep-privs[=false] let root user keep privileges in container (root only)

-n, --net[=false] run container in a new network namespace (sets up a bridge network interface by default)

--network="bridge" specify desired network type separated by commas, each network will bring up a dedicated interface inside container

--network-args=[] specify network arguments to pass to CNI plugins

--no-home[=false] do NOT mount users home directory if /home is not the current working directory

--no-init[=false] do NOT start shim process with --pid

--no-mount=[] disable one or more mount xxx options set in singularity.conf

--no-privs[=false] drop all privileges from root user in container)

--no-umask[=false] do not propagate umask to the container, set default 0022 umask

--nohttps[=false] do NOT use HTTPS with the docker:// transport (useful for local docker registries without a certificate)

--nv[=false] enable experimental Nvidia support

-o, --overlay=[] use an overlayFS image for persistent data storage or as read-only layer of container

--passphrase[=false] prompt for an encryption passphrase

--pem-path="" enter an path to a PEM formated RSA key for an encrypted container

--pid-file="" write instance PID to the file with the given name

--rocm[=false] enable experimental Rocm support

-S, --scratch=[] include a scratch directory within the container that is linked to a temporary dir (use -W to force location)

--security=[] enable security features (SELinux, Apparmor, Seccomp)

-u, --userns[=false] run container in a new user namespace, allowing Singularity to run completely unprivileged on recent kernels. This disables some features of Singularity, for example it only works with sandbox images.

--uts[=false] run container in a new UTS namespace

-W, --workdir="" working directory to be used for /tmp, /var/tmp and $HOME (if -c/--contain was also used)

-w, --writable[=false] by default all Singularity containers are available as read only. This option makes the file system accessible as read/write.

--writable-tmpfs[=false] makes the file system accessible as read-write with non persistent data (with overlay support only)


  $ singularity instance start /tmp/my-sql.sif mysql

  $ singularity shell instance://mysql
  Singularity my-sql.sif> pwd
  Singularity my-sql.sif> ps
  PID TTY          TIME CMD
    1 pts/0    00:00:00 sinit
    2 pts/0    00:00:00 bash
    3 pts/0    00:00:00 ps
  Singularity my-sql.sif>

  $ singularity instance stop /tmp/my-sql.sif mysql
  Stopping /tmp/my-sql.sif mysql

See Also



14-Dec-2021 Auto generated by spf13/cobra

Referenced By


Dec 2021 Auto generated by spf13/cobra