This repository was archived by the owner on Nov 12, 2025. It is now read-only.
Update cluster migration guide for 1.4.0#633
Merged
Conversation
Deploying documentation with
|
| Latest commit: |
f0555aa
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://dc4a7fcc.documentation-beg.pages.dev |
| Branch Preview URL: | https://pavel-nwulrkrtklky.documentation-beg.pages.dev |
AhmedSoliman
previously requested changes
Jun 23, 2025
Contributor
AhmedSoliman
left a comment
AhmedSoliman
left a comment
There was a problem hiding this comment.
A few nits but generally pretty good.
docs/guides/local-to-replicated.mdx
Outdated
| </Admonition> | ||
|
|
||
| This guide assumes you have a running single-node Restate server that uses the local loglet and local metadata server. | ||
| This guide shows how to scale an existing single-node deployment to a multi-node cluster. It assumes you have a running single-node Restate server that is running the replicated loglet and replicated metadata server, which are enabled by default in Restate >= 1.4.0. |
Contributor
There was a problem hiding this comment.
I think all mentions of versions should be prefixed by v. (v1.4.0 vs. 1.4.0).
docs/guides/local-to-replicated.mdx
Outdated
| <Step stepLabel="2" title="Verify that node is running the replicated loglet"> | ||
|
|
||
| To be able to use the replicated loglet, make sure the node includes the `log-server` role if you configure the roles explicitly. | ||
| The default configuration does not require adjustments to be cluster-ready. However, if you have explicitly specified which roles to run, you should make sure the configuration includes the `log-server` role. Similarly, make sure that you do not explicitly set the loglet provider type to `local`. While the local logelt is still supported, the default type is `replicated` starting from 1.4.0. Without these settings, the automatic loglet type migration will not take place. |
Contributor
There was a problem hiding this comment.
Suggested change
| The default configuration does not require adjustments to be cluster-ready. However, if you have explicitly specified which roles to run, you should make sure the configuration includes the `log-server` role. Similarly, make sure that you do not explicitly set the loglet provider type to `local`. While the local logelt is still supported, the default type is `replicated` starting from 1.4.0. Without these settings, the automatic loglet type migration will not take place. | |
| The default configuration does not require adjustments to be cluster-ready. However, if you have explicitly specified which roles to run, you should make sure the configuration includes the `log-server` role. Similarly, make sure that you do not explicitly set the loglet provider type to `local`. While the local loglet is still supported, the default type is `replicated` starting from 1.4.0. Without these settings, the automatic loglet type migration will not take place. |
Contributor
There was a problem hiding this comment.
Btw. The migration will happen if default-provider is unset or the whole bifrost stanza is removed. I suggest we remove the requirement of specifying it and only mention it if they already have a configuration file.
Contributor
Author
There was a problem hiding this comment.
I tried to capture the nuance better - let me know if the new version reads better!
docs/guides/local-to-replicated.mdx
Outdated
| type = "replicated" | ||
| ```toml restate.toml | ||
| [metadata-client] | ||
| addresses = ["NODE_1_ADVERTISED_ADDRESS", "NODE_2_ADVERTISED_ADDRESS", "NODE_3_ADVERTISED_ADDRESS"] |
Contributor
There was a problem hiding this comment.
maybe an actual example instead of placeholders?
pcholakov
force-pushed
the
pavel/nwulrkrtklky
branch
3 times, most recently
from
4c0464b to
93f1b99
Compare
pcholakov
force-pushed
the
pavel/nwulrkrtklky
branch
2 times, most recently
from
37cbd48 to
073a1d2
Compare
pcholakov
force-pushed
the
pavel/nwulrkrtklky
branch
from
073a1d2 to
f0555aa
Compare
AhmedSoliman
approved these changes
Jun 23, 2025
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Follow up to restatedev/restate#3410 - specific to 1.4.0, will merge only when we're updating the docs for the release.