Skip to content

Commit

Permalink
Remove references to Prune (#595)
Browse files Browse the repository at this point in the history
* remove references to Prune

* revert to prune

* revert

* Update use-rewards-api.md

* edit

* update doc

* Update migrate-database.md

* Update

* add link

---------

Co-authored-by: m4sterbunny <[email protected]>
  • Loading branch information
joaniefromtheblock and m4sterbunny authored Sep 3, 2024
1 parent 8c2f944 commit 7a15092
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 18 deletions.
13 changes: 7 additions & 6 deletions docs/how-to/migrate-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ sidebar_position: 10

# Migrate the database

As of v21.5.0, new Teku installations use a LevelDB2 database. Previous Teku versions use RocksDB which continues to be supported.
Teku version 21.5.0 and later use LevelDB2 as the default database for new installations.
Earlier Teku versions use RocksDB. Teku continues to support RocksDB in all versions.

LevelDB2 databases use less memory and proves to be more stable with Teku.

:::caution

We recommend Teku nodes running in [archive mode] use the [automatic migration](#automatic-migration) method, and Teku nodes running in [prune mode] use the [manual migration](#manual-migration).
We recommend Teku nodes running in [`archive` mode] use the [automatic migration](#automatic-migration) method, and Teku nodes running in [`prune` mode] use the [manual migration](#manual-migration).

:::

Expand Down Expand Up @@ -56,15 +57,15 @@ If migration fails, resolve any issues and retry. Contact support on the [Teku D

## Manual migration

Users can manually migrate Teku nodes running a RocksDB database to a LevelDB2 database if the Teku node runs in [prune mode].
Users can manually migrate Teku nodes running a RocksDB database to a LevelDB2 database if the Teku node runs in [`prune` mode].

:::caution

Teku nodes running in [archive mode] must resynchronize from genesis to migrate. Use the [automatic migration](#automatic-migration) to migrate Teku nodes running in [archive mode].

:::

To migrate a RocksDB database in [prune mode] to a LevelDB2 database:
To migrate a RocksDB database in [`prune` mode] to a LevelDB2 database:

1. [Download the latest finalized state] from a beacon node:

Expand Down Expand Up @@ -95,7 +96,7 @@ Teku creates a LevelDB2 database, and starts from the specified recent state. Te
<!-- links -->

[Download the latest finalized state]: https://consensys.github.io/teku/#operation/getEthV1DebugBeaconStatesWithState_id
[prune mode]: ../reference/cli/index.md#data-storage-mode
[archive mode]: ../reference/cli/index.md#data-storage-mode
[`prune` mode]: ../reference/cli/index.md#data-storage-mode
[`archive` mode]: ../reference/cli/index.md#data-storage-mode
[supply the finalized checkpoint state]: ../get-started/checkpoint-start.md
[Teku Discord channel]: https://discord.com/invite/consensys
4 changes: 2 additions & 2 deletions docs/how-to/use-rewards-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following limitations apply:

- The rewards API relies on state and block data to retrieve the reward information, meaning you'll receive limited data if the beacon node being queried is not an archive node.

- You can only query blocks from finalized to head if you are in `prune` storage mode.
- You can only query blocks from finalized to head if you are not using `archive` storage mode.

## Impact of data storage modes

Expand Down Expand Up @@ -146,4 +146,4 @@ curl -X POST \
}
```
</TabItem>
</Tabs>
</Tabs>
4 changes: 3 additions & 1 deletion docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -428,9 +428,11 @@ data-storage-mode: "archive"

The strategy for handling historical chain data. Valid options are:

- `archive` - Stores all blocks and states.

- `minimal` - Stores the minimal required data to follow the chain and run validators. Finalized states and historic blocks are pruned.

- `prune` - Stores all blocks, but finalized states are pruned.
- `archive` - Stores all blocks and states.

The default is `minimal`.

Expand Down
18 changes: 9 additions & 9 deletions docs/reference/cli/subcommands/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ data-storage-archive-frequency: 1028

Set the frequency (in slots) at which to store finalized states to disk. The default is 2048.

This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `prune`.
This option is ignored if [`--data-storage-mode`](#data-storage-mode) is set to `minimal`.

:::note

Expand Down Expand Up @@ -200,7 +200,7 @@ data-storage-mode: "archive"
</TabItem>
</Tabs>

Set the strategy for handling historical chain data. Valid options are `minimal`, `prune` and `archive`. The default is `prune`.
Set the strategy for handling historical chain data. Valid options are `archive`, `minimal` and `prune`. The default is [`minimal`](#data-storage-mode).

#### `data-validator-path`

Expand Down Expand Up @@ -507,7 +507,7 @@ data-storage-mode: "archive"
</TabItem>
</Tabs>

Set the strategy for handling historical chain data. Valid options are `minimal`, `prune` and `archive`. The default is `minimal`.
Set the strategy for handling historical chain data. Valid options are `archive`, `minimal`, and `prune`. The default is `minimal`.

#### `data-validator-path`

Expand Down Expand Up @@ -619,11 +619,11 @@ Possible values are:
| Network | Chain | Type | Description |
| --- | --- | --- | --- |
| `mainnet` | Consensus layer | Production | Main network |
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `sepolia` | Consensus layer | Test | Multi-client testnet |
| `chiado` | Consensus layer | Test | Gnosis [testnet](https://docs.gnosischain.com/about/networks/chiado/) |
| `lukso` | Consensus layer | Production | Network for the [Lukso chain](https://lukso.network/) |
| `minimal` | Consensus layer | Test | Used for local testing and development networks |
| `gnosis` | Consensus layer | Production | Network for the [Gnosis chain](https://www.gnosis.io/) |
| `holesky` | Consensus layer | Test | Multi-client testnet |
| `sepolia` | Consensus layer | Test | Multi-client testnet |
| `chiado` | Consensus layer | Test | Gnosis [testnet](https://docs.gnosischain.com/about/networks/chiado/) |
| `lukso` | Consensus layer | Production | Network for the [Lukso chain](https://lukso.network/) |

Predefined networks can provide defaults such the initial state of the network, bootnodes, and the address of the deposit contract.

0 comments on commit 7a15092

Please sign in to comment.