merge formal snapshot and snapshots docs #15898
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Ignored Deployments
|
github-actions
bot
added
the
Type: Documentation
williampsmith
approved these changes
Jan 24, 2024
| 1. **Verifiability:** Formal snapshots have first-class support in the core Sui protocol. As such, they must be trustless/verifiable by the node operator upon download. To support this, the protocol signs a commitment to the live object state at end of epoch, which formal snapshots are checked against at restore time. If this verification fails, the node state is moved back to the state before the snapshot restore attempt. | ||
|
|
||
| Because these snapshots do not contain indexes, they are most immediately useful for validators and state sync Full nodes (SSFNs). You can upload snapshots to remote object stores like S3, Google Cloud Storage, Azure Blob Storage, and similar services. These services typically run the export process in the background so there is no degradation in performance for your Full node. With snapshots stored in the cloud, you can recover from catastrophic failures in your system or hardware more efficiently. | ||
|
|
||
| ## Enabling snapshots | ||
|
|
||
| Full nodes do not take snapshots by default. To enable this feature you must apply specific configs to your Full node. |
There was a problem hiding this comment.
Not sure why it won't let me write a comment below, but on line 48 can we rename to ### Enabling DB snapshots for consntsency?
There was a problem hiding this comment.
Also what are your thoughts on changing line 2 above to be DB Snapshots or Database Snapshots or Full Snapshots? I think part of the confusion has been the fact that "snapshots" is now ambiguous, so we should disambiguate in all cases, not just some.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
most of the info in the formal snapshot page is stale, this merges the two docs