[restatectl] metadata migrate command #4065
Open
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
Summary: In this PR we add support to migrate to a new metadata store Includes: - Introduce `--metadata-migration-mode`. For the migration to pass, all nodes must be started with this mode set. This mode makes sure the cluster metadata becomes immutable during the migration process. This of course implies a downtime. - Introduce the Admi API to do the migration. The migration process first - Sanity check of the cluster state, makes sure all alive nodes are running with proper migration mode - Creates a client instance of the target store - Copies all well know metadata keys from current to target store Fixes restatedev/internal#76
Summary: A CLI interface to the metadata migration API. - Accepts new metadata store config with either --toml or --json flags - Run the migration against the API
tillrohrmann
approved these changes
Nov 26, 2025
Contributor
tillrohrmann
left a comment
tillrohrmann
left a comment
There was a problem hiding this comment.
Thanks a lot for exposing the metadata migration via restatectl @muhamadazmy. The changes look good to me. I left a few minor comments. +1 for merging if you've tested things (e.g. from replicated to DynamoDB).
| (Some(json), None) => serde_json::from_reader(json.clone().into_reader()?) | ||
| .context("Failed to load provider config from json input")?, | ||
| (None, Some(toml_input)) => toml::from_str(toml_input.clone().contents()?.as_str()) | ||
| .context("Failed to load provider config from json input")?, |
Comment on lines
+639
to
+641
| pub fn iter(&self) -> impl Iterator<Item = (&AdvertisedAddress<FabricPort>, &SimpleStatus)> { | ||
| self.node_status.iter().map(|a| (&a.0, &a.1)) | ||
| } |
Contributor
There was a problem hiding this comment.
Are you using this method anywhere in the PR?
Comment on lines
+34
to
+40
| /// The TOML configuration of the target metadata store | ||
| #[arg(long)] | ||
| toml: Option<FileOrStdin>, | ||
|
|
||
| /// The Json configuration of the target metadata store | ||
| #[arg(long, conflicts_with = "toml")] | ||
| json: Option<FileOrStdin>, |
Contributor
There was a problem hiding this comment.
Should we stick with one way to provide the configuration? Otherwise, we give users different ways to do the same thing and we need to explain how to specify MetadataClientOptions in json and in toml. Maybe sticking with toml is the easiest since users already use it when configuring Restate via the config.toml?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[restatectl] metadata migrate command
Summary:
A CLI interface to the metadata migration API.
Stack created with Sapling. Best reviewed with ReviewStack.