apptainer remote

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

Synopsis

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

A ‘remote endpoint’ is a group of services that is compatible with the container library API. The remote endpoint is a single address, e.g. ‘cloud.example.com’ through which library and/or keystore services 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 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/.apptainer/remotes.yaml by default.

Examples

All group commands have their own help output:

  $ apptainer help remote list
  $ apptainer remote list

Options

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

SEE ALSO

apptainer -

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

Auto generated by spf13/cobra on 22-Nov-2023