Skip to content

Conversation

cody-littley
Copy link
Contributor

Why are these changes needed?

Create more detailed documentation on configuring database paths.

@cody-littley cody-littley requested review from dmanc and litt3 May 30, 2025 14:11
@cody-littley cody-littley self-assigned this May 30, 2025
@cody-littley cody-littley changed the title Created documentation for database path configuration. chore: documentation for database path configuration May 30, 2025
Signed-off-by: Cody Littley <[email protected]>
Signed-off-by: Cody Littley <[email protected]>
Signed-off-by: Cody Littley <[email protected]>
will store its data like this:

```
${NODE_DB_PATH}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you mentioned I can see directories like below,

${NODE_DB_PATH}
.
├── chunk
└── chunk_v2_litt
    └── chunks
        ├── keymap
        │   └── data
        └── segments

Do you think it would help clarify things if you point out the chunk directory, which appears to be used for V1?

Copy link
Contributor Author

@cody-littley cody-littley Jun 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is described in the section above titled ## V1 Protocol.

## V1 Protocol

The V1 protocol's disk footprint looks something like this:

${NODE_DB_PATH}
├── chunk
│   ├── 000001.log
│   ├── CURRENT
│   ├── LOCK
│   ├── LOG
│   └── MANIFEST-000000

The `chunk` directory is created by the V1 software inside the directory specified by `NODE_DB_PATH`. Inside
the `chunk` directory are files maintained by the V1 data storage engine (i.e. `LevelDB`).

litt3
litt3 previously approved these changes Jun 2, 2025

## Adding a Path

It's possible to add additional paths to `NODE_LITT_DB_STORAGE_PATHS`. This might be useful if want to add
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be useful if you want

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

dmanc
dmanc previously approved these changes Jun 2, 2025
you want to store the V2 data. For example, if you want to store the V2 data in `${volume1}`, then you would
do `mv ${NODE_DB_PATH}/chunk_v2_litt/ ${volume1}/`.

- Stop the validator node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't the validator get ejected if this procedure took longer than the SLA for signing (how likely is that)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I'm not sure how long the window is. Presumably operators will need to restart their nodes every once in a while for maintenance purposes, so we should have a little bit of a grace period baked into ejection.

LittDB doesn't take long to load from disk, so hopefully it's possible to do this sort of restart very rapidly. Although this is something I don't think we've specifically measured yet.

Signed-off-by: Cody Littley <[email protected]>
@cody-littley cody-littley dismissed stale reviews from dmanc and litt3 via b2b2249 June 3, 2025 14:07
@dmanc dmanc merged commit 3e670ff into master Jun 4, 2025
16 checks passed
@dmanc dmanc deleted the database-paths branch June 4, 2025 21:44
hopeyen pushed a commit that referenced this pull request Jun 5, 2025
* Created documentation for database path configuration.

Signed-off-by: Cody Littley <[email protected]>

* formatting

Signed-off-by: Cody Littley <[email protected]>

* formatting

Signed-off-by: Cody Littley <[email protected]>

* grammar

Signed-off-by: Cody Littley <[email protected]>

* made suggested change

Signed-off-by: Cody Littley <[email protected]>

---------

Signed-off-by: Cody Littley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants