1singularity(1)                                                  singularity(1)
2
3
4

NAME

6       singularity-instance-start  -  Start a named instance of the given con‐
7       tainer image
8
9
10

SYNOPSIS

12       singularity instance start [start options...]   [startscript args...]
13
14
15

DESCRIPTION

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
27
28       singularity instance start accepts the following container formats
29
30
31       *.sif               Singularity Image Format (SIF). Native to Singular‐
32       ity 3.0+
33
34
35       *.sqsh              SquashFS format.  Native to Singularity 2.4+
36
37
38       *.img               ext3 format. Native to Singularity versions < 2.4.
39
40
41       directory/           sandbox  format. Directory containing a valid root
42       file
43                             system and optionally Singularity meta-data.
44
45
46       instance://*        A local running instance of a container.  (See  the
47       instance
48                             command group.)
49
50
51       library://*         A SIF container hosted on a Library
52                             (default https://cloud.sylabs.io/library)
53
54
55       docker://*           A Docker/OCI container hosted on Docker Hub or an‐
56       other
57                             OCI registry.
58
59
60       shub://*            A container hosted on Singularity Hub.
61
62
63       oras://*            A SIF container hosted on an OCI registry that sup‐
64       ports
65                             the OCI Registry As Storage (ORAS) specification.
66
67
68

OPTIONS

70       --add-caps=""      a comma separated capability list to add
71
72
73       --allow-setuid[=false]       allow  setuid  binaries in container (root
74       only)
75
76
77       --apply-cgroups=""      apply cgroups from file for container processes
78       (root only)
79
80
81       -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
87
88       --boot[=false]      execute /sbin/init to boot container (root only)
89
90
91       -e, --cleanenv[=false]      clean environment before running container
92
93
94       -c, --contain[=false]      use minimal /dev and empty other directories
95       (e.g. /tmp and $HOME) instead of sharing filesystems from your host
96
97
98       -C, --containall[=false]      contain not only file systems,  but  also
99       PID, IPC, and environment
100
101
102       --disable-cache[=false]      dont use cache, and dont create cache
103
104
105       --dns=""       list  of  DNS  server  separated by commas to add in re‐
106       solv.conf
107
108
109       --docker-login[=false]      login to a Docker Repository interactively
110
111
112       --drop-caps=""      a comma separated capability list to drop
113
114
115       --env=[]      pass environment variable to contained process
116
117
118       --env-file=""      pass environment variables from  file  to  contained
119       process
120
121
122       -f,  --fakeroot[=false]      run container in new user namespace as uid
123       0
124
125
126       --fusemount=[]      A FUSE filesystem mount specification of  the  form
127       ': ' - where  is 'container' or 'host', specifying where the mount will
128       be performed ('container-daemon' or 'host-daemon'  will  run  the  FUSE
129       process  detached).   is  the path to the FUSE executable, plus options
130       for the mount.  is the location in the  container  to  which  the  FUSE
131       mount  will  be attached. E.g. 'container:sshfs 10.0.0.1:/ /sshfs'. Im‐
132       plies --pid.
133
134
135       -h, --help[=false]      help for start
136
137
138       -H, --home="/builddir"      a home directory specification.   spec  can
139       either  be  a src path or src:dest pair.  src is the source path of the
140       home directory outside the container and dest overrides the home direc‐
141       tory within the container.
142
143
144       --hostname=""      set container hostname
145
146
147       --keep-privs[=false]       let  root  user keep privileges in container
148       (root only)
149
150
151       -n, --net[=false]      run container in a new network  namespace  (sets
152       up a bridge network interface by default)
153
154
155       --network="bridge"       specify desired network type separated by com‐
156       mas, each network will bring up a dedicated interface inside container
157
158
159       --network-args=[]      specify network arguments to pass to CNI plugins
160
161
162       --no-home[=false]      do NOT mount users home directory  if  /home  is
163       not the current working directory
164
165
166       --no-init[=false]      do NOT start shim process with --pid
167
168
169       --no-mount=[]       disable one or more mount xxx options set in singu‐
170       larity.conf
171
172
173       --no-privs[=false]      drop all privileges  from  root  user  in  con‐
174       tainer)
175
176
177       --no-umask[=false]       do  not  propagate umask to the container, set
178       default 0022 umask
179
180
181       --nohttps[=false]      do NOT use HTTPS with  the  docker://  transport
182       (useful for local docker registries without a certificate)
183
184
185       --nv[=false]      enable experimental Nvidia support
186
187
188       -o,  --overlay=[]      use an overlayFS image for persistent data stor‐
189       age or as read-only layer of container
190
191
192       --passphrase[=false]      prompt for an encryption passphrase
193
194
195       --pem-path=""      enter an path to a PEM formated RSA key for  an  en‐
196       crypted container
197
198
199       --pid-file=""      write instance PID to the file with the given name
200
201
202       --rocm[=false]      enable experimental Rocm support
203
204
205       -S,  --scratch=[]      include a scratch directory within the container
206       that is linked to a temporary dir (use -W to force location)
207
208
209       --security=[]      enable security features  (SELinux,  Apparmor,  Sec‐
210       comp)
211
212
213       -u, --userns[=false]      run container in a new user namespace, allow‐
214       ing Singularity to run completely unprivileged on recent kernels.  This
215       disables  some  features of Singularity, for example it only works with
216       sandbox images.
217
218
219       --uts[=false]      run container in a new UTS namespace
220
221
222       -W, --workdir=""      working directory to be used for  /tmp,  /var/tmp
223       and $HOME (if -c/--contain was also used)
224
225
226       -w,  --writable[=false]       by default all Singularity containers are
227       available as read only. This option makes the file system accessible as
228       read/write.
229
230
231       --writable-tmpfs[=false]       makes  the  file  system  accessible  as
232       read-write with non persistent data (with overlay support only)
233
234
235

EXAMPLE

237                $ singularity instance start /tmp/my-sql.sif mysql
238
239                $ singularity shell instance://mysql
240                Singularity my-sql.sif> pwd
241                /home/mibauer/mysql
242                Singularity my-sql.sif> ps
243                PID TTY          TIME CMD
244                  1 pts/0    00:00:00 sinit
245                  2 pts/0    00:00:00 bash
246                  3 pts/0    00:00:00 ps
247                Singularity my-sql.sif>
248
249                $ singularity instance stop /tmp/my-sql.sif mysql
250                Stopping /tmp/my-sql.sif mysql
251
252
253
254

SEE ALSO

256       singularity-instance(1)
257
258
259

HISTORY

261       23-Jul-2022 Auto generated by spf13/cobra
262
263
264
265Auto generated by spf13/cobra      Jul 2022                     singularity(1)
Impressum