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

br,lightning: S3 URL support assuming role #36893

Merged
merged 2 commits into from
Aug 4, 2022

Conversation

dsdashun
Copy link
Contributor

@dsdashun dsdashun commented Aug 4, 2022

What problem does this PR solve?

Issue Number: close #36891

Problem Summary:

What is changed and how it works?

  • Added two query parameters for S3 URL in external storage: role-arn and external-id
  • When creating an S3 client, if role-arn is set, assume the given role to access the S3 objects.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
    • write a main program to construct a Lightning prechecker using a config
    • set a role in AWS IAM with proper trust entity
    • In the config, set the data-source-url to an S3 URL with 'role-arn' and 'external-id' set. For example: s3://my-testing-data/my-dir/?role-arn=arn:aws:iam::88888888:role%2Ftest-role&external-id=abcd1234
    • run the program, the check should not be blocked on 'Access Denied' error
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

Add query parameters for S3 external storage URL, in order to support accessing the S3 data in another account by assuming a given role

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Aug 4, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • D3Hunter
  • Ehco1996

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 4, 2022
@dsdashun
Copy link
Contributor Author

dsdashun commented Aug 4, 2022

/run-integration-br-test

go.mod Show resolved Hide resolved
@sre-bot
Copy link
Contributor

sre-bot commented Aug 4, 2022

@dsdashun
Copy link
Contributor Author

dsdashun commented Aug 4, 2022

/run-integration-br-test

Copy link
Contributor

@Ehco1996 Ehco1996 left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 4, 2022
@dsdashun
Copy link
Contributor Author

dsdashun commented Aug 4, 2022

Copy link
Contributor

@D3Hunter D3Hunter left a comment

Choose a reason for hiding this comment

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

rest lgtm

@@ -46,7 +46,7 @@ require (
github.com/pingcap/errors v0.11.5-0.20211224045212-9687c2b0f87c
github.com/pingcap/failpoint v0.0.0-20220423142525-ae43b7f4e5c3
github.com/pingcap/fn v0.0.0-20200306044125-d5540d389059
github.com/pingcap/kvproto v0.0.0-20220711062932-08b02befd813
github.com/pingcap/kvproto v0.0.0-20220804022843-f006036b1277
Copy link
Contributor

Choose a reason for hiding this comment

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

why this pr need to update kvproto separately?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because in this commit pingcap/kvproto@f006036 , two fields are added into the S3 message . This PR will use the newly added fields to develop this feature. So I updated the kvproto version to include this commit.

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 4, 2022
@dsdashun
Copy link
Contributor Author

dsdashun commented Aug 4, 2022

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 4820919

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 4, 2022
@ti-chi-bot ti-chi-bot merged commit ef136ef into pingcap:master Aug 4, 2022
@sre-bot
Copy link
Contributor

sre-bot commented Aug 4, 2022

TiDB MergeCI notify

✅ Well Done! New fixed [1] after this pr merged.

CI Name Result Duration Compare with Parent commit
idc-jenkins-ci-tidb/integration-common-test ✅ all 17 tests passed 14 min Fixed
idc-jenkins-ci/integration-cdc-test 🟢 all 36 tests passed 25 min Existing passed
idc-jenkins-ci-tidb/common-test 🟢 all 11 tests passed 13 min Existing passed
idc-jenkins-ci-tidb/sqllogic-test-2 🟢 all 28 tests passed 6 min 13 sec Existing passed
idc-jenkins-ci-tidb/sqllogic-test-1 🟢 all 26 tests passed 5 min 53 sec Existing passed
idc-jenkins-ci-tidb/integration-ddl-test 🟢 all 6 tests passed 5 min 24 sec Existing passed
idc-jenkins-ci-tidb/tics-test 🟢 all 1 tests passed 5 min 4 sec Existing passed
idc-jenkins-ci-tidb/mybatis-test 🟢 all 1 tests passed 3 min 11 sec Existing passed
idc-jenkins-ci-tidb/integration-compatibility-test 🟢 all 1 tests passed 2 min 56 sec Existing passed
idc-jenkins-ci-tidb/plugin-test 🟢 build success, plugin test success 4min Existing passed

@dsdashun dsdashun deleted the add_role_arn branch September 2, 2022 06:54
@ran-huang
Copy link
Contributor

The new options should be documented in https://github.com/pingcap/docs-cn/blob/master/br/backup-and-restore-storages.md#s3-%E7%9A%84-url-%E5%8F%82%E6%95%B0. @dsdashun Can you please update the user doc?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make BR/Lightning Support Role ARN authentication for S3 external Storage
7 participants