Skip to content

Conversation

@varundeepsaini
Copy link

@varundeepsaini varundeepsaini commented Dec 13, 2025

Description

Adds support for the --shards flag to the start and stop commands for MoveTables and Reshard VReplication workflows. This allows users to start or stop workflows on a specific subset of shards rather than all shards at once.

Related Issue(s)

Fixes: #18949

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

No deployment notes. This is a CLI enhancement with no database migrations or breaking changes.

AI Disclosure

This PR was authored with assistance from Claude.

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 13, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 13, 2025
@github-actions github-actions bot added this to the v24.0.0 milestone Dec 13, 2025
@promptless
Copy link
Contributor

promptless bot commented Dec 13, 2025

📝 Documentation updates detected!

New suggestion: Add --shards flag to MoveTables and Reshard start/stop commands

@promptless
Copy link
Contributor

promptless bot commented Dec 13, 2025

📝 Documentation updates detected!

New suggestion: Add changelog entry for VReplication --shards flag

Signed-off-by: Varun Deep Saini <[email protected]>
Copy link
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @varundeepsaini !

There's more work to be done on the client side -- as we're not passing the shards in the request:

// The only thing we're updating is the state.
req := &vtctldatapb.WorkflowUpdateRequest{
Keyspace: workflowOptions.Keyspace,
TabletRequest: &tabletmanagerdatapb.UpdateVReplicationWorkflowRequest{
Workflow: workflowUpdateOptions.Workflow,
Cells: textutil.SimulatedNullStringSlice,
TabletTypes: textutil.SimulatedNullTabletTypeSlice,
State: &state,
},
}

It's a different call path for workflow stop/start:

// The only thing we're updating is the state.
req := &vtctldatapb.WorkflowUpdateRequest{
Keyspace: baseOptions.Keyspace,
TabletRequest: &tabletmanagerdatapb.UpdateVReplicationWorkflowRequest{
Workflow: baseOptions.Workflow,
Cells: textutil.SimulatedNullStringSlice,
TabletTypes: textutil.SimulatedNullTabletTypeSlice,
State: &state,
Shards: shards,
},
}

We should also add some test coverage for this.

@mattlord mattlord added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: VReplication NeedsWebsiteDocsUpdate What it says Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: support per shard start/stop in the MoveTables and Reshard subcommands

2 participants