Skip to content

Commit 23f348f

Browse files
authored
Merge pull request #34 from oasisprotocol/yawning/node-shutdown
run-a-node: Document the clean shutdown procedure
2 parents 8acdae2 + c24f0f1 commit 23f348f

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Shutting Down a Node
2+
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
6+
gracefully to avoid network disruption.
7+
8+
The graceful shutdown process involves the following steps:
9+
10+
1. Halt the automatic re-registration.
11+
2. Wait for the node's existing registration to expire.
12+
3. Terminate the node binary.
13+
14+
To have the node gracefully shutdown, run:
15+
16+
```bash
17+
# Request a graceful shutdown, and exit as soon as the request is issued.
18+
oasis-node control shutdown
19+
20+
# Request a graceful shutdown, and wait for the node to terminate.
21+
# Note: This can take up to a full epoch to complete.
22+
oasis-node control shutdown \
23+
--wait
24+
````
25+
26+
:::caution
27+
28+
Failure to gracefully shutdown the node may result in the node being
29+
frozen (and potentially stake being slashed) due to the node being
30+
unavailable to service requests in an epoch that it is registered.
31+
32+
:::

0 commit comments

Comments
 (0)