singularity pull

Pull an image from a URI

Synopsis

The ‘pull’ command allows you to download or build a container from a given URI. Supported URIs include:

library: Pull an image from the currently configured library

library://user/collection/container[:tag]

docker: Pull a Docker/OCI image from Docker Hub, or another OCI registry.

docker://user/image:tag

shub: Pull an image from Singularity Hub

shub://user/image:tag

oras: Pull an image from an OCI registry that supports ORAS / OCI artifacts.

oras://registry/namespace/image:tag

http, https: Pull an image using the http(s?) protocol

https://example.com/containers/mycontainer.sif

By default, images from a library URI will be pulled in the same format they were uploaded. If the –oci flag is specified then the pull is required to result in an OCI-SIF image.

By default, images pulled from docker and other oci URIs will be converted into a singularity native SIF image. If the –oci flag is specified then they will be encapsulated in an OCI-SIF image.

Images pulled from a shub/oras/http/https URI are always directly downloaded, in the same format as they were uploaded.

singularity pull [pull options...] [output file] <URI>

Examples

From Sylabs cloud library
$ singularity pull alpine.sif library://alpine:latest

From Docker to a singularity native SIF image
$ singularity pull tensorflow.sif docker://tensorflow/tensorflow:latest

From Docker to an OCI-SIF image
$ singularity pull --oci tensorflow.oci.sif docker://tensorflow/tensorflow:latest

From Shub
$ singularity pull singularity-images.sif shub://vsoch/singularity-images

From an OCI registry supporting ORAS / OCI artifacts
$ singularity pull image.sif oras://<username>.azurecr.io/namespace/image:tag

Options

    --arch string          architecture to use when pulling images
    --authfile string      Docker-style authentication file to use for writing/reading OCI registry credentials
    --dir string           download images to the specific directory
    --disable-cache        dont use cached images/blobs and dont create them
    --docker-host string   specify a custom Docker daemon host
    --docker-login         login to a Docker Repository interactively
-F, --force                overwrite an image file if it exists
-h, --help                 help for pull
    --keep-layers          Keep layers when creating an OCI-SIF. Do not squash to a single layer.
    --library string       download images from the provided library
    --no-cleanup           do NOT clean up bundle after failed build, can be helpful for debugging
    --no-https             use http instead of https for docker:// oras:// and library://<hostname>/... URIs
    --no-oci               Launch container with native runtime
    --oci                  Launch container with OCI runtime (experimental)
    --platform string      platform (OS/Architecture/Variant) to use when pulling images

SEE ALSO

Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC)

Auto generated by spf13/cobra on 7-May-2024