Skip to content

Commit

Permalink
Merge pull request #785 from oasisprotocol/kostko/node-maint-graceful…
Browse files Browse the repository at this point in the history
…-shutdown

docs/node: Update graceful shutdown instructions
  • Loading branch information
kostko authored Apr 12, 2024
2 parents 79d242b + 6186bda commit 43c417a
Showing 1 changed file with 7 additions and 19 deletions.
26 changes: 7 additions & 19 deletions docs/node/run-your-node/maintenance/shutting-down-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ gracefully to avoid network disruption.

The graceful shutdown process involves the following steps:

1. Halt the automatic re-registration.
2. Wait for the node's existing registration to expire.
3. Terminate the node binary.
1. Ensure your service manager (e.g. systemd) will not restart the node after
exit. Otherwise the node may re-register on startup and you will need to wait
another epoch for it to expire.
2. Halt the automatic re-registration.
3. Wait for the node's existing registration to expire.
4. Terminate the node binary.

To have the node gracefully shutdown, run:

Expand All @@ -27,21 +30,6 @@ oasis-node control shutdown \

Failure to gracefully shutdown the node may result in the node being
frozen (and potentially stake being slashed) due to the node being
unavailable to service requests in an epoch that it is registered.
unavailable to service requests in an epoch that it is registered for.

:::

## Restarting a Shutdown Node

To prevent restart loops causes by service managers, and to ensure
that the node will shutdown when requested, the node will persist
a flag indicating that a shutdown is in progress.

Oasis nodes prior to 22.0.3 will require that once a node is gracefully
shutdown, the next time it is launched, the
`--worker.registration.force_register` command line argument or equivalent
config option be passed to the node the next time the node is started,
or the node will shutdown immediately.

This behavior has been changed in newer revisions of the software such
that the flag should no longer be required.

0 comments on commit 43c417a

Please sign in to comment.