Skip to content

Commit

Permalink
[Doc] indicate the pruning config suitable for validators (MystenLabs…
Browse files Browse the repository at this point in the history
…#17526)

## Description 

Some validators see to have issues with pruning after epoch change as
well.

## Test plan 

👀

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:

---------

Co-authored-by: ronny-mysten <[email protected]>
  • Loading branch information
mwtian and ronny-mysten authored May 6, 2024
1 parent 26d811e commit a89d3e7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/content/guides/operator/data-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ If the information about the transaction digest, effects, events, or checkpoints

Use the examples in this section to configure your Sui Full node. You can copy the examples, and then, optionally, modify the values as appropriate for your environment.

### Minimal Full node
### Validator and minimal Full node

This configuration keeps disk usage to a minimum. A Full node with this configuration cannot answer queries that require indexing or historic data.
This configuration keeps disk usage to a minimum. It is suitable for most validators. A Full node with this configuration cannot answer queries that require indexing or historic data.

```yaml
# Do not generate or maintain indexing of Sui data on the node
Expand All @@ -115,7 +115,7 @@ authority-store-pruning-config:
max-transactions-in-batch: 1000
# end of default values

# Prune historic object versions
# Prune historic object versions as soon as possible.
num-epochs-to-retain: 0
# Prune historic transactions of the past epochs
num-epochs-to-retain-for-checkpoints: 2
Expand All @@ -124,7 +124,7 @@ authority-store-pruning-config:
smooth: true
```
### Full Node with indexing but no history
### Full node with indexing but no history
This setup manages secondary indexing in addition to the latest state, but aggressively prunes historic data. A Full node with this configuration:
Expand All @@ -151,7 +151,7 @@ authority-store-pruning-config:
smooth: true
```

### Full Node with full object history but pruned transaction history
### Full node with full object history but pruned transaction history

This configuration manages the full object history while still pruning historic transactions. A Full node with this configuration can answer all historic and indexing queries (using the transaction query fallback for transactional data), including the ones that require historic objects such as the `showBalanceChanges` filter of `sui_getTransactionBlock()`.

Expand Down

0 comments on commit a89d3e7

Please sign in to comment.