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

add S3 minimum part size defined by the user #17171

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

Conversation

rvrangel
Copy link
Contributor

@rvrangel rvrangel commented Nov 7, 2024

Description

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

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

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
Copy link

codecov bot commented Nov 7, 2024

Codecov Report

Attention: Patch coverage is 58.33333% with 10 lines in your changes missing coverage. Please review.

Project coverage is 67.52%. Comparing base (0d84a49) to head (364f8f5).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/mysqlctl/s3backupstorage/s3_mock.go 0.00% 8 Missing ⚠️
go/vt/mysqlctl/s3backupstorage/s3.go 87.50% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17171      +/-   ##
==========================================
+ Coverage   67.46%   67.52%   +0.06%     
==========================================
  Files        1581     1581              
  Lines      253934   253966      +32     
==========================================
+ Hits       171305   171492     +187     
+ Misses      82629    82474     -155     

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

@rvrangel rvrangel force-pushed the s3-minimum-partsize branch from 44ede6d to 807c22b Compare November 7, 2024 20:14
@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
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 Outdated Show resolved Hide resolved
go/vt/mysqlctl/s3backupstorage/s3.go Outdated Show resolved Hide resolved
@frouioui frouioui 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 Nov 19, 2024
@rvrangel rvrangel requested a review from vmg as a code owner November 21, 2024 15:03
@rvrangel rvrangel force-pushed the s3-minimum-partsize branch from 7f7d336 to 0f08ff4 Compare November 21, 2024 15:10
@frouioui
Copy link
Member

Hey @rvrangel the history of that Pull Request looks a bit broken. It needs to be rebased.

Signed-off-by: Renan Rangel <[email protected]>
Signed-off-by: Renan Rangel <[email protected]>
Signed-off-by: Renan Rangel <[email protected]>
@rvrangel rvrangel force-pushed the s3-minimum-partsize branch from 5994e0e to 9ab638a Compare December 12, 2024 13:32
Signed-off-by: Renan Rangel <[email protected]>
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

We need to port this change to vitess-operator as mentioned in my comment. Otherwise it looks good to me.

@@ -98,6 +109,7 @@ func registerFlags(fs *pflag.FlagSet) {
fs.BoolVar(&tlsSkipVerifyCert, "s3_backup_tls_skip_verify_cert", false, "skip the 'certificate is valid' check for SSL connections.")
fs.StringVar(&requiredLogLevel, "s3_backup_log_level", "LogOff", "determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors.")
fs.StringVar(&sse, "s3_backup_server_side_encryption", "", "server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file).")
fs.Int64Var(&minPartSize, "s3_backup_aws_min_partsize", manager.MinUploadPartSize, "Minimum part size to use, defaults to 5MiB but can be increased due to the dataset size.")
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is it only needed on that struct so we can load the definitions? in any case we can discuss in planetscale/vitess-operator#645

Signed-off-by: Renan Rangel <[email protected]>
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Looks good to me after the latest changes.

Only comment left is the one I wrote on planetscale/vitess-operator#645 (review). We should port the operator-latest.yaml changes made in vtop to this repo's ./examples/operator/operator.yaml.

Signed-off-by: Renan Rangel <[email protected]>
@rvrangel
Copy link
Contributor Author

I updated the yaml file to be in sync with the other PR, let me know if it looks okay now

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. I'm just not sure that we really need to bring in the humanize package just for this. What do you think @rvrangel ?

return nil, err
}

bh.bs.params.Logger.Infof("Using S3 upload part size: %s", humanize.IBytes(uint64(partSizeBytes)))
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if it's worth adding a project dependency on humanize for this and the error message below. The flag is in bytes, so I think it would actually be better to log the bytes here as well to confirm that the expected/flag value is used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it was already an indirect dependency, so I thought I would use it :)

I can remove it tomorrow since the preference is to avoid it

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, you're right! Sorry, for some reason I thought we added it to go.mod here. No reason not to use it here 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.

okay, I will leave it then and just update the comment as mentioned below!

@@ -213,9 +228,11 @@ func (bh *S3BackupHandle) handleAddFile(ctx context.Context, filename string, pa
}()
}

func calculateUploadPartSize(filesize int64) int64 {
// this is a helper to calculate the part size, taking into consideration the minimum part size
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 the function comment should start with the function name. Some linters will complain about this.

Signed-off-by: Renan Rangel <[email protected]>
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.

Feature Request: Allow adjustment of the minimum S3 upload part size
4 participants