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 Jul 12, 2024
1 parent c79cc0e commit a541601
Show file tree
Hide file tree
Showing 213 changed files with 255 additions and 255 deletions.
22 changes: 11 additions & 11 deletions public/docs/user/main/_sources/appendix.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ Docker images are comprised of layers that are assembled at runtime to
create an image. You can use Docker layers to create a base image, and
then add your own custom software. For example, you might use Docker's
Ubuntu image layers to create an Ubuntu {Project} container. You
could do the same with CentOS, Debian, Arch, Suse, Alpine, BusyBox, etc.
could do the same with Fedora, Debian, Arch, Suse, Alpine, BusyBox, etc.

Or maybe you want a container that already has software installed. For
instance, maybe you want to build a container that uses CUDA and cuDNN
Expand Down Expand Up @@ -809,13 +809,13 @@ the new image during bootstrap.

.. _sec:build-yum:

This module allows you to build a Red Hat/CentOS/Scientific Linux style
container from a mirror URI.
This module allows you to build a Red Hat style
container from a mirror URI based on yum or dnf.

Overview
--------

Use the ``yum`` module to specify a base for a CentOS-like container.
Use the ``yum`` module to specify a base for a RHEL-like container.
You must also specify the URI for the mirror you would like to use.

Keywords
Expand All @@ -830,29 +830,29 @@ module to use.

.. code:: {command}

OSVersion: 7
OSVersion: 9

The OSVersion keyword is optional. It specifies the OS version you would
like to use. It is only required if you have specified a %{OSVERSION}
variable in the ``MirrorURL`` keyword.

.. code:: {command}

MirrorURL: http://mirror.centos.org/centos-%{OSVERSION}/%{OSVERSION}/os/$basearch/
MirrorURL: http://repo.almalinux.org/almalinux/%{OSVERSION}/BaseOS/x86_64/os

The MirrorURL keyword is mandatory. It specifies the URI to use as a
mirror to download the OS. If you define the ``OSVersion`` keyword, then
you can use it in the URI as in the example above.

.. code:: {command}

Include: yum
Include: dnf

The Include keyword is optional. It allows you to install additional
packages into the core operating system. It is a best practice to supply
only the bare essentials such that the ``%post`` section has what it
needs to properly complete the build. One common package you may want to
install when using the ``yum`` build module is YUM itself.
install when using the ``yum`` build module is YUM or DNF itself.

Notes
-----
Expand All @@ -864,7 +864,7 @@ system. If the RPM implementation inside the container is not compatible
with the RPM database that was used to create the container, RPM and YUM
commands inside the container may fail. This issue can be easily
demonstrated by bootstrapping an older RHEL compatible image by a newer
one (e.g. bootstrap a Centos 6 container from a Centos 7 host).
one (e.g. bootstrap a RHEL 8 container from a RHEL 9 host).

In order to use the ``yum`` build module, you must have ``yum``
installed on your system. It may seem counter-intuitive to install YUM
Expand Down Expand Up @@ -939,11 +939,11 @@ like so:
$ sudo apt-get update && sudo apt-get install debootstrap
On CentOS you can install it from the epel repos like so:
On RHEL you can install it from the epel repos like so:

.. code::
$ sudo yum update && sudo yum install epel-release && sudo yum install debootstrap.noarch
$ sudo dnf update && sudo dnf install epel-release && sudo dnf install debootstrap.noarch
.. _build-arch:

Expand Down
2 changes: 1 addition & 1 deletion public/docs/user/main/_sources/cli/apptainer.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
2 changes: 1 addition & 1 deletion public/docs/user/main/_sources/cli/apptainer_build.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

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

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ SEE ALSO

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

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,4 @@ SEE ALSO

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

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ SEE ALSO

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

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ SEE ALSO

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

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
2 changes: 1 addition & 1 deletion public/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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ Enterprise Performance Computing (EPC)
* :ref:`apptainer keyserver logout <apptainer_keyserver_logout>` - Logout from a keyserver
* :ref:`apptainer keyserver remove <apptainer_keyserver_remove>` - Remove a keyserver (root user only)

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ SEE ALSO

* :ref:`apptainer keyserver <apptainer_keyserver>` - Manage apptainer keyservers

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`apptainer keyserver <apptainer_keyserver>` - Manage apptainer keyservers

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ SEE ALSO

* :ref:`apptainer keyserver <apptainer_keyserver>` - Manage apptainer keyservers

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`apptainer keyserver <apptainer_keyserver>` - Manage apptainer keyservers

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`apptainer keyserver <apptainer_keyserver>` - Manage apptainer keyservers

*Auto generated by spf13/cobra on 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
2 changes: 1 addition & 1 deletion public/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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
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 3-Jul-2024*
*Auto generated by spf13/cobra on 12-Jul-2024*
Loading

0 comments on commit a541601

Please sign in to comment.