Skip to content

Conversation

@alastori
Copy link
Collaborator

What is changed, added or deleted? (Required)

Updated the tidb-cloud/migrate-from-mysql-using-data-migration.md document.
In the "Set up network connection" section, under the "Set up Azure Private Link" details block, the content was changed to link to the more comprehensive guide at /tidb-cloud/private-link-to-azure.md (#20873). This ensures users have access to the full, detailed instructions for setting up Azure Private Link when migrating data to TiDB Cloud.

Previously, this section contained a summary of the steps. The change points to the canonical documentation for this feature.

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)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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)

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

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

@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 May 14, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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 updates the TiDB Cloud documentation to reflect the addition of Azure Blob Storage as a supported external storage option for TiDB Cloud Dedicated clusters. It also updates references to the config-s3-and-gcs-access.md document to the new dedicated-external-storage.md document, which now includes Azure Blob Storage configuration instructions. The PR also adds a section on configuring Azure Private Link.

Highlights

  • Azure Blob Storage Support: Adds documentation for configuring Azure Blob Storage access for TiDB Cloud Dedicated clusters, including instructions for creating an account SAS token.
  • Documentation Updates: Updates multiple documents to reference the dedicated-external-storage.md document instead of the deprecated config-s3-and-gcs-access.md.
  • Azure Private Link: Adds a section with a link to the private-link-to-azure.md guide for setting up Azure Private Link.

Changelog

Click here to see the changelog
  • TOC-tidb-cloud.md
    • Updated the link for configuring external storage access for TiDB Cloud Dedicated to point to dedicated-external-storage.md.
  • tidb-cloud/dedicated-external-storage.md
    • Added support for configuring Azure Blob Storage access.
    • Added alias for the old config-s3-and-gcs-access path to this document.
    • Updated the summary to include Azure Blob Storage.
  • tidb-cloud/import-csv-files.md
    • Updated links to point to dedicated-external-storage.md for configuring Amazon S3 and GCS access.
  • tidb-cloud/import-parquet-files.md
    • Updated links to point to dedicated-external-storage.md for configuring Amazon S3 and GCS access.
  • tidb-cloud/import-sample-data.md
    • Updated link to point to dedicated-external-storage.md for configuring GCS access.
  • tidb-cloud/migrate-from-mysql-using-data-migration.md
    • Added a section with a link to the private-link-to-azure.md guide for setting up Azure Private Link.
  • tidb-cloud/migrate-sql-shards.md
    • Updated link to point to dedicated-external-storage.md for configuring Amazon S3 access.
  • tidb-cloud/release-notes-2023.md
    • Updated link to point to dedicated-external-storage.md for configuring Amazon S3 access.
  • tidb-cloud/serverless-external-storage.md
    • Updated link to point to dedicated-external-storage.md for configuring external storage access for TiDB Cloud Dedicated.
  • tidb-cloud/terraform-use-import-resource.md
    • Updated link to point to dedicated-external-storage.md for configuring Amazon S3 access.
  • tidb-cloud/tidb-cloud-migration-overview.md
    • Updated link to point to dedicated-external-storage.md for configuring Amazon S3 access and GCS access.
  • tidb-cloud/troubleshoot-import-access-denied-error.md
    • Updated link to point to dedicated-external-storage.md for configuring Amazon S3 access.
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

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request updates several documents to point to the new location of the external storage configuration guide. It also adds a section on configuring Azure Blob Storage access. The changes seem correct and necessary. However, there are a few minor issues that can be improved.

Summary of Findings

  • Consistency in Summary: The summary in tidb-cloud/dedicated-external-storage.md could be rephrased for better consistency.
  • Code Block Formatting: The code block formatting in tidb-cloud/dedicated-external-storage.md could be improved by removing the language identifier.
  • Introductory Sentence: The new Azure Blob Storage section in tidb-cloud/dedicated-external-storage.md could benefit from a brief introductory sentence.

Merge Readiness

The pull request is almost ready for merging. Addressing the minor suggestions would improve the overall quality and clarity of the documentation. Once these are addressed, the pull request can be merged.

…e migration guide.

- Included reference to the related pull request for additional context: pingcap#20873.
@alastori alastori force-pushed the support-azure-dm-private-link branch from b19ea89 to effc809 Compare May 14, 2025 23:01
@ti-chi-bot ti-chi-bot bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 14, 2025
@qiancai qiancai self-assigned this May 15, 2025
…on for

migrating MySQL-compatible databases to TiDB Cloud using Data Migration in
tidb-cloud/migrate-from-mysql-using-data-migration.md.

The primary goals of this update are to:
1.  Provide much more detailed and actionable guidance on network connectivity options, with a strong focus on Private Link/Endpoint configurations for AWS and Azure, alongside existing VPC Peering and Public IP methods.
2.  Introduce comprehensive instructions for enabling and configuring binary logs on various MySQL source types (self-managed, AWS RDS/Aurora, Azure Database for MySQL, Google Cloud SQL).
3.  Incorporate Azure Database for MySQL flexible servers as a fully supported data source throughout the document.
4.  Improve clarity and consistency in terminology (e.g., "MySQL source database" instead of "upstream").

Key changes include:

-   Updated to include Azure and better articulate the benefits of the DM feature.
-   Restructured "Prerequisites":
    -   Added "Azure Database for MySQL flexible servers" to supported data sources and expanded version support for other cloud MySQL services.
    -   New major section "Ensure network connectivity":
        -   Table summarizing Public Endpoints, Private Links (AWS/Azure), and VPC Peering (AWS/GCP).
        -   Emphasis on end-to-end TLS/SSL encryption with links to provider docs.
        -   Detailed setup guides for Public Endpoints, AWS PrivateLink, and Azure Private Link, including CLI verification examples and provider-specific considerations.
        -   Existing VPC Peering instructions for AWS and GCP are now integrated here.
    -   New major section "Enable binary logs for replication":
        -   Table of required binlog settings.
        -   Provider-specific instructions (self-managed, AWS, Azure, GCP) for configuring these binlog settings.
    -   Clarified privilege requirements and user hostname considerations for DM service access.
-   **Terminology Updates:** Consistently used "MySQL source database" and "target TiDB Cloud cluster" for better readability.
-   Minor phrasing improvements throughout the document for clarity.

These changes aim to provide users with a more complete, robust, and easier-to-follow guide for preparing their environment for data migration to TiDB Cloud, especially when using private networking solutions."
@ti-chi-bot ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 16, 2025
- Added "Azure Database for MySQL flexible servers" to supported sources and updated the supported versions table.
- Expanded the "Enable binary logs" section with specific MySQL configurations (`log_bin`, `binlog_format`, `binlog_row_image`, `binlog_expire_logs_seconds`) and detailed setup instructions for self-managed MySQL, AWS RDS/Aurora, Azure Database for MySQL, and Google Cloud SQL for MySQL.
- Enhanced "Ensure network connectivity" section covering Public Endpoints, Private Link (for AWS and Azure with setup steps), and VPC Peering (for AWS and GCP with setup steps), along with recommendations for TLS/SSL.
- Refined the "Grant required privileges" section with clearer tables detailing privileges, scope, and purpose for both source and target databases.
- Various wording adjustments and formatting improvements for better readability and consistency.
@ti-chi-bot ti-chi-bot bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 16, 2025
@qiancai qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels May 19, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label May 19, 2025
qiancai and others added 4 commits May 22, 2025 10:47
…ps for migration jobs

- Expanded prerequisites with detailed network connectivity and TLS/SSL setup for AWS, Azure, and GCP
- Clarified required privileges for migration users with example GRANT statements
- Improved connection configuration steps, including SSL/TLS options and certificate upload guidance
- Clarified object selection behavior in migration job (all, database, or table-level)
- Enhanced formatting, added links, and improved instructional clarity throughout
@qiancai qiancai force-pushed the support-azure-dm-private-link branch from 2ec907f to 3312e3e Compare May 26, 2025 03:52
github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request May 29, 2025
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

Note: I updated the format for multiple lines via 8b3a9ca, to keep a consistent style.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 3, 2025
Copy link
Member

@lilin90 lilin90 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 bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jun 3, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jun 3, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-06-03 01:40:05.802783001 +0000 UTC m=+319492.005128264: ☑️ agreed by qiancai.
  • 2025-06-03 05:21:57.775458139 +0000 UTC m=+332803.977803404: ☑️ agreed by lilin90.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Jun 4, 2025

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

Details

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-sigs/prow repository.

@qiancai
Copy link
Collaborator

qiancai commented Jun 4, 2025

/approve

@qiancai qiancai merged commit 2d416fd into pingcap:support-azure Jun 4, 2025
7 of 9 checks passed
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jun 4, 2025

[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

Details 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

@ti-chi-bot ti-chi-bot bot added the approved label Jun 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tidb-cloud This PR relates to the area of TiDB Cloud. lgtm size/XL Denotes a PR that changes 500-999 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.

5 participants