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: Support reversing read-only traffic in vtctldclient #16920

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Oct 8, 2024

Description

This PR fixes a bug in vtctldclient, in that it did not support a needed feature that the legacy vtctlclient did (see the client transition docs). Specifically, support for using ReverseTraffic when traffic for read-only tablet types (REPLICA, RDONLY) have been switched BUT writes (PRIMARY tablet type) have not.

Using the manual test from below, this fails with vtctldclient but works with vtctlclient:

❯ vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer reversetraffic --tablet-types "rdonly,replica"
E1009 20:59:35.000461   35915 main.go:56] rpc error: code = Unknown desc = no streams found in keyspace commerce for commerce2customer_reverse

❯ vtctlclient MoveTables -- reversetraffic customer.commerce2customer --tablet_types "rdonly,replica"
W1008 19:45:47.734875   67717 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess/examples/local]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
reversetraffic was successful for workflow customer.commerce2customer
Start State: All Reads Switched. Writes Not Switched
Current State: Reads Not Switched. Writes Not Switched

I think that it makes sense to backport this at least to v21 and v20 so that this is addressed in a minimum of 1 GA branches/releases.

Manual test

alias vtctldclient='command vtctldclient --server=localhost:15999'
cd examples/local

./101_initial_cluster.sh; mysql < ../common/insert_commerce_data.sql; ./201_customer_tablets.sh; ./202_move_tables.sh; ./203_switch_reads.sh

echo -e "\nReversing traffic for reads..."
vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer reversetraffic --tablet-types "rdonly,replica"
echo

With the client command output on the PR branch being:

Reversing traffic for reads...
ReverseTraffic was successful for workflow customer.commerce2customer

Start State: All Reads Switched. Writes Not Switched
Current State: Reads Not Switched. Writes Not Switched

Related Issue(s)

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

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord added Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication labels Oct 8, 2024
Copy link
Contributor

vitess-bot bot commented Oct 8, 2024

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 Oct 8, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 8, 2024
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord removed NeedsWebsiteDocsUpdate What it says 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 Oct 9, 2024
Copy link

codecov bot commented Oct 9, 2024

Codecov Report

Attention: Patch coverage is 74.28571% with 9 lines in your changes missing coverage. Please review.

Project coverage is 69.42%. Comparing base (056afc9) to head (fbd7ad6).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtctl/workflow/server.go 71.87% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16920      +/-   ##
==========================================
- Coverage   69.45%   69.42%   -0.04%     
==========================================
  Files        1570     1570              
  Lines      203631   203876     +245     
==========================================
+ Hits       141441   141537      +96     
- Misses      62190    62339     +149     

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

@mattlord mattlord removed the Type: Enhancement Logical improvement (somewhere between a bug and feature) label Oct 10, 2024
@mattlord mattlord changed the title VReplication: Improve handling when only reads are switched VReplication: Support reversing read-only traffic in vtctldclient Oct 10, 2024
@mattlord mattlord added Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 and removed Backport to: release-20.0 Needs to be backport to release-20.0 NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work labels Oct 10, 2024
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-20.0 Needs to be backport to release-20.0 Backport to: release-21.0 Needs to be backport to release-21.0 Component: VReplication Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: ReverseTraffic for only replica and rdonly tablet types
1 participant