Skip to content

Commit 9e9396a

Browse files
Merge pull request #1546 from oasisprotocol/martin/fix/graceful-shutdown
docs/node/run-your-node/maintenance: Fix graceful shutdown
2 parents c554ba9 + 1ef4e23 commit 9e9396a

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/node/run-your-node/maintenance/shutting-down-a-node.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# Shutting Down a Node
22

3-
When a node registers for an epoch, it is committing to being available
4-
to service requests for the entire epoch. Due to this availability
5-
commitment, validator and non-client paratime nodes must be shutdown
3+
Depending on the role (e.g. validator), a node may periodically register itself
4+
to the consensus registry, committing itself to serve requests until the
5+
expiration epoch. Due to this availability commitment, nodes must be shutdown
66
gracefully to avoid network disruption.
77

8-
The graceful shutdown process involves the following steps:
8+
To have the node gracefully shutdown:
99

1010
1. Ensure your service manager (e.g. systemd) will not restart the node after
1111
exit. Otherwise the node may re-register on startup and you will need to wait
12-
another epoch for it to expire.
13-
2. Halt the automatic re-registration.
14-
3. Wait for the node's existing registration to expire.
15-
4. Terminate the node binary.
16-
17-
To have the node gracefully shutdown, run:
12+
again.
13+
2. Run one of the commands below:
1814

1915
```bash
2016
# Issue a graceful shutdown request.
2117
oasis-node control shutdown
2218

2319
# Issue a graceful shutdown request, and block until the node terminates.
24-
# Note: This can take up to a full epoch to complete.
20+
# Note: This can take up to 3 full epochs to complete, because the node
21+
# registers each epoch for the next 2 epochs (inclusive).
2522
oasis-node control shutdown \
2623
--wait
27-
````
24+
```
25+
26+
Internally, the command will halt the automatic re-registration, wait for the
27+
node's existing registration to expire and terminate the node binary. If the
28+
node is not registered (e.g. non-validator or paratime client node) this command
29+
will immediately terminate the node binary.
2830

2931
:::caution
3032

0 commit comments

Comments
 (0)