Skip to content

go/{vt,flags}: register builtin backup flags with vtbackup #12558

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

Merged
merged 1 commit into from
Mar 13, 2023

Conversation

maxenglander
Copy link
Collaborator

@maxenglander maxenglander commented Mar 6, 2023

Description

#12073 added support for backup read IO buffering but did not make the new flags available to the vtbackup binary. This PR enables that part.

Related Issue(s)

#12069

Checklist

Deployment Notes

Signed-off-by: Max Englander <max@planetscale.com>
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 6, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 6, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@maxenglander maxenglander added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Backup and Restore labels Mar 6, 2023
@maxenglander maxenglander marked this pull request as ready for review March 6, 2023 19:09
Copy link
Contributor

@ajm188 ajm188 left a comment

Choose a reason for hiding this comment

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

LGTM. Do we need to back port this to 16? (I'm guessing no versions older than that since this wasn't added until after v15, is that correct?

@maxenglander
Copy link
Collaborator Author

@ajm188 ah I didn't think of that! But no backport needed if I understand how everything works, this is as yet unreleased, currently scheduled for v17.

@maxenglander maxenglander requested a review from ajm188 March 7, 2023 13:50
@ajm188
Copy link
Contributor

ajm188 commented Mar 7, 2023

Ah i assumed that #12073 had been merged in time for v16 but i guess not. no back port needed, then

@deepthi
Copy link
Member

deepthi commented Mar 7, 2023

website docs should be updated at https://vitess.io/docs/17.0/reference/programs/vtbackup/

@maxenglander
Copy link
Collaborator Author

@deepthi whoops that should have occurred to me. Added.

@ajm188 ajm188 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 13, 2023
@ajm188 ajm188 merged commit 11fd98d into vitessio:main Mar 13, 2023
@ajm188 ajm188 deleted the maxeng-builtin-backup-vtbackup branch March 13, 2023 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Backup and Restore Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants