Skip to content

Online DDL: ALTER VITESS_MIGRATION CLEANUP ALL #16314

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jul 24, 2024
Merged

Online DDL: ALTER VITESS_MIGRATION CLEANUP ALL #16314

merged 10 commits into from
Jul 24, 2024

Conversation

shlomi-noach
Copy link
Contributor

Description

This PR implements:

  • ALTER VITESS_MIGRATION CLEANUP ALL
  • vtctldclient OnlineDDL cleanup <keyspace> all

Migrations that are in complete/failed/cancelled state, and which have not been cleaned up, are marked for cleanup. This command technically affects all historical migrations, although realistically Vitess routinely cleans up migrations after a day or so (depending on configuration). As a reminder, CLEANUP is not strictly required thanks to that automation. It's just in a way to ask for earlier removal of the artifacts tables, which is beneficial if those are large and consume disk space that is otherwise needed right away.

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

Deployment Notes

@shlomi-noach
Support syntax for ALTER VITESS_MIGRATION CLEANUP ALL
b590428 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
implement CLEANUP ALL
a7c0f50 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
endtoend tests for CLEANUP ALL
446c7d7 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
vtctldclient OnlineDDL cancel <keyspace> all
9ef5a5b 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) labels Jul 2, 2024
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jul 2, 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 Jul 2, 2024
@shlomi-noach shlomi-noach requested a review from a team July 2, 2024 14:03
@github-actions github-actions bot added this to the v21.0.0 milestone Jul 2, 2024
@codecov Codecov
Copy link

codecov bot commented Jul 2, 2024 •
edited
Loading

Codecov Report

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

Project coverage is 68.64%. Comparing base (134a7dc) to head (7b3af45).

Files Patch % Lines
go/vt/vttablet/onlineddl/executor.go 0.00% 12 Missing ⚠️
go/cmd/vtctldclient/command/onlineddl.go 0.00% 3 Missing ⚠️
go/vt/sqlparser/ast_format.go 0.00% 2 Missing ⚠️
go/vt/vttablet/tabletserver/query_executor.go 0.00% 2 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #16314      +/-   ##
==========================================
+ Coverage   68.63%   68.64%   +0.01%     
==========================================
  Files        1550     1550              
  Lines      199443   199458      +15     
==========================================
+ Hits       136881   136913      +32     
+ Misses      62562    62545      -17

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

@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work 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 Jul 4, 2024
@shlomi-noach shlomi-noach requested review from a team and removed request for a team July 16, 2024 08:10
@shlomi-noach
resolved conflict
01e4fdd 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
mattlord
mattlord approved these changes Jul 16, 2024
View reviewed changes
go/test/endtoend/onlineddl/scheduler/onlineddl_scheduler_test.go
if row["cleanup_timestamp"].IsNull() {
needCleanup++
} else {
cleanedUp++
Copy link
Contributor

Choose a reason for hiding this comment

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

They've only been marked as ready for cleanup. They haven't yet been cleaned up, right? I'm assuming that we already have tests that cover the actual cleanup work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, both correct!

go/test/endtoend/onlineddl/scheduler/onlineddl_scheduler_test.go Outdated
require.NotNil(t, row)

artifacts = textutil.SplitDelimitedList(row.AsString("artifacts", ""))
assert.Len(t, artifacts, 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but IMO this should be require.Len as you would then panic in the line below if it has no elements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Fixed.

@shlomi-noach
require rather than assert
7a40622 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
resolved conflict
a817dd7 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
resolved conflict
cbf086f 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
Merge branch 'main' into onlineddl-alter-migration-cleanup-all
6e3ba09 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
GuptaManan100
GuptaManan100 approved these changes Jul 24, 2024
View reviewed changes
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

LGTM

@shlomi-noach
resolved conflict
7b3af45 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach merged commit 36f7193 into vitessio:main Jul 24, 2024
129 checks passed
@shlomi-noach shlomi-noach deleted the onlineddl-alter-migration-cleanup-all branch July 24, 2024 12:18
@shlomi-noach shlomi-noach mentioned this pull request Dec 31, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord approved these changes

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@timvaillancourt timvaillancourt Awaiting requested review from timvaillancourt timvaillancourt is a code owner

@ajm188 ajm188 Awaiting requested review from ajm188

Assignees
No one assigned
Labels
Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v21.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@shlomi-noach @mattlord @GuptaManan100