Update main userdocs

apptainer · Jun 21, 2023 · 53ab59d · 53ab59d
1 parent fb06896
commit 53ab59d
Show file tree

Hide file tree

Showing 197 changed files with 1,433 additions and 305 deletions.
diff --git a/static/docs/user/main/_sources/appendix.rst.txt b/static/docs/user/main/_sources/appendix.rst.txt
@@ -853,9 +853,9 @@ Notes
 Arch Linux is, by design, a very stripped down, light-weight OS. You may
 need to perform a significant amount of configuration to get a usable
 OS. Please refer to this `README.md
-<https://github.com/{orgrepo}/blob/master/examples/arch/README.md>`_
+<https://github.com/{orgrepo}/blob/{repobranch}/examples/arch/README.md>`_
 and the `Arch Linux example
-<https://github.com/{orgrepo}/blob/master/examples/arch/>`_
+<https://github.com/{orgrepo}/blob/{repobranch}/examples/arch/>`_
 for more info.
 
 .. _build-busybox:

diff --git a/static/docs/user/main/_sources/cli/apptainer.rst.txt b/static/docs/user/main/_sources/cli/apptainer.rst.txt
@@ -74,4 +74,4 @@ SEE ALSO
 * :ref:`apptainer verify <apptainer_verify>` 	 - Verify digital signature(s) within an image
 * :ref:`apptainer version <apptainer_version>` 	 - Show the version for Apptainer
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_build.rst.txt b/static/docs/user/main/_sources/cli/apptainer_build.rst.txt
@@ -160,31 +160,33 @@ Options
 
 ::
 
-  -B, --bind stringArray     a user-bind path specification. spec has the format src[:dest[:opts]],where src and dest are outside and inside paths. If dest is not given,it is set equal to src. Mount options ('opts') may be specified as 'ro'(read-only) or 'rw' (read/write, which is the default).Multiple bind paths can be given by a comma separated list.
-      --disable-cache        do not use cache or create cache
-      --docker-host string   specify a custom Docker daemon host
-      --docker-login         login to a Docker Repository interactively
-  -e, --encrypt              build an image with an encrypted file system
-  -f, --fakeroot             build with the appearance of running as root (default when building from a definition file unprivileged)
-      --fix-perms            ensure owner has rwX permissions on all container content for oci/docker sources
-  -F, --force                overwrite an image file if it exists
-  -h, --help                 help for build
-      --json                 interpret build definition as JSON
-      --library string       container Library URL
-      --mount stringArray    a mount specification e.g. 'type=bind,source=/opt,destination=/hostopt'.
-      --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
-  -T, --notest               build without running tests in %test section
-      --nv                   inject host Nvidia libraries during build for post and test sections
-      --nvccli               use nvidia-container-cli for GPU setup (experimental)
-      --passphrase           prompt for an encryption passphrase
-      --pem-path string      enter an path to a PEM formatted RSA key for an encrypted container
-      --rocm                 inject host Rocm libraries during build for post and test sections
-  -s, --sandbox              build image as sandbox format (chroot directory structure)
-      --section strings      only run specific section(s) of deffile (setup, post, files, environment, test, labels, none) (default [all])
-  -u, --update               run definition over existing container (skips header)
-      --userns               build without using setuid even if available
-      --writable-tmpfs       during the %test section, makes the file system accessible as read-write with non persistent data (with overlay support only)
+  -B, --bind stringArray        a user-bind path specification. spec has the format src[:dest[:opts]],where src and dest are outside and inside paths. If dest is not given,it is set equal to src. Mount options ('opts') may be specified as 'ro'(read-only) or 'rw' (read/write, which is the default).Multiple bind paths can be given by a comma separated list.
+      --build-arg strings       defines variable=value to replace {{ variable }} entries in build definition file
+      --build-arg-file string   specifies a file containing variable=value lines to replace '{{ variable }}' with value in build definition files
+      --disable-cache           do not use cache or create cache
+      --docker-host string      specify a custom Docker daemon host
+      --docker-login            login to a Docker Repository interactively
+  -e, --encrypt                 build an image with an encrypted file system
+  -f, --fakeroot                build with the appearance of running as root (default when building from a definition file unprivileged)
+      --fix-perms               ensure owner has rwX permissions on all container content for oci/docker sources
+  -F, --force                   overwrite an image file if it exists
+  -h, --help                    help for build
+      --json                    interpret build definition as JSON
+      --library string          container Library URL
+      --mount stringArray       a mount specification e.g. 'type=bind,source=/opt,destination=/hostopt'.
+      --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
+  -T, --notest                  build without running tests in %test section
+      --nv                      inject host Nvidia libraries during build for post and test sections
+      --nvccli                  use nvidia-container-cli for GPU setup (experimental)
+      --passphrase              prompt for an encryption passphrase
+      --pem-path string         enter an path to a PEM formatted RSA key for an encrypted container
+      --rocm                    inject host Rocm libraries during build for post and test sections
+  -s, --sandbox                 build image as sandbox format (chroot directory structure)
+      --section strings         only run specific section(s) of deffile (setup, post, files, environment, test, labels, none) (default [all])
+  -u, --update                  run definition over existing container (skips header)
+      --userns                  build without using setuid even if available
+      --writable-tmpfs          during the %test section, makes the file system accessible as read-write with non persistent data (with overlay support only)
 
 SEE ALSO
 ~~~~~~~~
@@ -193,4 +195,4 @@ SEE ALSO
 Linux container platform optimized for High Performance Computing (HPC) and
 Enterprise Performance Computing (EPC)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_cache.rst.txt b/static/docs/user/main/_sources/cli/apptainer_cache.rst.txt
@@ -44,4 +44,4 @@ Enterprise Performance Computing (EPC)
 * :ref:`apptainer cache clean <apptainer_cache_clean>` 	 - Clean your local Apptainer cache
 * :ref:`apptainer cache list <apptainer_cache_list>` 	 - List your local Apptainer cache
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_cache_clean.rst.txt b/static/docs/user/main/_sources/cli/apptainer_cache_clean.rst.txt
@@ -48,4 +48,4 @@ SEE ALSO
 
 * :ref:`apptainer cache <apptainer_cache>` 	 - Manage the local cache
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_cache_list.rst.txt b/static/docs/user/main/_sources/cli/apptainer_cache_list.rst.txt
@@ -43,4 +43,4 @@ SEE ALSO
 
 * :ref:`apptainer cache <apptainer_cache>` 	 - Manage the local cache
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_capability.rst.txt b/static/docs/user/main/_sources/cli/apptainer_capability.rst.txt
@@ -51,4 +51,4 @@ Enterprise Performance Computing (EPC)
 * :ref:`apptainer capability drop <apptainer_capability_drop>` 	 - Remove capabilities from a user or group (requires root)
 * :ref:`apptainer capability list <apptainer_capability_list>` 	 - Show capabilities for a given user or group
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_capability_add.rst.txt b/static/docs/user/main/_sources/cli/apptainer_capability_add.rst.txt
@@ -50,4 +50,4 @@ SEE ALSO
 
 * :ref:`apptainer capability <apptainer_capability>` 	 - Manage Linux capabilities for users and groups
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_capability_avail.rst.txt b/static/docs/user/main/_sources/cli/apptainer_capability_avail.rst.txt
@@ -46,4 +46,4 @@ SEE ALSO
 
 * :ref:`apptainer capability <apptainer_capability>` 	 - Manage Linux capabilities for users and groups
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_capability_drop.rst.txt b/static/docs/user/main/_sources/cli/apptainer_capability_drop.rst.txt
@@ -50,4 +50,4 @@ SEE ALSO
 
 * :ref:`apptainer capability <apptainer_capability>` 	 - Manage Linux capabilities for users and groups
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_capability_list.rst.txt b/static/docs/user/main/_sources/cli/apptainer_capability_list.rst.txt
@@ -42,4 +42,4 @@ SEE ALSO
 
 * :ref:`apptainer capability <apptainer_capability>` 	 - Manage Linux capabilities for users and groups
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_checkpoint.rst.txt b/static/docs/user/main/_sources/cli/apptainer_checkpoint.rst.txt
@@ -41,4 +41,4 @@ Enterprise Performance Computing (EPC)
 * :ref:`apptainer checkpoint instance <apptainer_checkpoint_instance>` 	 - Checkpoint the state of a running instance (experimental)
 * :ref:`apptainer checkpoint list <apptainer_checkpoint_list>` 	 - List local checkpoints (experimental)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_checkpoint_create.rst.txt b/static/docs/user/main/_sources/cli/apptainer_checkpoint_create.rst.txt
@@ -38,4 +38,4 @@ SEE ALSO
 
 * :ref:`apptainer checkpoint <apptainer_checkpoint>` 	 - Manage container checkpoint state (experimental)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_checkpoint_delete.rst.txt b/static/docs/user/main/_sources/cli/apptainer_checkpoint_delete.rst.txt
@@ -37,4 +37,4 @@ SEE ALSO
 
 * :ref:`apptainer checkpoint <apptainer_checkpoint>` 	 - Manage container checkpoint state (experimental)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_checkpoint_instance.rst.txt b/static/docs/user/main/_sources/cli/apptainer_checkpoint_instance.rst.txt
@@ -39,4 +39,4 @@ SEE ALSO
 
 * :ref:`apptainer checkpoint <apptainer_checkpoint>` 	 - Manage container checkpoint state (experimental)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_checkpoint_list.rst.txt b/static/docs/user/main/_sources/cli/apptainer_checkpoint_list.rst.txt
@@ -38,4 +38,4 @@ SEE ALSO
 
 * :ref:`apptainer checkpoint <apptainer_checkpoint>` 	 - Manage container checkpoint state (experimental)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_config.rst.txt b/static/docs/user/main/_sources/cli/apptainer_config.rst.txt
@@ -40,4 +40,4 @@ Enterprise Performance Computing (EPC)
 * :ref:`apptainer config fakeroot <apptainer_config_fakeroot>` 	 - Manage fakeroot user mappings entries (root user only)
 * :ref:`apptainer config global <apptainer_config_global>` 	 - Edit apptainer.conf from command line (root user only or unprivileged installation)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_config_fakeroot.rst.txt b/static/docs/user/main/_sources/cli/apptainer_config_fakeroot.rst.txt
@@ -51,4 +51,4 @@ SEE ALSO
 
 * :ref:`apptainer config <apptainer_config>` 	 - Manage various apptainer configuration (root user only)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_config_global.rst.txt b/static/docs/user/main/_sources/cli/apptainer_config_global.rst.txt
@@ -55,4 +55,4 @@ SEE ALSO
 
 * :ref:`apptainer config <apptainer_config>` 	 - Manage various apptainer configuration (root user only)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_delete.rst.txt b/static/docs/user/main/_sources/cli/apptainer_delete.rst.txt
@@ -42,4 +42,4 @@ SEE ALSO
 Linux container platform optimized for High Performance Computing (HPC) and
 Enterprise Performance Computing (EPC)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_exec.rst.txt b/static/docs/user/main/_sources/cli/apptainer_exec.rst.txt
@@ -132,4 +132,4 @@ SEE ALSO
 Linux container platform optimized for High Performance Computing (HPC) and
 Enterprise Performance Computing (EPC)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_inspect.rst.txt b/static/docs/user/main/_sources/cli/apptainer_inspect.rst.txt
@@ -100,4 +100,4 @@ SEE ALSO
 Linux container platform optimized for High Performance Computing (HPC) and
 Enterprise Performance Computing (EPC)
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_instance.rst.txt b/static/docs/user/main/_sources/cli/apptainer_instance.rst.txt
@@ -42,8 +42,9 @@ SEE ALSO
 Linux container platform optimized for High Performance Computing (HPC) and
 Enterprise Performance Computing (EPC)
 * :ref:`apptainer instance list <apptainer_instance_list>` 	 - List all running and named Apptainer instances
+* :ref:`apptainer instance run <apptainer_instance_run>` 	 - Run a named instance of the given container image
 * :ref:`apptainer instance start <apptainer_instance_start>` 	 - Start a named instance of the given container image
 * :ref:`apptainer instance stats <apptainer_instance_stats>` 	 - Get stats for a named instance
 * :ref:`apptainer instance stop <apptainer_instance_stop>` 	 - Stop a named instance of a given container image
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*
diff --git a/static/docs/user/main/_sources/cli/apptainer_instance_list.rst.txt b/static/docs/user/main/_sources/cli/apptainer_instance_list.rst.txt
@@ -54,4 +54,4 @@ SEE ALSO
 
 * :ref:`apptainer instance <apptainer_instance>` 	 - Manage containers running as services
 
-*Auto generated by spf13/cobra on 8-Jun-2023*
+*Auto generated by spf13/cobra on 21-Jun-2023*