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

tidb-cloud: add Azure Blob Storage access configuration for Dedicated #19090

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

alastori
Copy link
Contributor

What is changed, added or deleted? (Required)

Added instructions for configuring Azure Blob Storage access in TiDB Cloud Dedicated (page Configure External Storage Access).
Those instructions are consistent with
tidb-cloud/serverless-external-storage.md (branch release-7.5)

The instructions cover:

  • Accessing the Azure Storage account
  • Creating a service SAS token with appropriate permissions

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

  • This PR is related to the existing documentation: tidb-cloud/serverless-external-storage.md (branch release-7.5)
  • Other reference link(s): N/A

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Implement instructions for configuring Azure Blob Storage access
in TiDB Cloud Dedicated. This change supports the new Import
feature for TiDB Cloud Dedicated on Azure, allowing users to
import data from Azure Blob Storage containers.
Those instructions are consistent with
tidb-cloud/serverless-external-storage.md (branch release-7.5)

The instructions cover:
- Accessing the Azure Storage account
- Creating a service SAS token with appropriate permissions
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 11, 2024
@likidu likidu requested a review from qiancai October 11, 2024 21:53
@likidu
Copy link
Collaborator

likidu commented Oct 11, 2024

@qiancai We may also alter the Markdown file name to make it consistent with what Serverless have today: dedicated-external-storage.md. The current file name is no longer accurate with the Azure supporte added and not align with the article title.

@qiancai
Copy link
Collaborator

qiancai commented Oct 12, 2024

@qiancai We may also alter the Markdown file name to make it consistent with what Serverless have today: dedicated-external-storage.md. The current file name is no longer accurate with the Azure supporte added and not align with the article title.

Yes, I completely agree. I’ll rename the file and add the alias.

@qiancai qiancai self-assigned this Oct 12, 2024
@qiancai qiancai added area/tidb-cloud This PR relates to the area of TiDB Cloud. translation/no-need No need to translate this PR. labels Oct 12, 2024
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Oct 12, 2024
Copy link

ti-chi-bot bot commented Oct 12, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@qiancai
Copy link
Collaborator

qiancai commented Oct 12, 2024

@alastori, would you please involve a tech reviewer for this PR? Thanks.

@qiancai qiancai added the needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. label Oct 12, 2024
Copy link

Choose a reason for hiding this comment

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

Allowed Permissions should be Read + List

Copy link
Collaborator

Choose a reason for hiding this comment

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

updated in 4f1caf3 (#19090)

Copy link

Choose a reason for hiding this comment

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

It is not recommended to change the name of the document, as it will be referenced in multiple places on the page
image

Copy link
Collaborator

Choose a reason for hiding this comment

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

In this PR, we’ve added an alias for the old doc link as follows so that anyone clicking the old doc link will be redirected to the new link. However, it’s still recommended to update the link in the Cloud console for consistency after the changes in this PR take effect on the docs website.

image

Comment on lines +252 to +254
> TiDB Cloud does not store your SAS token. It is recommended that you revoke or delete the SAS token after the import is complete to ensure the security of your Azure Blob Storage.

Remember to test the connection and permissions before starting your data import to ensure TiDB Cloud Dedicated can access the specified Azure Blob container and files.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
> TiDB Cloud does not store your SAS token. It is recommended that you revoke or delete the SAS token after the import is complete to ensure the security of your Azure Blob Storage.
Remember to test the connection and permissions before starting your data import to ensure TiDB Cloud Dedicated can access the specified Azure Blob container and files.
> - Before starting your data import, it is recommended that you test the connection and permissions to ensure that TiDB Cloud Dedicated can access the specified Azure Blob container and files.
> - TiDB Cloud does not store your SAS token. After the import is complete, it is recommended that you revoke or delete the SAS token to ensure the security of your Azure Blob Storage.

1. In the **Allowed services** section, choose the **Blob** service.
2. In the **Allowed Resource types** section, choose **Container** and **Object**.
3. In the **Allowed permissions** section, choose the permissions as needed. For example, importing data to a TiDB Cloud Dedicated cluster needs the **Read** and **List** permissions.
4. Adjust **Start and expiry date/time** as needed. For security reasons, it's recommended to set an expiration date that aligns with your data import timeline.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
4. Adjust **Start and expiry date/time** as needed. For security reasons, it's recommended to set an expiration date that aligns with your data import timeline.
4. Adjust **Start and expiry date/time** as needed. For security reasons, it is recommended to set an expiration date that aligns with your data import timeline.

Copy link

ti-chi-bot bot commented Oct 12, 2024

@jusong: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@qiancai qiancai added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tidb-cloud This PR relates to the area of TiDB Cloud. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants