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: Improve workflow cancel/delete #15977

Merged
merged 37 commits into from
Jun 12, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented May 20, 2024

Description

This work makes three key changes:

  1. Remove the workflow artifacts after removing the workflow record in Workflow Delete (this is used by the cancel sub-command in all of the workflows: MoveTables/Reshard, etc). Otherwise you can see unexpected query errors in the workflow against the table between when the table is dropped and the workflow deleted.
    - This is otherwise benign, but we should still do these operations in a correct order
  2. Not fail the delete/cancel if a denied tables entry is not found (we did not put those in place until you've started switching traffic)
    - If you're doing a ReverseTraffic call where the original (now frozen) workflow is deleted and another variant of it created, then this could result in the workflow being gone/deleted
    - Related to this, we now put those DeniedTables entries — a secondary safety measure, in addition to the routing rules, which prevent writes from being executed against the wrong side/keyspace which would result in data drift and potentially lost writes (if not otherwise detected with VDiff and manually corrected) — in place on the target during workflow creation rather than waiting until the first traffic switch. Previously those would only be put in place on the original workflow target after SwitchTraffic->ReverseTraffic.
    - More generally, we now do not fail the delete/cancel if the thing we went to remove is already gone or the thing we went to add is already in place
  3. Now, for MoveTables workflows, we should always have DeniedTables entries on the target keyspace so I standardized the handling of those when doing traffic switches

Finally, I added a new unit test framework and tests to cover this new behavior and moved the basic VReplication endtoend test over to explicitly/statically using vtctldclient where it was previously explicitly/statically using vtctlclient (the V2 test uses vtctldclient exclusively whereas the basic test chooses the client randomly for most things so that we continue testing both until vtctlclient is removed — the things I changed are the instances where we were using a static client).

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

Copy link
Contributor

vitess-bot bot commented May 20, 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 May 20, 2024
@mattlord mattlord removed NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels May 20, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow before artifacts in vtctldclient Workflow Delete VReplication: remove workflow before artifacts after removing workflow in vtctldclient Workflow Delete May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow before artifacts after removing workflow in vtctldclient Workflow Delete VReplication: remove workflow artifacts after removing workflow in vtctldclient Workflow Delete May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow artifacts after removing workflow in vtctldclient Workflow Delete VReplication: remove workflow artifacts after removing workflow in Workflow Delete May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow artifacts after removing workflow in Workflow Delete VReplication: Remove workflow artifacts after removing workflow in Workflow Delete May 20, 2024
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch from 9fd6793 to 56bcebb Compare May 20, 2024 22:27
Otherwise the cancel/delete and cleanup work can fail.

Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch from 56bcebb to 0b12d82 Compare May 20, 2024 22:38
@mattlord mattlord changed the title VReplication: Remove workflow artifacts after removing workflow in Workflow Delete VReplication: Improve workflow cancel/delete May 22, 2024
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch from b2d3777 to d2d5efe Compare May 22, 2024 12:37
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch from d2d5efe to d7b39d7 Compare May 22, 2024 12:59
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch from d7b39d7 to 82005fb Compare May 22, 2024 13:05
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch from 1ddd859 to 7dd69c2 Compare May 22, 2024 13:11
mattlord added 12 commits June 7, 2024 01:26
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
These changes did not end up being necessary.

Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

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

Thanks! Great to see the unit test framework enhancements.

@mattlord mattlord merged commit 6d8bb74 into vitessio:main Jun 12, 2024
96 checks passed
@mattlord mattlord deleted the vtctldclient_wf_delete branch June 12, 2024 15:09
vitess-bot pushed a commit that referenced this pull request Jun 12, 2024
vitess-bot pushed a commit that referenced this pull request Jun 12, 2024
frouioui pushed a commit that referenced this pull request Jun 12, 2024
… (#16130)

Signed-off-by: Matt Lord <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
mattlord pushed a commit that referenced this pull request Jun 12, 2024
…16131)

Signed-off-by: Matt Lord <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
3 participants