Documentation ¶
Index ¶
Constants ¶
View Source
const ( // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // main singularity command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SingularityUse string = `singularity [global options...]` SingularityShort string = ` Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC)` SingularityLong string = `` /* 286-byte string literal not displayed */ SingularityExample string = `` /* 157-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // build // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ BuildUse string = `build [local options...] <IMAGE PATH> <BUILD SPEC>` BuildShort string = `Build a new Singularity container` BuildLong string = `` /* 1184-byte string literal not displayed */ BuildExample string = `` /* 3071-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Cache // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CacheUse string = `cache <subcommand>` CacheShort string = `Manage your local singularity cache` CacheLong string = `` /* 138-byte string literal not displayed */ CacheExample string = ` All group commands have their own help output: $ singularity cache $ singularity cache --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Cache clean // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CacheCleanUse string = `clean [clean options...]` CacheCleanShort string = `Clean your local Singularity cache` CacheCleanLong string = `` /* 208-byte string literal not displayed */ CacheCleanExample string = `` /* 192-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Cache List // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CacheListUse string = `list [list options...]` CacheListShort string = `List your local Singularity cache` CacheListLong string = ` This will list you local cache: "${HOME}/.singularity/cache". The available cache types are: library, oci, and blob.` CacheListExample string = `` /* 167-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyUse string = `key [key options...] <subcommand>` // keys : for the hidden `keys` command KeysUse string = `keys [keys options...] <subcommand>` KeyShort string = `Manage OpenPGP key stores` KeyLong string = `` /* 287-byte string literal not displayed */ KeyExample string = ` All group commands have their own help output: $ singularity help key newpair $ singularity key list --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key newpair // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyNewPairUse string = `newpair` KeyNewPairShort string = `Create a new OpenPGP key pair` KeyNewPairLong string = `` /* 179-byte string literal not displayed */ KeyNewPairExample string = ` $ singularity key newpair` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key list // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyListUse string = `list` KeyListShort string = `List keys from the default key store` KeyListLong string = `` /* 153-byte string literal not displayed */ KeyListExample string = ` $ singularity key list` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key search // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeySearchUse string = `search [search options...] <search_string>` KeySearchShort string = `Search for keys matching string argument` KeySearchLong string = `` /* 150-byte string literal not displayed */ KeySearchExample string = ` $ singularity key search sylabs.io` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key pull // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyPullUse string = `pull [pull options...] <fingerprint>` KeyPullShort string = `Fetch an OpenPGP public key from a key server` KeyPullLong string = `` /* 165-byte string literal not displayed */ KeyPullExample string = ` $ singularity key pull D87FE3AF5C1F063FCBCC9B02F812842B5EEE5934` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key push // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyPushUse string = `push [push options...] <fingerprint>` KeyPushShort string = `Upload an OpenPGP public key to a key server` KeyPushLong string = ` The 'key push' command allows you to connect to a key server and upload public keys from the local key store.` KeyPushExample string = ` $ singularity key push D87FE3AF5C1F063FCBCC9B02F812842B5EEE5934` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityUse string = `capability <subcommand>` CapabilityShort string = `Manage Linux capabilities on containers` CapabilityLong string = ` Capabilities allow you to have fine grained control over the permissions that your containers need to run.` CapabilityExample string = ` All group commands have their own help output: $ singularity help capability add $ singularity capability add --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability add // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityAddUse string = `add [add options...] <capabilities>` CapabilityAddShort string = `Add authorized capabilities for a given user/group` CapabilityAddLong string = `` /* 1536-byte string literal not displayed */ CapabilityAddExample string = `` /* 265-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability drop // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityDropUse string = `drop [drop options...] <capabilities>` CapabilityDropShort string = `Drop authorized capabilities for a given user/group` CapabilityDropLong string = `` /* 1536-byte string literal not displayed */ CapabilityDropExample string = `` /* 265-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability list // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityListUse string = `list [list options...]` CapabilityListShort string = `List authorized capabilities for the given user/group.` CapabilityListLong string = ` The capability list command allows you to see what Linux capabilities are associated with users/groups.` CapabilityListExample string = `` /* 131-byte string literal not displayed */ ExecUse string = `exec [exec options...] <container> <command>` ExecShort string = `Execute a command within container` ExecLong string = ` singularity exec supports the following formats:` + formats ExecExamples string = `` /* 364-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceUse string = `instance <subcommand>` InstanceShort string = `Manage containers running in the background` InstanceLong string = `` /* 141-byte string literal not displayed */ InstanceExample string = ` All group commands have their own help output: $ singularity help instance start $ singularity instance start --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance list // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceListUse string = `list [list options...] <container>` InstanceListShort string = `List all running and named Singularity instances` InstanceListLong string = `` /* 131-byte string literal not displayed */ InstanceListExample string = `` /* 384-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance start // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceStartUse string = `start [start options...] <container path> <instance name> [startscript args...]` InstanceStartShort string = `Start a named instance of the given container image` InstanceStartLong string = ` The instance start command allows you to create a new named instance from an existing container image that will begin running in the background. If a startscript is defined in the container metadata the commands in that script will be executed with the instance start command as well. You can optionally pass arguments to startscript singularity instance start accepts the following container formats` + formats InstanceStartExample string = `` /* 400-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance stop // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceStopUse string = `stop [stop options...] [instance]` InstanceStopShort string = `Stop a named instance of a given container image` InstanceStopLong string = `` /* 128-byte string literal not displayed */ InstanceStopExample string = `` /* 548-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // pull // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PullUse string = `pull [pull options...] [output file] <URI>` PullShort string = `Pull a container from a URI` PullLong string = `` /* 381-byte string literal not displayed */ PullExample string = `` /* 262-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // push // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PushUse string = `push [push options...] <container image> library://[user[collection/[container[:tag]]]]` PushShort string = `Push a container to a Library URI` PushLong string = ` The Singularity push command allows you to upload your sif image to a library of your choosing` PushExample string = ` $ singularity push /home/user/my.sif library://user/collection/my.sif:latest` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // search // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SearchUse string = `search [search options...] <search query>` SearchShort string = `Search the library` SearchLong string = `` /* 207-byte string literal not displayed */ SearchExample string = ` $ singularity search lolcow` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // run // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RunUse string = `run [run options...] <container>` RunShort string = `Launch a runscript within container` RunLong string = ` This command will launch a Singularity container and execute a runscript if one is defined for that container. The runscript is a metadata file within the container that contains shell commands. If the file is present (and executable) then this command will execute that file within the container automatically. All arguments following the container name will be passed directly to the runscript. singularity run accepts the following container formats:` + formats RunExamples string = `` /* 352-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // shell // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ShellUse string = `shell [shell options...] <container>` ShellShort string = `Run a Bourne shell within container` ShellLong string = ` singularity shell supports the following formats:` + formats ShellExamples string = `` /* 830-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // sign // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SignUse string = `sign [sign options...] <image path>` SignShort string = `Attach cryptographic signatures to container` SignLong string = `` /* 319-byte string literal not displayed */ SignExample string = ` $ singularity sign container.sif` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // verify // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ VerifyUse string = `verify [verify options...] <image path>` VerifyShort string = `Verify cryptographic signatures on container` VerifyLong string = `` /* 441-byte string literal not displayed */ VerifyExample string = ` $ singularity verify container.sif` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Run-help // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RunHelpUse string = `run-help <image path>` RunHelpShort string = `Display help for container if available` RunHelpLong string = ` The 'run-help' command will display a help text file for a container if available.` RunHelpExample string = `` /* 327-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Inspect // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InspectUse string = `inspect [inspect options...] <image path>` InspectShort string = `Display metadata for container if available` InspectLong string = `` /* 130-byte string literal not displayed */ InspectExample string = ` $ singularity inspect ubuntu.sif` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Apps // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ AppsUse string = `apps <image path>` AppsShort string = `List available apps within a container` AppsLong string = `` /* 1266-byte string literal not displayed */ AppsExample string = ` $ singularity apps ubuntu.img bar foo` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Test // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RunTestUse string = `test [exec options...] <image path>` RunTestShort string = `Run defined tests for this particular container` RunTestLong string = `` /* 450-byte string literal not displayed */ RunTestExample string = `` /* 301-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // OCI // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ OciUse string = `oci <subcommand>` OciShort string = `Manage OCI containers` OciLong string = ` Allow you to manage containers from OCI bundle directories. NOTE: all oci commands requires to run as root` OciExample string = `` /* 139-byte string literal not displayed */ OciCreateUse string = `create [create options...] <container_ID>` OciCreateShort string = `Create a container from a bundle directory (root user only)` OciCreateLong string = ` Create invoke create operation to create a container instance from an OCI bundle directory` OciCreateExample string = ` $ singularity create -b ~/bundle mycontainer` OciStartUse string = `start <container_ID>` OciStartShort string = `Start container process (root user only)` OciStartLong string = ` Start invoke start operation to start a previously created container identified by container ID.` OciStartExample string = ` $ singularity start mycontainer` OciStateUse string = `state <container_ID>` OciStateShort string = `Query state of a container (root user only)` OciStateLong string = ` State invoke state operation to query state of a created/running/stopped container identified by container ID.` OciStateExample string = ` $ singularity state mycontainer` OciKillUse string = `kill <container_ID> [-s] signal` OciKillShort string = `Kill a container (root user only)` OciKillLong string = ` Kill invoke kill operation to kill processes running within container identified by container ID.` OciKillExample string = ` $ singularity kill mycontainer INT $ singularity kill mycontainer -s INT` OciDeleteUse string = `delete <container_ID>` OciDeleteShort string = `Delete container (root user only)` OciDeleteLong string = ` Delete invoke delete operation to delete resources that were created for container identified by container ID.` OciDeleteExample string = ` $ singularity delete mycontainer` OciAttachUse string = `attach <container_ID>` OciAttachShort string = `Attach console to a running container process (root user only)` OciAttachLong string = ` Attach will attach console to a running container process running within container identified by container ID.` OciAttachExample string = ` $ singularity attach mycontainer` OciExecUse string = `exec <container_ID> <command> <args>` OciExecShort string = `Execute a command within container (root user only)` OciExecLong string = ` Exec will execute the provided command/arguments within container identified by container ID.` OciExecExample string = ` $ singularity exec mycontainer id` OciRunUse string = `run [run options...] <container_ID>` OciRunShort string = `Create/start/attach/delete a container from a bundle directory (root user only)` OciRunLong string = ` Run will invoke equivalent of create/start/attach/delete commands in a row.` OciRunExample string = `` /* 238-byte string literal not displayed */ OciUpdateUse string = `update [update options...] <container_ID>` OciUpdateShort string = `Update container cgroups resources (root user only)` OciUpdateLong string = ` Update will update cgroups resources for the specified container ID. Container must be in a RUNNING or CREATED state.` OciUpdateExample string = `` /* 190-byte string literal not displayed */ OciPauseUse string = `pause <container_ID>` OciPauseShort string = `Suspends all processes inside the container (root user only)` OciPauseLong string = ` Pause will suspend all processes for the specified container ID.` OciPauseExample string = ` $ singularity oci pause mycontainer` OciResumeUse string = `resume <container_ID>` OciResumeShort string = `Resumes all processes previously paused inside the container (root user only)` OciResumeLong string = ` Resume will resume all processes previously paused for the specified container ID.` OciResumeExample string = ` $ singularity oci resume mycontainer` OciMountUse string = `mount <sif_image> <bundle_path>` OciMountShort string = `Mount create an OCI bundle from SIF image (root user only)` OciMountLong string = ` Mount will mount and create an OCI bundle from a SIF image.` OciMountExample string = ` $ singularity oci mount /tmp/example.sif /var/lib/singularity/bundles/example` OciUmountUse string = `umount <bundle_path>` OciUmountShort string = `Umount delete bundle (root user only)` OciUmountLong string = ` Umount will umount an OCI bundle previously mounted with singularity oci mount.` OciUmountExample string = ` $ singularity oci umount /var/lib/singularity/bundles/example` )
Global content for help and man pages
View Source
const ( HelpTemplate string = `` /* 598-byte string literal not displayed */ UseTemplate string = `` /* 231-byte string literal not displayed */ )
Global templates for help and usage strings
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.