add Azure Blob Storage access config (replicates #19090) #20902
Conversation
ti-chi-bot
bot
added
the
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @alastori, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request addresses the need to configure Azure Blob Storage access for TiDB Cloud Dedicated clusters, mirroring the changes proposed in the original, unmerged PR #19090. I've incorporated review feedback from that original PR. The changes include creating a new documentation file (tidb-cloud/dedicated-external-storage.md), adding instructions for configuring Azure Blob Storage access using SAS tokens, including supporting images, and updating links in other files to point to the new documentation.
Highlights
- Feature: Adds documentation for configuring Azure Blob Storage access for TiDB Cloud Dedicated clusters.
- Refactor: Renames
tidb-cloud/config-s3-and-gcs-access.mdtotidb-cloud/dedicated-external-storage.mdand updates all relevant links. - Documentation: Includes detailed steps and images for configuring Azure Blob Storage access using SAS tokens.
Changelog
Click here to see the changelog
- TOC-tidb-cloud.md
- Updated link to point to the new
dedicated-external-storage.mdfile.
- Updated link to point to the new
- tidb-cloud/dedicated-external-storage.md
- Created new file with instructions for configuring Azure Blob Storage access, as well as S3 and GCS.
- Added frontmatter alias to redirect from the old URL (
/tidb-cloud/config-s3-and-gcs-access).
- tidb-cloud/import-csv-files.md
- Updated links to refer to the new
dedicated-external-storage.mdfile for configuring S3 and GCS access.
- Updated links to refer to the new
- tidb-cloud/import-parquet-files.md
- Updated links to refer to the new
dedicated-external-storage.mdfile for configuring S3 and GCS access.
- Updated links to refer to the new
- tidb-cloud/import-sample-data.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring GCS access.
- Updated link to refer to the new
- tidb-cloud/migrate-sql-shards.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring S3 access.
- Updated link to refer to the new
- tidb-cloud/release-notes-2023.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring S3 access.
- Updated link to refer to the new
- tidb-cloud/serverless-external-storage.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring external storage for Dedicated clusters.
- Updated link to refer to the new
- tidb-cloud/terraform-use-import-resource.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring S3 access.
- Updated link to refer to the new
- tidb-cloud/tidb-cloud-migration-overview.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring S3 and GCS access.
- Updated link to refer to the new
- tidb-cloud/troubleshoot-import-access-denied-error.md
- Updated link to refer to the new
dedicated-external-storage.mdfile for configuring S3 access.
- Updated link to refer to the new
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
ti-chi-bot
bot
added
the
size/XL
There was a problem hiding this comment.
Code Review
This pull request adds support for configuring Azure Blob Storage access for TiDB Cloud Dedicated clusters, which is a valuable addition to the documentation. The changes include creating a new file, updating links in other files, and incorporating review feedback from a previous pull request. Overall, the changes seem well-organized and comprehensive. However, I have a few suggestions for improvement, focusing on clarity, consistency, and adherence to the style guide.
Summary of Findings
- Clarity and Simplicity: Some step instructions could be more direct and easier to follow. Consider rephrasing for better clarity, especially for new users. [^1]
- Markdown Style: Ensure a blank line before and after headings and lists for better readability. [^2]
- Terminology Consistency: Maintain consistent terminology throughout the documentation. For example, ensure consistent naming for similar concepts across different sections. [^3]
Merge Readiness
The pull request is well-structured and adds significant value by including Azure Blob Storage configuration instructions. However, addressing the clarity and style guide issues would enhance the overall quality and user experience. I am unable to approve this pull request, and recommend that another reviewer does so after the below comments are addressed. Given the medium severity comments, I recommend that the author addresses these before merging.
qiancai
added
translation/no-need
ti-chi-bot
bot
removed
the
missing-translation-status
qiancai
added
missing-translation-status
ti-chi-bot
bot
added
size/M
|
Hi @alastori, would you please also involve a technical reviewer for this PR? Thanks. |
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
Co-authored-by: Aolin <aolinz@outlook.com>
Co-authored-by: Grace Cai <qqzczy@126.com> Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Grace Cai <qqzczy@126.com>
ti-chi-bot
bot
added
size/L
ti-chi-bot
bot
added
size/M
|
@jusong: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn 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-sigs/prow repository. |
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This commit addresses feedback from the technical review in PR pingcap#20902. Specifically, the following changes were made to `tidb-cloud/dedicated-external-storage.md`: - Changed "service SAS token" to "account SAS token" in the introductory sentence for Azure Blob Storage configuration. - Corrected the Azure portal navigation path from "Security+network" to "Security + networking". - Updated "service SAS token" to "account SAS token" and the corresponding link text in step 3 of the Azure Blob Storage configuration instructions. Review context: https://github.com/pingcap/docs/pull/20902/files/9ab9fc1d8755b14972e913dafe6e398b1c97585c#diff-212ccbb2a644f3e5f083a88919779b8be41c50adc2c2dc25dcefbcf3d5a87232
6 participants
What is changed, added or deleted? (Required)
This PR replicates the changes from the original PR #19090, which added support for configuring Azure Blob Storage access for TiDB Cloud Dedicated clusters, but wasn't merged. We can close PR #19090 after we merge this one.
Specifically, this PR:
tidb-cloud/dedicated-external-storage.md(effectively renaming the oldtidb-cloud/config-s3-and-gcs-access.md) and adds instructions for configuring Azure Blob Storage access using SAS tokens.azure-sas-create.png,azure-sas-position.png) tomedia/tidb-cloud/dedicated-external-storage/.TOC-tidb-cloud.md,import-csv-files.md,import-parquet-files.md,import-sample-data.md,migrate-sql-shards.md,release-notes-2023.md,serverless-external-storage.md,terraform-use-import-resource.md,tidb-cloud-migration-overview.md,troubleshoot-import-access-denied-error.md) to point to the new filename.tidb-cloud/dedicated-external-storage.md.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.
(Note: Please adjust the version checkboxes above based on the actual target branch and current release policies.)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?