Add manage user access documentation for premium #21953

zhoubasten · 2025-10-22T03:01:16Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

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.

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 · 2025-10-22T03:01:25Z

[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 csuzhangxc 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:

OWNERS

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

gemini-code-assist · 2025-10-22T03:01:28Z

Summary of Changes

Hello @zhoubasten, I'm Gemini Code Assist¹! 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 introduces a new documentation page dedicated to managing user access within the premium offering of TiDB Cloud. While the file structure is now in place, the content itself is currently a placeholder, signaling that further detailed information will be provided in subsequent updates.

Highlights

New Documentation File Added: A new documentation file, tidb-cloud/premium/manage-user-access-premium.md, has been added to the repository. This file is intended to cover managing user access for the premium tier of TiDB Cloud.
Placeholder Content: The newly added documentation file currently contains only placeholder text ("sdf"), indicating that the detailed content is yet to be added.

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.

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

gemini-code-assist

Code Review

The pull request adds a new file tidb-cloud/premium/manage-user-access-premium.md with the content 'sdf'. This change introduces a new documentation file, but the content is minimal and lacks context. I have added a review comment to address the content of the file.

gemini-code-assist · 2025-10-22T03:02:37Z

tidb-cloud/premium/manage-user-access-premium.md

@@ -0,0 +1 @@
+sdf


The file contains only 'sdf'. Please provide meaningful content for this documentation page. Consider adding an overview, instructions, or relevant information about managing user access for premium users. Following the style guide ¹, ensure clarity, simplicity, completeness, and readability.

Style Guide References

Footnotes

↩

ti-chi-bot · 2025-10-22T08:35:07Z

@zhoubasten: 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	`c748b96`	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.

qiancai · 2025-10-23T02:54:15Z

tidb-cloud/premium/manage-user-access-premium.md

+
+# Identity Access Management
+
+This document describes how to manage access to organizations, instances, roles and user profiles in TiDB Cloud.


Suggested change

This document describes how to manage access to organizations, instances, roles and user profiles in TiDB Cloud.

This document describes how to manage access to organizations, instances, roles and user profiles in TiDB Cloud Premium.

qiancai · 2025-10-23T02:54:35Z

tidb-cloud/premium/manage-user-access-premium.md

+summary: Learn how to manage identity access in TiDB Cloud.
+---
+
+# Identity Access Management


Suggested change

# Identity Access Management

# Identity Access Management for TiDB Cloud Premium

qiancai · 2025-10-23T02:56:24Z

tidb-cloud/premium/manage-user-access-premium.md

+
+## Organizations and instances
+
+TiDB Cloud provides a hierarchical structure based on organizations and instances to facilitate the management of TiDB Cloud users and TiDB instances. If you are an organization owner, you can create multiple TiDB instance in your organization.


Suggested change

TiDB Cloud provides a hierarchical structure based on organizations and instances to facilitate the management of TiDB Cloud users and TiDB instances. If you are an organization owner, you can create multiple TiDB instance in your organization.

TiDB Cloud Premium provides a hierarchical structure based on organizations and instances to facilitate the management of TiDB Cloud users and TiDB instances. If you are an organization owner, you can create multiple TiDB instances in your organization.

qiancai · 2025-10-23T05:43:22Z

tidb-cloud/premium/manage-user-access-premium.md

+    > **Tip:**
+    > - The default role at organization level is `Organization Viewer`.


Suggested change

> **Tip:**

> - The default role at organization level is `Organization Viewer`.

> **Tip:**

>

> - The default role at the organization level is `Organization Viewer`.

qiancai · 2025-10-23T05:43:52Z

tidb-cloud/premium/manage-user-access-premium.md

+5. If you only need assign the user an orgnization role, and not assign any instance roles or project roles, turn off the switch of **Add access for projects and instance**.
+


Suggested change

5. If you only need assign the user an orgnization role, and not assign any instance roles or project roles, turn off the switch of **Add access for projects and instance**.

reason: this option is not available now

qiancai · 2025-10-23T05:44:37Z

tidb-cloud/premium/manage-user-access-premium.md

+6. Click **Invite**. Then the new user is successfully added into the user list. At the same time, an email is sent to the invited email address with a verification link.
+
+7. After receiving this email, the user needs to click the link in the email to verify the identity, and a new page shows.
+
+8. If the invited email address has not been signed up for a TiDB Cloud account, the user is directed to the sign-up page to create an account.


Suggested change

6. Click **Invite**. Then the new user is successfully added into the user list. At the same time, an email is sent to the invited email address with a verification link.

7. After receiving this email, the user needs to click the link in the email to verify the identity, and a new page shows.

8. If the invited email address has not been signed up for a TiDB Cloud account, the user is directed to the sign-up page to create an account.

5. Click **Invite**. Then the new user is successfully added into the user list. At the same time, an email is sent to the invited email address with a verification link.

6. After receiving this email, the user needs to click the link in the email to verify the identity, and a new page shows.

7. If the invited email address has not been signed up for a TiDB Cloud account, the user is directed to the sign-up page to create an account.

qiancai · 2025-10-23T05:45:44Z

tidb-cloud/premium/manage-user-access-premium.md

+
+2. In the left navigation pane, click **Organization Settings** > **Users**.
+
+3. On the **Users** page, click **...** > **Edit Permission** of the target member.


Suggested change

3. On the **Users** page, click **...** > **Edit Permission** of the target member.

3. On the **Users** page, click **...** > **Edit Role** in the row of the target member.

qiancai · 2025-10-23T05:48:07Z

tidb-cloud/premium/manage-user-access-premium.md

+
+2. In the left navigation pane, click **Organization Settings** > **Users**.
+
+3. On the **Users** page, click **...** > **Delete** in the row of the target member,


Suggested change

3. On the **Users** page, click **...** > **Delete** in the row of the target member,

3. On the **Users** page, click **...** > **Delete** in the row of the target member.

Add manage user access documentation for premium

2ce6e8b

ti-chi-bot bot added the first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. label Oct 22, 2025

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 22, 2025

gemini-code-assist bot reviewed Oct 22, 2025

View reviewed changes

initial commit

3505212

ti-chi-bot bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 22, 2025

qiancai added area/tidb-cloud This PR relates to the area of TiDB Cloud. translation/no-need No need to translate this PR. for-cloud-release This PR is related to TiDB Cloud release. and removed missing-translation-status This PR does not have translation status info. labels Oct 22, 2025

zhoubasten added 3 commits October 22, 2025 14:55

First round update to remove Project roles and management details

cdd78e0

remove project terms

80d7d84

remove cluster terms

0d01234

ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 22, 2025

zhoubasten added 2 commits October 22, 2025 15:35

update the permissions to view all users

92dc4a1

update permissions to view organization basic info

496469e

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 Oct 22, 2025

update manage access to org roles

db4f49d

ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 22, 2025

update manage user access to instance

c748b96

qiancai self-assigned this Oct 22, 2025

qiancai reviewed Oct 23, 2025

View reviewed changes


		# Identity Access Management

		This document describes how to manage access to organizations, instances, roles and user profiles in TiDB Cloud.

	# Identity Access Management
	# Identity Access Management for TiDB Cloud Premium


		## Organizations and instances

		TiDB Cloud provides a hierarchical structure based on organizations and instances to facilitate the management of TiDB Cloud users and TiDB instances. If you are an organization owner, you can create multiple TiDB instance in your organization.

	TiDB Cloud provides a hierarchical structure based on organizations and instances to facilitate the management of TiDB Cloud users and TiDB instances. If you are an organization owner, you can create multiple TiDB instance in your organization.
	TiDB Cloud Premium provides a hierarchical structure based on organizations and instances to facilitate the management of TiDB Cloud users and TiDB instances. If you are an organization owner, you can create multiple TiDB instances in your organization.

		> Tip:
		> - The default role at organization level is `Organization Viewer`.

		5. If you only need assign the user an orgnization role, and not assign any instance roles or project roles, turn off the switch of Add access for projects and instance.


		2. In the left navigation pane, click Organization Settings > Users.

		3. On the Users page, click ... > Edit Permission of the target member.

		@@ -0,0 +1 @@
		sdf

Add manage user access documentation for premium #21953

Are you sure you want to change the base?

Add manage user access documentation for premium #21953

Conversation

zhoubasten commented Oct 22, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

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

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

Do your changes match any of the following descriptions?

Uh oh!

ti-chi-bot bot commented Oct 22, 2025

Uh oh!

gemini-code-assist bot commented Oct 22, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Oct 22, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

ti-chi-bot bot commented Oct 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants