Skip to content

Commit

Permalink
Update main userdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Apr 25, 2023
1 parent 8cbc116 commit 0453ffc
Show file tree
Hide file tree
Showing 185 changed files with 210 additions and 183 deletions.
4 changes: 4 additions & 0 deletions static/docs/user/main/_sources/bind_paths_and_mounts.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,10 @@ wish to distribute in an image file that allows read/write:
--mount type=bind,src=inputs.img,dst=/input-data,image-src=/ \
mycontainer.sif
By default for security reasons the ext3 format is only supported in
unprivileged user namespace mode, so unless that default is changed a
``-u/--userns`` option may be needed with a setuid-root installation.

SquashFS Image Files
====================

Expand Down
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ SEE ALSO
* :ref:`apptainer verify <apptainer_verify>` - Verify cryptographic signatures attached to an image
* :ref:`apptainer version <apptainer_version>` - Show the version for Apptainer

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_build.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -183,4 +183,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_cache.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ SEE ALSO

* :ref:`apptainer cache <apptainer_cache>` - Manage the local cache

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO

* :ref:`apptainer cache <apptainer_cache>` - Manage the local cache

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -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 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ SEE ALSO

* :ref:`apptainer capability <apptainer_capability>` - Manage Linux capabilities for users and groups

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* :ref:`apptainer capability <apptainer_capability>` - Manage Linux capabilities for users and groups

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ SEE ALSO

* :ref:`apptainer capability <apptainer_capability>` - Manage Linux capabilities for users and groups

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* :ref:`apptainer capability <apptainer_capability>` - Manage Linux capabilities for users and groups

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -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 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`apptainer checkpoint <apptainer_checkpoint>` - Manage container checkpoint state (experimental)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer checkpoint <apptainer_checkpoint>` - Manage container checkpoint state (experimental)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`apptainer checkpoint <apptainer_checkpoint>` - Manage container checkpoint state (experimental)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`apptainer checkpoint <apptainer_checkpoint>` - Manage container checkpoint state (experimental)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -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 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ SEE ALSO

* :ref:`apptainer config <apptainer_config>` - Manage various apptainer configuration (root user only)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ SEE ALSO

* :ref:`apptainer config <apptainer_config>` - Manage various apptainer configuration (root user only)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -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 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_exec.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ Enterprise Performance Computing (EPC)
* :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 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ SEE ALSO

* :ref:`apptainer instance <apptainer_instance>` - Manage containers running as services

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,4 @@ SEE ALSO

* :ref:`apptainer instance <apptainer_instance>` - Manage containers running as services

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* :ref:`apptainer instance <apptainer_instance>` - Manage containers running as services

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ SEE ALSO

* :ref:`apptainer instance <apptainer_instance>` - Manage containers running as services

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_key.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Enterprise Performance Computing (EPC)
* :ref:`apptainer key remove <apptainer_key_remove>` - Remove a local public key from your local or the global keyring
* :ref:`apptainer key search <apptainer_key_search>` - Search for keys on a key server

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

* :ref:`apptainer key <apptainer_key>` - Manage OpenPGP keys

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_oci.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Enterprise Performance Computing (EPC)
* :ref:`apptainer oci umount <apptainer_oci_umount>` - Umount delete bundle (root user only)
* :ref:`apptainer oci update <apptainer_oci_update>` - Update container cgroups resources (root user only)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* :ref:`apptainer oci <apptainer_oci>` - Manage OCI containers

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)
* :ref:`apptainer overlay create <apptainer_overlay_create>` - Create EXT3 writable overlay image

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ SEE ALSO

* :ref:`apptainer overlay <apptainer_overlay>` - Manage an EXT3 writable overlay image

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Enterprise Performance Computing (EPC)
* :ref:`apptainer plugin list <apptainer_plugin_list>` - List installed Apptainer plugins
* :ref:`apptainer plugin uninstall <apptainer_plugin_uninstall>` - Uninstall removes the named plugin from the system

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`apptainer plugin <apptainer_plugin>` - Manage Apptainer plugins

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_pull.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
2 changes: 1 addition & 1 deletion static/docs/user/main/_sources/cli/apptainer_push.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ Enterprise Performance Computing (EPC)
* :ref:`apptainer remote status <apptainer_remote_status>` - Check the status of the apptainer services at an endpoint, and your authentication token
* :ref:`apptainer remote use <apptainer_remote_use>` - Set an Apptainer remote endpoint to be actively used

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* :ref:`apptainer remote <apptainer_remote>` - Manage apptainer remote endpoints, keyservers and OCI/Docker registry credentials

*Auto generated by spf13/cobra on 13-Apr-2023*
*Auto generated by spf13/cobra on 25-Apr-2023*
Loading

0 comments on commit 0453ffc

Please sign in to comment.