-
Notifications
You must be signed in to change notification settings - Fork 240
chore: documentation for database path configuration #1622
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Cody Littley <[email protected]>
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} |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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`).
node/database-paths.md
Outdated
|
||
## Adding a Path | ||
|
||
It's possible to add additional paths to `NODE_LITT_DB_STORAGE_PATHS`. This might be useful if want to add |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
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. |
There was a problem hiding this comment.
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)?
There was a problem hiding this comment.
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]>
* 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]>
Why are these changes needed?
Create more detailed documentation on configuring database paths.