Skip to content

Commit

Permalink
flux-start(1): document --recovery
Browse files Browse the repository at this point in the history
Problem: flux-start(1) does not document the --recovery option.

Add an entry in the option table, and an example.
  • Loading branch information
garlick committed Nov 28, 2022
1 parent b34688a commit 49f0939
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/man1/flux-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ OPTIONS
``per-broker``, each broker is placed in its own clique.
Default: ``single``.

**-r, --recovery**\ =\ *[STATEDIR]*
Start the rank 0 broker of an instance in recovery mode. If *statedir*
is unspecified, ``/var/lib/flux`` is assumed and the system instance
configuration is sourced. Any rc1 errors are ignored, broker peers are
not allowed to connect, and resources are offline during recovery. An
initial program is started in which repairs can be made.

VERBOSITY LEVELS
================

Expand Down Expand Up @@ -123,6 +130,18 @@ shell as the initial program:

srun --pty -N8 flux start

Start the system instance rank 0 broker in recovery mode:

::

sudo -u flux flux start --recovery

Start a non-system instance in recovery mode:

::

flux start --recovery=/tmp/statedir


RESOURCES
=========
Expand Down
1 change: 1 addition & 0 deletions doc/test/spell.en.pws
Original file line number Diff line number Diff line change
Expand Up @@ -666,3 +666,4 @@ sigpending
chunksize
taskmap
multiline
sudo

0 comments on commit 49f0939

Please sign in to comment.