Skip to content

config,variable: add new SEM configuration document #21562

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

YangKeao
Copy link
Member

First-time contributors' checklist

What is changed, added or deleted? (Required)

  1. Add a more detailed configuration guide for SEM.

Ref pingcap/tidb#61634

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

Copy link

ti-chi-bot bot commented Aug 11, 2025

[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 assign hfxsd for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 11, 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.

Summary of Changes

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

I've added a new comprehensive documentation page for TiDB's Security Enhanced Mode (SEM). This document explains how SEM provides a mandatory access control layer, allowing fine-grained control over database operations, even for root users, which is particularly useful in DBaaS environments. It covers both the default restrictions and the highly customizable mode via a JSON configuration file.

Highlights

  • New Security Enhanced Mode (SEM) Documentation: I've introduced a dedicated markdown document (security-enhanced-mode.md) that thoroughly explains TiDB's Security Enhanced Mode.
  • Detailed SEM Configuration Guide: The new document outlines how to enable SEM, its two operational modes (default and custom via sem-config), and provides examples for restricting access to databases/tables, system variables, privileges, status variables, and specific SQL commands.
  • Documentation Cross-Referencing: I've updated existing documentation files (TOC.md, basic-features.md, system-variables.md, tidb-configuration-file.md) to correctly link to and reflect the new SEM documentation and its configuration options.
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 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 or fill out our survey 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

This pull request introduces a comprehensive documentation page for Security Enhanced Mode (SEM), which is a great addition. The new page is well-structured and provides detailed information on how to configure and use SEM. My review includes several suggestions to improve formatting, clarity, and consistency, mainly within the new security-enhanced-mode.md file, to align it with the documentation style guide. These are mostly minor points to enhance readability.

Copy link

ti-chi-bot bot commented Aug 11, 2025

@YangKeao: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify d54f4f4 link true /test pull-verify

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@Oreoxmt Oreoxmt self-assigned this Aug 15, 2025
@Oreoxmt Oreoxmt added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Aug 15, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Aug 15, 2025
@Oreoxmt Oreoxmt added v9.0-beta.2 This PR/issue applies to TiDB v9.0-beta.2. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3. labels Aug 15, 2025
@Oreoxmt Oreoxmt self-requested a review August 15, 2025 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. v9.0-beta.2 This PR/issue applies to TiDB v9.0-beta.2. v9.0-beta.3 This PR/issue applies to TiDB v9.0-beta.3.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants