Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VReplication Workflow command: Allow stop/start on specific shards #17581

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Jan 20, 2025

Description

While importing from massive external databases into a sharded Vitess cluster with multiple shards, the initial load from multiple copy phases is significant. Right now we don't have the ability to stop or start a workflow on a subset of shards. Allowing this feature will allow us to

  • create a workflow with auto-start=false
  • run workflows on limited number of shards to reduce load on the external database

This PR adds the ability to stop/start shards by passing the --shards flag.

Note

We were already accepting --shards but it was being ignored.

Related issues

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

@rohit-nayak-ps rohit-nayak-ps added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication labels Jan 20, 2025
Copy link
Contributor

vitess-bot bot commented Jan 20, 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 Jan 20, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 20, 2025
@rohit-nayak-ps rohit-nayak-ps removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Jan 20, 2025
Copy link

codecov bot commented Jan 20, 2025

Codecov Report

Attention: Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.

Project coverage is 67.68%. Comparing base (99856a2) to head (3b83410).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...tctldclient/command/vreplication/workflow/state.go 0.00% 4 Missing ⚠️
go/vt/vtctl/workflow/server.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17581      +/-   ##
==========================================
- Coverage   67.69%   67.68%   -0.01%     
==========================================
  Files        1586     1586              
  Lines      255403   255409       +6     
==========================================
- Hits       172883   172875       -8     
- Misses      82520    82534      +14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review January 20, 2025 22:31
@rohit-nayak-ps rohit-nayak-ps requested review from shlomi-noach and removed request for harshit-gangal January 20, 2025 23:15
@rohit-nayak-ps rohit-nayak-ps force-pushed the rohit/stop-start-shards branch from f3e1f5a to 3b83410 Compare January 22, 2025 18:22
@rohit-nayak-ps rohit-nayak-ps merged commit 55b6865 into vitessio:main Jan 22, 2025
106 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the rohit/stop-start-shards branch January 22, 2025 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VReplication Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow stopping and starting specific shards for VReplication workflows
3 participants