With the release of v3.0.0
, we're introducing a new changelog format in an attempt to consolidate the information presented in the changelog. The new changelog is reduced in scope to only documenting functionality changes from version to version. This ensures that the changelog is as useful as it can be. Changes which should be documented include:
- Renamed commands
- Deprecated / removed commands
- Changed defaults / behaviors
- Migration guidance
- New features / functionalities
The old changelog can be found in the release-2.6
branch
- Added the
--docker-login
flag to enable interactive authentication with docker registries - Added support for pulling directly from HTTP and HTTPS
- Made minor improvements to RPM packaging and added basic support for alpine packaging
- The
$SINGULARITY_NOHTTPS
,$SINGULARITY_TMPDIR
, and$SINGULARITY_DOCKER_USERNAME
/$SINGULARITY_DOCKER_PASSWORD
environment variables are now correctly respected - Pulling from a private shub registry now works as expected
- Running a container with
--network="none"
no longer incorrectly fails with an error message - Commands now correctly return 1 when incorrectly executed without arguments
- Progress bars no longer incorrectly display when running with
--quiet
or--silent
- Contents of
91-environment.sh
file are now displayed if appropriate when runninginspect --environment
- Improved RPM packaging procedure via makeit
- Enhanced general stability of runtime
- Singularity is now written primarily in Go to bring better integration with the existing container ecosystem
- Added support for new URIs (
build
&run/exec/shell/start
):library://
- Supports the Sylabs.io Cloud Librarydocker-daemon:
- Supports images managed by the locally running docker daemondocker-archive:
- Supports archived docker imagesoci:
- Supports oci imagesoci-archive:
- Supports archived oci images
- Handling of
docker
&oci
URIs/images now utilizes containers/image to parse and convert those image types in a supported way - Replaced
singularity instance.*
command group withsingularity instance *
- The command
singularity help
now only provides help regarding the usage of thesingularity
command. To display an image'shelp
message, usesingularity run-help <image path>
instead
- Removed deprecated
singularity image.*
command group - Removed deprecated
singularity create
command - Removed deprecated
singularity bootstrap
command - Removed deprecated
singularity mount
command
- Added
singularity run-help <image path>
command to output an image'shelp
message - Added
singularity sign <image path>
command to allow a user to cryptographically sign a SIF image - Added
singularity verify <image path>
command to allow a user to verify a SIF image's cryptographic signatures - Added
singularity keys
command to allow the management ofOpenPGP
key stores - Added
singularity capability
command to allow fine grained control over the capabilities of running containers - Added
singularity push
command to push images to the Sylabs.io Cloud Library
- Added flags:
--add-caps <string>
: Run the contained process with the specified capability set (requires root)--allow-setuid
: Allows setuid binaries to be mounted into the container (requires root)--apply-cgroups <path>
: Apply cgroups configuration from file to contained processes (requires root)--dns <string>
: Adds the comma separated list of DNS servers to the containersresolv.conf
file--drop-caps <string>
: Drop the specified capabilities from the container (requires root)--fakeroot
: Run the container in a user namespace asuid=0
. Requires a recent kernel to function properly--hostname <string>
: Set the hostname of the container--keep-privs
: Keep root user privilege inside the container (requires root)--network <string>
: Specify a list of comma separated network types (CNI Plugins) to be present inside the container, each with its own dedicated interface in the container--network-args <string>
: Specify arguments to pass to CNI network plugins (set by--network
)--no-privs
: Drop all privileges from root user inside the container (requires root)--security <string>
: Configure security features such as SELinux, Apparmor, Seccomp...--writable-tmpfs
: Run container with atmpfs
overlay
- The command
singularity instance start
now supports the--boot
flag to boot the container via/sbin/init
- Changes to image mounting behavior:
- All image formats are mounted as read only by default
--writable
only works on images which can be mounted in read/write [applicable to:sandbox
and legacyext3
images]--writable-tmpfs
runs the container with a writabletmpfs
-based overlay [applicable to: all image formats]--overlay <string>
now specifies a list ofext3
/sandbox
images which are set as the containers overlay [applicable to: all image formats]
- All images are now built as Singularity Image Format (SIF) images by default
- When building to a path that already exists,
singularity build
will now prompt the user if they wish to overwrite the file existing at the specified location - The
-w|--writable
flag has been removed - The
-F|--force
flag now overrides the interactive prompt and will always attempt to overwrite the file existing at the specified location - The
-u|--update
flag has been added to support the workflow of running a definition file on top of an existing container [implies--sandbox
, only supportssandbox
image types] - The
singularity build
command now supports the following flags for integration with the Sylabs.io Cloud Library:-r|--remote
: Build the image remotely on the Sylabs Remote Builder (currently unavailable)-d|--detached
: Detach from thestdout
of the remote build [requires--remote
]--builder <string>
: Specifies the URL of the remote builder to access--library <string>
: Specifies the URL of the Sylabs.io Cloud Library to push the built image to when the build command destination is in the formlibrary://<reference>
- The
bootstrap
keyword in the definition file now supports the following values:library
docker-daemon
docker-archive
oci
oci-archive
- The
from
keyword in the definition file now correctly parses adocker
URI which includes theregistry
and/ornamespace
components - The
registry
andnamespace
keywords in the definition file are no longer supported. Instead, those values may all go into thefrom
keyword - Building from a tar archive of a
sandbox
no longer works