singularity remote

Manage singularity remote endpoints, keyservers and OCI/Docker registry credentials

Synopsis

The ‘remote’ command allows you to manage Singularity remote endpoints, standalone keyservers and OCI/Docker registry credentials through its subcommands.

A ‘remote endpoint’ is the Sylabs Cloud, a Singularity Enterprise installation, or a compatible group of services. The remote endpoint is a single address, e.g. ‘cloud.sylabs.io’ through which linked library, builder and keystore sevices will be automatically discovered.

To configure a remote endpoint you must ‘remote add’ it. You can ‘remote login’ if you will be performing actions needing authentication. Switch between configured remote endpoints with the ‘remote use’ command. The active remote endpoint will be used for remote builds, key operations, and ‘library://’ pull and push. You can also ‘remote logout’ from and ‘remote remove’ an endpoint that is no longer required.

To configure credentials for OCI registries that should be used when pulling or pushing from/to ‘docker://’’ or ‘oras://’ URIs, use the ‘remote login’ command only. You do not have to ‘remote add’ OCI registries. To remove credentials ‘remote logout’ with the same URI. You do not need to ‘remote remove’ OCI credentials.

The remote configuration is stored in $HOME/.singularity/remotes.yaml by default.

Examples

All group commands have their own help output:

  $ singularity help remote list
  $ singularity remote list

Options

-c, --config string   path to the file holding remote endpoint configurations (default "/home/circleci/.singularity/remote.yaml")
-h, --help            help for remote

SEE ALSO

Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC) * singularity remote add - Add a new singularity remote endpoint * singularity remote add-keyserver - Add a keyserver (root user only) * singularity remote list - List all singularity remote endpoints, keyservers, and OCI credentials that are configured * singularity remote login - Login to a singularity remote endpoint, an OCI/Docker registry or a keyserver using credentials * singularity remote logout - Log out from a singularity remote endpoint, an OCI/Docker registry or a keyserver * singularity remote remove - Remove an existing singularity remote endpoint * singularity remote remove-keyserver - Remove a keyserver (root user only) * singularity remote status - Check the status of the singularity services at an endpoint, and your authentication token * singularity remote use - Set a singularity remote endpoint to be actively used

Auto generated by spf13/cobra on 10-Nov-2021