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 Oct 21, 2024
1 parent cbce4c3 commit 6d50658
Show file tree
Hide file tree
Showing 202 changed files with 324 additions and 314 deletions.
87 changes: 45 additions & 42 deletions public/docs/user/main/_sources/checkpoint.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -99,45 +99,36 @@ state has been successfully restored upon restart.
.. code::
Bootstrap: docker
From: python:3.10-buster
From: python:3.10-bookworm
%post
mkdir /app
cat > /app/server.py <<EOF
import socketserver
import argparse
from http.server import BaseHTTPRequestHandler, HTTPServer
state = "0"
count = 0
parser = argparse.ArgumentParser(description='Optional app description')
parser.add_argument('port', type=int, help='A required integer port argument')
args = parser.parse_args()
class handler(BaseHTTPRequestHandler):
def do_GET(self):
self.send_response(200)
self.send_header('Content-type','text/plain')
self.end_headers()
self.wfile.write(bytes(state, "utf8"))
def do_POST(self):
self.send_response(200)
self.send_header('Content-type','text/plain')
self.end_headers()
global state
state = self.rfile.read(1).decode("utf8")
self.wfile.write(bytes(state, "utf8"))
with HTTPServer(('', args.port), handler) as server:
server.serve_forever()
class Handler(socketserver.BaseRequestHandler):
def handle(self):
global count
count += 1
response = bytes("request:{}\n".format(count), "ascii")
self.request.sendall(response)
if __name__ == "__main__":
with socketserver.TCPServer(('', args.port), Handler) as server:
server.allow_reuse_address = True
server.serve_forever()
EOF
%startscript
python3 /app/server.py $@
We can build this container using:

.. code::
Expand Down Expand Up @@ -168,21 +159,19 @@ the state of a variable on the server.

.. code::
$ curl localhost:8888; echo
0
$ curl --http0.9 localhost:8888
request:1
We can see that it is set to ``0`` by default when this application is started
normally. We can now update the state of the server from ``0`` to ``1`` with
the following ``POST`` request:
We can see that the request count value is ``1`` when this application is started
and accessed via curl. After making another call to the application, we can see that the request
count is ``2`` as expected.

.. code::
$ curl -X POST localhost:8888 -d '1'; echo
1
$ curl localhost:8888; echo
1
$ curl --http0.9 localhost:8888
request:2
Now that variable on our server is in a new state, ``1``, we can use the
Now that the request count variable on our server is in a new state, ``2``, we can use the
``checkpoint instance`` command and reference the instance via the
``instance://`` URI format:

Expand Down Expand Up @@ -210,14 +199,28 @@ our application's state:
INFO: instance started successfully
And now we can verify the variable on the server has been properly restored to
a value of ``1``, instead of the default of ``0``:
And now when we get access to the application again, the request count value is ``3`` as expected,
meaning that the previous request count value was ``2``.

.. code::
$ curl localhost:8888; echo
1
$ curl --http0.9 localhost:8888
$ request:3
We can repeat the previous two steps, i.e. stop the server instance and restart it via dmtcp to verify the restoration
of the value of the request count.

.. code::
$ {command} instance stop server
$ {command} instance start --dmtcp-restart example-checkpoint server.sif restarted-server 8888
Then access the application and see that the request count value is restored as expected.

.. code::
$ curl --http0.9 localhost:8888
$ request:3
Finally, we can stop our instance running our restored application and delete our
checkpoint if we no longer need it to restart our application from this state:
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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-2024*
3 changes: 2 additions & 1 deletion public/docs/user/main/_sources/cli/apptainer_build.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ Options

::

--authfile string Docker-style authentication file to use for writing/reading OCI registry credentials
-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
Expand Down Expand Up @@ -207,4 +208,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-2024*
3 changes: 2 additions & 1 deletion public/docs/user/main/_sources/cli/apptainer_exec.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Options
--allow-setuid allow setuid binaries in container (root only)
--app string set an application to run inside a container
--apply-cgroups string apply cgroups from file for container processes (root only)
--authfile string Docker-style authentication file to use for writing/reading OCI registry credentials
-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.
--blkio-weight int Block IO relative weight in range 10-1000, 0 to disable
--blkio-weight-device strings Device specific block IO relative weight
Expand Down Expand Up @@ -128,4 +129,4 @@ SEE ALSO
Linux container platform optimized for High Performance Computing (HPC) and
Enterprise Performance Computing (EPC)

*Auto generated by spf13/cobra on 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Options
--allow-setuid allow setuid binaries in container (root only)
--app string set an application to run inside a container
--apply-cgroups string apply cgroups from file for container processes (root only)
--authfile string Docker-style authentication file to use for writing/reading OCI registry credentials
-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.
--blkio-weight int Block IO relative weight in range 10-1000, 0 to disable
--blkio-weight-device strings Device specific block IO relative weight
Expand Down Expand Up @@ -145,4 +146,4 @@ SEE ALSO

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

*Auto generated by spf13/cobra on 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-2024*
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Options
--allow-setuid allow setuid binaries in container (root only)
--app string set an application to run inside a container
--apply-cgroups string apply cgroups from file for container processes (root only)
--authfile string Docker-style authentication file to use for writing/reading OCI registry credentials
-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.
--blkio-weight int Block IO relative weight in range 10-1000, 0 to disable
--blkio-weight-device strings Device specific block IO relative weight
Expand Down Expand Up @@ -140,4 +141,4 @@ SEE ALSO

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

*Auto generated by spf13/cobra on 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-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 5-Sep-2024*
*Auto generated by spf13/cobra on 21-Oct-2024*
Loading

0 comments on commit 6d50658

Please sign in to comment.