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

Online DDL: unsupporting gh-ost DDL strategy #15693

Merged
merged 5 commits into from
Apr 10, 2024

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Apr 10, 2024

Description

See #15692

This PR:

  • Removes the embedded gh-ost binary from vttablet (the user will have to supply their own gh-ost binary, and unless it's /usr/bin/gh-ost they will have to run vttablet --gh-ost-path)
  • Removes onlineddl_ghost endtoend tests, and replaces gh-ost strategy tests with vitess strategy in any other tests.

With that, we turn gh-ost to be unsupported. Otherwise gh-ost strategy still works.

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 shlomi-noach added Type: Internal Cleanup Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) labels Apr 10, 2024
Copy link
Contributor

vitess-bot bot commented Apr 10, 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 Apr 10, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 10, 2024
@shlomi-noach
Copy link
Contributor Author

Docs PR: vitessio/website#1725

@shlomi-noach shlomi-noach requested a review from a team April 10, 2024 12:06
@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 Apr 10, 2024
ghostOverridePath string
ptOSCOverridePath string
ghostBinaryPath = "/usr/bin/gh-ost"
ptOSCBinaryPath = "/usr/bin/pt-online-schema-change"
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be worth to make this work if it's available in $PATH instead of having a hardcoded path? Would that already work out of the box if we just set these values to "gh-ost" and "pt-online-schema-change"?

Looking at the template below, that might already just work then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. Fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

pt-online-schema-change remains on /usr/bin as this was the previous behavior. Not changing it, will just remove it when the time comes.

Signed-off-by: Shlomi Noach <[email protected]>
Copy link

codecov bot commented Apr 10, 2024

Codecov Report

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

Project coverage is 68.40%. Comparing base (6cd09cc) to head (48c9515).
Report is 6 commits behind head on main.

Files Patch % Lines
go/vt/vttablet/onlineddl/executor.go 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15693      +/-   ##
==========================================
+ Coverage   68.38%   68.40%   +0.02%     
==========================================
  Files        1556     1556              
  Lines      195120   195111       -9     
==========================================
+ Hits       133427   133466      +39     
+ Misses      61693    61645      -48     

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

Copy link
Contributor

@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.

LGTM! We need to update a couple of test output files now. I'll push a quick commit for that to save you the CI time when you're ready to merge.

@shlomi-noach
Copy link
Contributor Author

@mattlord thank you!

@shlomi-noach shlomi-noach merged commit 42c5f49 into vitessio:main Apr 10, 2024
101 checks passed
@shlomi-noach shlomi-noach deleted the deprecate-gh-ost branch April 10, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Type: Enhancement Logical improvement (somewhere between a bug and feature) Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants