This repository was archived by the owner on Nov 12, 2025. It is now read-only.
Add snapshot configuration links and examples to cluster pages #555
Conversation
This file contains hidden or 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
pcholakov
force-pushed
the
expand-snapshots-docs-examples
branch
from
6dcac1a to
03acdec
Compare
Deploying documentation with
|
| Latest commit: |
4c7473b
|
| Status: | ⚡️ Build in progress... |
pcholakov
force-pushed
the
expand-snapshots-docs-examples
branch
from
03acdec to
a382e2a
Compare
tillrohrmann
approved these changes
Mar 3, 2025
Contributor
tillrohrmann
left a comment
tillrohrmann
left a comment
There was a problem hiding this comment.
Thanks for updating our documentation to instruct users to use snapshotting and how to set up minio @pcholakov. LGTM. +1 for merging :-)
|
|
||
| <Admonition type="caution"> | ||
| Snapshots are essential to support safe log trimming and also allow you to set partition replication to a subset of all cluster nodes, while still allowing for fast partition fail-over to to any live node. Snapshots are also necessary to add more nodes in the future. | ||
| </Admonition> |
| If you plan to scale your cluster over time, we strongly recommend enabling snapshotting. | ||
| Without it, newly added nodes may not be fully utilized by the system. | ||
| See the [snapshotting documentation](/operate/data-backup#snapshotting) for more details. | ||
| See the [snapshotting documentation](/operate/snapshots) for more details. |
Comment on lines
+37
to
+43
| RESTATE_WORKER__SNAPSHOTS__DESTINATION: "s3://restate/snapshots" | ||
| RESTATE_WORKER__SNAPSHOTS__SNAPSHOT_INTERVAL_NUM_RECORDS: "1000" | ||
| RESTATE_WORKER__SNAPSHOTS__AWS_REGION: "local" | ||
| RESTATE_WORKER__SNAPSHOTS__AWS_ENDPOINT_URL: "http://minio:9000" | ||
| RESTATE_WORKER__SNAPSHOTS__AWS_ALLOW_HTTP: true | ||
| RESTATE_WORKER__SNAPSHOTS__AWS_ACCESS_KEY_ID: "minioadmin" | ||
| RESTATE_WORKER__SNAPSHOTS__AWS_SECRET_ACCESS_KEY: "minioadmin" |
Contributor
There was a problem hiding this comment.
I assume that nothing changes here when merging restatedev/restate#2796, right?
Contributor
Author
There was a problem hiding this comment.
No, these all stay as-is -- #2796 is all about making the same functionality available under the RESTATE_METADATA_CLIENT__ prefix :-)
We want to steer users towards always using a snapshot repository. - expand Docker Compose example with Minio - update all cluster references to link to the snapshots page - add strong recommendation to always use snapshots for clusters
pcholakov
force-pushed
the
expand-snapshots-docs-examples
branch
from
a4c3d57 to
7a6ac6f
Compare
Contributor
Author
|
Thanks for the review @tillrohrmann, I'll merge these now and help out with the conflicts under #547. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We want to steer users towards always using a snapshot repository.