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

Incremental restore: copy files under Vitess dataroot dir #15440

Conversation

shlomi-noach
Copy link
Contributor

Description

During an incremental restore process, the built-in engine copies backup files onto a temporary directory. Right now this temporary directory is rooted at the default OS temp dir (i.e. /tmp on Linux).

In k8s deployments, this directory is not shared among pods. This means that the files written by the build in engine on one pod, are not visible to mysqlctl on the mysqld pod, where mysqlbinlog binary expects to find and apply them.

This PR roots the temporary directory under the Vitess data root.

Related Issue(s)

Fixes #14765

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

Copy link
Contributor

vitess-bot bot commented Mar 11, 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 Mar 11, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 11, 2024
@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 labels Mar 11, 2024
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

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

Project coverage is 65.65%. Comparing base (4c70c7e) to head (fa7000e).
Report is 1 commits behind head on main.

Files Patch % Lines
go/vt/mysqlctl/builtinbackupengine.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15440      +/-   ##
==========================================
+ Coverage   65.64%   65.65%   +0.01%     
==========================================
  Files        1562     1563       +1     
  Lines      194318   194380      +62     
==========================================
+ Hits       127553   127619      +66     
+ Misses      66765    66761       -4     

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

@@ -1006,7 +1008,7 @@ func (be *BuiltinBackupEngine) restoreFiles(ctx context.Context, params RestoreP
}

if bm.Incremental {
createdDir, err = os.MkdirTemp("", "restore-incremental-*")
createdDir, err = os.MkdirTemp(vtenv.VtDataRoot(), "restore-incremental-*")
Copy link
Contributor

@mattlord mattlord Mar 11, 2024

Choose a reason for hiding this comment

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

Do we copy only the binary logs here or the full backup? If it's the full backup, this can have a significant effect on the storage needed and we might want to make this configurable (I'm assuming that the vtdataroot has another copy of the actual data that was restored prior to this step?). /tmp may also be direct attached storage or tmpfs which could cause a significant performance impact when using VTDATAROOT. It may make sense for this to be a flag with the default value being /tmp.

Copy link
Contributor

@mattlord mattlord Mar 11, 2024

Choose a reason for hiding this comment

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

To answer some of my own questions... 🙂

https://vitess.io/docs/user-guides/operating-vitess/backup-and-restore/creating-a-backup/#create-an-incremental-backup-with-vtctl

So we’re restoring an incremental backup here, which was only binary logs to begin with. And incremental is always done by the builtinbackupengine, regardless of which engine you’re using for full backups.

@shlomi-noach shlomi-noach marked this pull request as draft March 11, 2024 15:07
@shlomi-noach
Copy link
Contributor Author

Converted to Draft because I'm not sure this is necessarily the solution we're looking for. Alternatively, as @mattlord suggests, we could have a configurable path via command line flag.

@shlomi-noach
Copy link
Contributor Author

We chose #15451 as an alternative approach.

@shlomi-noach shlomi-noach deleted the incremental-restore-onto-vitess-dir branch March 25, 2024 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Backup and Restore NeedsBackportReason If backport labels have been applied to a PR, a justification is required Type: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: PITR from timestamp or position not working
2 participants