Skip to content

cloud: add msk doc#22512

Merged
ti-chi-bot[bot] merged 18 commits intopingcap:release-8.5from
shiyuhang0:plc_msk
Mar 10, 2026
Merged

cloud: add msk doc#22512
ti-chi-bot[bot] merged 18 commits intopingcap:release-8.5from
shiyuhang0:plc_msk

Conversation

@shiyuhang0
Copy link
Member

First-time contributors' checklist

What is changed, added or deleted? (Required)

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.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)?

  • This PR is translated from:
  • Other reference 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 the missing-translation-status This PR does not have translation status info. label Feb 28, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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!

This pull request significantly enhances TiDB Cloud's connectivity options by introducing comprehensive support for Amazon MSK Provisioned clusters via AWS PrivateLink. It provides users with detailed guidance and updated tooling to establish secure, private connections, thereby expanding the ecosystem of integrated AWS services.

Highlights

  • New Documentation for Amazon MSK Private Link: A new document has been added that provides a step-by-step guide on how to connect TiDB Cloud to an Amazon MSK Provisioned cluster using a Private Link connection. This includes details on limitations, prerequisites, MSK cluster setup, SASL/SCRAM authentication, ACL configuration, and multi-VPC connectivity.
  • Expanded Private Link Connection Types: The existing private link connection documentation has been updated to include 'Amazon MSK Provisioned' as a supported connection type, alongside AWS Endpoint Service and Alibaba Cloud Endpoint Service.
  • Instructions for Creating MSK Private Link Connections: Detailed instructions have been added for creating an Amazon MSK Provisioned private link connection through both the TiDB Cloud console and CLI, ensuring users can easily set up this new integration.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • tidb-cloud/serverless-private-link-connection-to-amazon-msk.md
    • Added a new document detailing the process of connecting TiDB Cloud to Amazon MSK Provisioned clusters using Private Link.
    • Included sections on limitations, prerequisites, MSK cluster creation, SASL/SCRAM authentication, ACL setup, cluster configuration, policy attachment, and multi-VPC connectivity.
  • tidb-cloud/serverless-private-link-connection.md
    • Introduced 'Amazon MSK Provisioned' as a new private link connection type.
    • Added a new section with instructions for creating an Amazon MSK Provisioned private link connection via the TiDB Cloud console and CLI.
    • Updated the table of supported domain types to reflect that Amazon MSK Provisioned connections do not support attaching domains.
    • Added a cross-reference to the new dedicated Amazon MSK Provisioned connection guide in the 'See also' section.
Activity
  • The pull request was created by shiyuhang0.
  • The pull request introduces new documentation and updates existing documentation related to Amazon MSK Private Link connections.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

@ti-chi-bot ti-chi-bot bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 28, 2026
Copy link
Contributor

@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

This pull request adds documentation for connecting to Amazon MSK Provisioned clusters via a private link. The changes include a new detailed guide and updates to the main private link connection document. My review focuses on improving clarity, correcting grammar and typos, and ensuring technical accuracy, following the repository's documentation style guide. I've found a few areas for minor text improvements and a significant potential error in the CLI instructions for creating the MSK connection, which appears to be a copy-paste from another section and needs correction.

shiyuhang0 and others added 4 commits February 28, 2026 12:46
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@hfxsd hfxsd self-assigned this Feb 28, 2026
@hfxsd hfxsd added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed missing-translation-status This PR does not have translation status info. labels Feb 28, 2026
@hfxsd hfxsd requested a review from zhangyangyu February 28, 2026 07:48
@hfxsd hfxsd requested a review from qiancai March 2, 2026 08:46
@qiancai qiancai changed the title add msk doc cloud: add msk doc Mar 2, 2026
shiyuhang0 and others added 4 commits March 4, 2026 11:06
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 10, 2026
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Mar 10, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 10, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-10 13:08:56.648441508 +0000 UTC m=+355568.160499168: ☑️ agreed by qiancai.
  • 2026-03-10 13:20:10.995094818 +0000 UTC m=+356242.507152479: ☑️ agreed by hfxsd.

@hfxsd
Copy link
Collaborator

hfxsd commented Mar 10, 2026

/approve

@ti-chi-bot ti-chi-bot bot added the approved label Mar 10, 2026
@hfxsd
Copy link
Collaborator

hfxsd commented Mar 10, 2026

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 10, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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 merged commit ee782aa into pingcap:release-8.5 Mar 10, 2026
11 checks passed
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/L Denotes a PR that changes 100-499 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.

3 participants