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.

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

add S3 minimum part size defined by the user #17171

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

add S3 minimum part size defined by the user #17171

wants to merge 4 commits into from
+107 −10

Conversation

rvrangel
Copy link
Contributor

@rvrangel rvrangel commented Nov 7, 2024 •
edited
Loading

Description

This adds a new parameter to allow the operator to specify a minimum part size for the S3 uploads.

Related Issue(s)

fixes #17175

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

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Nov 7, 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 Nov 7, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 7, 2024
@rvrangel
update vttablet.txt
e91b2ca 
Signed-off-by: Renan Rangel <[email protected]>
@codecov Codecov
Copy link

codecov bot commented Nov 7, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 95.83333% with 1 line in your changes missing coverage. Please review.

Project coverage is 67.46%. Comparing base (9946ce8) to head (807c22b).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/mysqlctl/s3backupstorage/s3.go 95.83% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #17171   +/-   ##
=======================================
  Coverage   67.45%   67.46%           
=======================================
  Files        1569     1569           
  Lines      252229   252246   +17     
=======================================
+ Hits       170150   170176   +26     
+ Misses      82079    82070    -9

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

@rvrangel
fixing flags
2d88b9c 
Signed-off-by: Renan Rangel <[email protected]>
@rvrangel
go mod tidy
807c22b 
Signed-off-by: Renan Rangel <[email protected]>
@rvrangel rvrangel marked this pull request as ready for review November 7, 2024 20:57
@rvrangel rvrangel changed the title add S3 minimum part sized defined by the user add S3 minimum part size defined by the user Nov 7, 2024
@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Backup and Restore labels Nov 8, 2024
mattlord
mattlord reviewed Nov 8, 2024
View reviewed changes
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. Just a couple of minor comments.

go/flags/endtoend/vtbackup.txt
@@ -195,6 +195,7 @@ Flags:
--remote_operation_timeout duration time to wait for a remote operation (default 15s)
--restart_before_backup Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.
--s3_backup_aws_endpoint string endpoint of the S3 backend (region must be provided).
--s3_backup_aws_minimum_partsize int Minimum part size to use (default 5242880)
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 we use min in other existing flags so we can shorten this one as well. New flags should also use dashes rather than underscores as we want to transition to the latter for everything.

Copy link
Contributor

Choose a reason for hiding this comment

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

Since this flag is part of a group... we may actually just want to keep them all uniform...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can change it to min, but do let me know if the preferred is to use the dashes instead of underscores for it :)

Copy link
Contributor

Choose a reason for hiding this comment

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

I would favor uniformity for this config group over moving to dashes, and move these all together.

go/vt/mysqlctl/s3backupstorage/s3.go
}

if minimumPartSize != 0 && partSizeBytes < minimumPartSize {
if minimumPartSize > 1024*1024*1024*5 || minimumPartSize < 1024*1024*5 { // 5GiB and 5MiB respectively
Copy link
Contributor

Choose a reason for hiding this comment

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

Where do these min and max values come from? I would hope that there are consts we can use instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's a great point. for the minimum, the SDK does define it, so we could use manager.MinUploadPartSize, but I don't see anything for the max. I will take a better look when I update the code for the flag change mentioned above, but we can at least change that one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord left review comments

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

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

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

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

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

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

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Component: Backup and Restore 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 Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: Allow adjustment of the minimum S3 upload part size
3 participants
@rvrangel @mattlord @shlomi-noach