diff --git a/TOC-tidb-cloud-premium.md b/TOC-tidb-cloud-premium.md index 64bae50b8cb26..ca5e54b486a34 100644 --- a/TOC-tidb-cloud-premium.md +++ b/TOC-tidb-cloud-premium.md @@ -231,7 +231,7 @@ - [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) - [Standard SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md) - [Organization SSO Authentication](/tidb-cloud/tidb-cloud-org-sso-authentication.md) - - [Identity Access Management](/tidb-cloud/premium/manage-user-access-premium.md) + - [Identity Access Management](/tidb-cloud/manage-user-access.md) - [OAuth 2.0](/tidb-cloud/oauth2.md) - Network Access Control - [Configure an IP Access List](/tidb-cloud/premium/configure-ip-access-list-premium.md) diff --git a/tidb-cloud/key-concepts.md b/tidb-cloud/key-concepts.md index e24d629900a87..09625c994d52c 100644 --- a/tidb-cloud/key-concepts.md +++ b/tidb-cloud/key-concepts.md @@ -39,7 +39,7 @@ TiDB Cloud Dedicated lets you adjust its compute and storage resources separatel TiDB Cloud ensures high availability in all supported plans: -- For {{{ .starter }}} and {{{ .essential }}} {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}}, see [High Availability in TiDB Cloud](/tidb-cloud/serverless-high-availability.md). +- For {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}}, see [High Availability in TiDB Cloud](/tidb-cloud/serverless-high-availability.md). - For TiDB Cloud Dedicated, see [High Availability in TiDB Cloud Dedicated](/tidb-cloud/high-availability-with-multi-az.md). ## Monitoring diff --git a/tidb-cloud/manage-projects-and-resources.md b/tidb-cloud/manage-projects-and-resources.md index e3a926f72bbb2..097750e327ed1 100644 --- a/tidb-cloud/manage-projects-and-resources.md +++ b/tidb-cloud/manage-projects-and-resources.md @@ -13,7 +13,7 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can discover, access, a A TiDB Cloud resource is a deployable unit that you can manage. It can be one of the following: -- A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}} or Essential{{{ .starter }}}, Essential, or Premium instance +- A TiDB X instance, which is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, or Premium instance - A {{{ .dedicated }}} cluster ### TiDB Cloud projects @@ -43,12 +43,8 @@ For more information, see the following documents: - [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md) - - - [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) - - - [Create a {{{ .dedicated }}} Cluster](/tidb-cloud/create-tidb-cluster.md) ### Manage TiDB Cloud resources @@ -139,4 +135,4 @@ To move a TiDB X instance, take the following steps: - To move the TiDB X instance to a project, select **To a project**, and then select the target project from the drop-down list. - To move the TiDB X instance out of any project, select **Outside any project**. -4. Click **Move**. \ No newline at end of file +4. Click **Move**. diff --git a/tidb-cloud/manage-user-access.md b/tidb-cloud/manage-user-access.md index c575046772ca4..aeb92b1926597 100644 --- a/tidb-cloud/manage-user-access.md +++ b/tidb-cloud/manage-user-access.md @@ -13,12 +13,14 @@ Before accessing TiDB Cloud, [create a TiDB Cloud account](https://tidbcloud.com TiDB Cloud uses a hierarchical structure based on organizations, projects, and resources to help you manage users and TiDB deployments. -- An organization is a top-level entity (such as a company or a customer) that you use to manage your TiDB Cloud accounts (including a management account with any number of member accounts), [projects](#projects), and [resources](/tidb-cloud/tidb-cloud-glossary.md#tidb-cloud-resource). -- A project is a container for TiDB Cloud resources. +- A [resource](/tidb-cloud/tidb-cloud-glossary.md#tidb-cloud-resource) in TiDB Cloud can be either a TiDB X instance or a {{{ .dedicated }}} cluster. A TiDB X instance is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md), such as a {{{ .starter }}}, Essential, or Premium instance. - - For {{{ .starter }}} and Essential instances, a project is an optional logical container, which means you can either group these instances in a project or keep these instances at the organization level. +- A [project](/tidb-cloud/tidb-cloud-glossary.md#project) is a container for TiDB Cloud resources. + + - For TiDB X instances, a project is an optional logical container, which means you can either group these instances in a project or keep these instances at the organization level. - For {{{ .dedicated }}} clusters, a project is infrastructure-bound and required, which means {{{ .dedicated }}} clusters must be grouped in projects for management purposes. -- A resource in TiDB Cloud can be either a TiDB X instance (for example, {{{ .starter }}} or {{{ .essential }}}) or a {{{ .dedicated }}} cluster. + +- An organization is a top-level entity (such as a company or a customer) that you use to manage your TiDB Cloud accounts (including a management account with any number of member accounts), projects, and resources. If you are an organization owner, you can create multiple projects in your organization. @@ -36,6 +38,7 @@ The following is an example of the hierarchical structure: - {{{ .starter }}} instance 2 - {{{ .starter }}} instance 3 - {{{ .essential }}} instance 2 + - {{{ .premium }}} instance 1 - TiDB Dedicated project 1 - {{{ .dedicated }}} cluster 1 - {{{ .dedicated }}} cluster 2 @@ -71,8 +74,8 @@ A project groups and manages TiDB Cloud resources. In TiDB Cloud, there are three types of projects: - **TiDB Dedicated project**: This project type is used only for {{{ .dedicated }}} clusters. It helps you manage settings for {{{ .dedicated }}} clusters separately by project, such as RBAC, networks, maintenance, alert subscriptions, and encryption access. -- **TiDB X project**: This project type is used only for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page. -- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the [List all accessible projects](https://docs.pingcap.com/tidbcloud/api/v1beta/#tag/Project/operation/ListProjects) endpoint of the TiDB Cloud API. +- **TiDB X project**: This project type is used only for TiDB X instances (including {{{ .starter }}}, Essential, and Premium instances). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page. +- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the [List all accessible projects](https://docs.pingcap.com/tidbcloud/api/v1beta/#tag/Project/operation/ListProjects) endpoint of the TiDB Cloud API. The following table lists the differences between these project types: @@ -149,7 +152,7 @@ TiDB X instances support instance-level roles so that you can grant access to a > **Note:** > -> - Instance roles apply only to {{{ .starter }}} and {{{ .essential }}}. TiDB Cloud Dedicated clusters do not support instance roles. +> - Instance roles apply only to {{{ .starter }}}, Essential, and Premium instances. TiDB Cloud Dedicated clusters do not support instance roles. > - `Organization Owner` automatically has all permissions for all TiDB X instances in the organization. > - Each instance role inherits all the permissions of the `Organization Viewer` role by default. > - Project roles and instance roles are additive. A user can inherit access from a project role and also have a more specific role on an individual instance. diff --git a/tidb-cloud/premium/_index.md b/tidb-cloud/premium/_index.md index 8d98b5a88f977..94a3857d18532 100644 --- a/tidb-cloud/premium/_index.md +++ b/tidb-cloud/premium/_index.md @@ -9,129 +9,129 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings -[Why TiDB Cloud](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-intro/?plan=premium) +[Why TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-intro/?plan=premium) -[Key Concepts](https://docs-preview.pingcap.com/tidbcloud/key-concepts/?plan=premium) +[Key Concepts](https://docs.pingcap.com/tidbcloud/key-concepts/?plan=premium) -[FAQ](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-faq/?plan=premium) +[FAQ](https://docs.pingcap.com/tidbcloud/tidb-cloud-faq/?plan=premium) -[Try Out TiDB Cloud](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-quickstart/?plan=premium) +[Try Out TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart/?plan=premium) -[Try Out TiDB + AI](https://docs-preview.pingcap.com/tidbcloud/vector-search-get-started-using-python/?plan=premium) +[Try Out TiDB + AI](https://docs.pingcap.com/tidbcloud/vector-search-get-started-using-python/?plan=premium) -[Try Out HTAP](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart/?plan=premium) +[Try Out HTAP](https://docs.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart/?plan=premium) -[Try Out TiDB Cloud CLI](https://docs-preview.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium) +[Try Out TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium) -[Developer Guide Overview](https://docs-preview.pingcap.com/tidbcloud/dev-guide-overview/?plan=premium) +[Developer Guide Overview](https://docs.pingcap.com/tidbcloud/dev-guide-overview/?plan=premium) -[Quick Start](https://docs-preview.pingcap.com/tidbcloud/dev-guide-build-cluster-in-cloud/?plan=premium) +[Quick Start](https://docs.pingcap.com/tidbcloud/dev-guide-build-cluster-in-cloud/?plan=premium) -[Example Application](https://docs-preview.pingcap.com/tidbcloud/dev-guide-sample-application-spring-boot/?plan=premium) +[Example Application](https://docs.pingcap.com/tidbcloud/dev-guide-sample-application-spring-boot/?plan=premium) -[Create a {{{ .premium }}} Instance](https://docs-preview.pingcap.com/tidbcloud/create-tidb-instance-premium/?plan=premium) +[Create a {{{ .premium }}} Instance](https://docs.pingcap.com/tidbcloud/create-tidb-instance-premium/?plan=premium) -[Connect to a {{{ .premium }}} Instance](https://docs-preview.pingcap.com/tidbcloud/connect-to-tidb-instance/?plan=premium) +[Connect to a {{{ .premium }}} Instance](https://docs.pingcap.com/tidbcloud/connect-to-tidb-instance/?plan=premium) -[Use an HTAP Cluster](https://docs-preview.pingcap.com/tidbcloud/tiflash-overview/?plan=premium) +[Use an HTAP Cluster](https://docs.pingcap.com/tidbcloud/tiflash-overview/?plan=premium) -[Back Up and Restore Data](https://docs-preview.pingcap.com/tidbcloud/backup-and-restore-premium/?plan=premium) +[Back Up and Restore Data](https://docs.pingcap.com/tidbcloud/backup-and-restore-premium/?plan=premium) -[Use API (Beta)](https://docs-preview.pingcap.com/tidbcloud/api-overview/?plan=premium) +[Use API (Beta)](https://docs.pingcap.com/tidbcloud/api-overview/?plan=premium) -[Use TiDB Cloud CLI](https://docs-preview.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium) +[Use TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=premium) -[From Amazon RDS for Oracle](https://docs-preview.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms/?plan=premium) +[From Amazon RDS for Oracle](https://docs.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms/?plan=premium) -[Import Sample Data](https://docs-preview.pingcap.com/tidbcloud/import-sample-data-serverless/?plan=premium) +[Import Sample Data](https://docs.pingcap.com/tidbcloud/import-sample-data-serverless/?plan=premium) -[Import CSV Files](https://docs-preview.pingcap.com/tidbcloud/import-csv-files-premium/?plan=premium) +[Import CSV Files](https://docs.pingcap.com/tidbcloud/import-csv-files-premium/?plan=premium) -[Import Parquet Files](https://docs-preview.pingcap.com/tidbcloud/import-parquet-files-serverless/?plan=premium) +[Import Parquet Files](https://docs.pingcap.com/tidbcloud/import-parquet-files-serverless/?plan=premium) -[With MySQL CLI](https://docs-preview.pingcap.com/tidbcloud/import-with-mysql-cli-premium/?plan=premium) +[With MySQL CLI](https://docs.pingcap.com/tidbcloud/import-with-mysql-cli-premium/?plan=premium) -[Status and Metrics](https://docs-preview.pingcap.com/tidbcloud/monitor-tidb-cluster/?plan=premium) +[Status and Metrics](https://docs.pingcap.com/tidbcloud/monitor-tidb-cluster/?plan=premium) -[Built-in Monitoring](https://docs-preview.pingcap.com/tidbcloud/built-in-monitoring-premium/?plan=premium) +[Built-in Monitoring](https://docs.pingcap.com/tidbcloud/built-in-monitoring-premium/?plan=premium) -[Tuning Overview](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-tune-performance-overview/?plan=premium) +[Tuning Overview](https://docs.pingcap.com/tidbcloud/tidb-cloud-tune-performance-overview/?plan=premium) -[Analyze Performance](https://docs-preview.pingcap.com/tidbcloud/tune-performance/?plan=premium) +[Analyze Performance](https://docs.pingcap.com/tidbcloud/tune-performance/?plan=premium) -[Tune SQL Performance](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-sql-tuning-overview/?plan=premium) +[Tune SQL Performance](https://docs.pingcap.com/tidbcloud/tidb-cloud-sql-tuning-overview/?plan=premium) -[Tune TiFlash Performance](https://docs-preview.pingcap.com/tidbcloud/tune-tiflash-performance/?plan=premium) +[Tune TiFlash Performance](https://docs.pingcap.com/tidbcloud/tune-tiflash-performance/?plan=premium) -[Password Authentication](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-password-authentication/?plan=premium) +[Password Authentication](https://docs.pingcap.com/tidbcloud/tidb-cloud-password-authentication/?plan=premium) -[User Roles](https://docs-preview.pingcap.com/tidbcloud/manage-user-access-premium/?plan=premium/#user-roles) +[User Roles](https://docs.pingcap.com/tidbcloud/manage-user-access/?plan=premium/#user-roles) -[Manage User Profiles](https://docs-preview.pingcap.com/tidbcloud/manage-user-access-premium/?plan=premium/#manage-user-profiles) +[Manage User Profiles](https://docs.pingcap.com/tidbcloud/manage-user-access/?plan=premium/#manage-user-profiles) -[Manage Organization Access](https://docs-preview.pingcap.com/tidbcloud/manage-user-access-premium/?plan=premium/#manage-organization-access) +[Manage Organization Access](https://docs.pingcap.com/tidbcloud/manage-user-access/?plan=premium/#manage-organization-access) -[Configure an IP Access List](https://docs-preview.pingcap.com/tidbcloud/configure-ip-access-list-premium/?plan=premium) +[Configure an IP Access List](https://docs.pingcap.com/tidbcloud/configure-ip-access-list-premium/?plan=premium) -[Pricing](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#pricing-for-premium) +[Pricing](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#pricing-for-premium) -[Invoices](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#invoices) +[Invoices](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#invoices) -[Credits](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#credits) +[Credits](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing/?plan=premium/#credits) -[Airbyte](https://docs-preview.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte/?plan=premium) +[Airbyte](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte/?plan=premium) -[Zapier](https://docs-preview.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier/?plan=premium) +[Zapier](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier/?plan=premium) -[Vercel](https://docs-preview.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel/?plan=premium) +[Vercel](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel/?plan=premium) -[Terraform](https://docs-preview.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview/?plan=premium) +[Terraform](https://docs.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview/?plan=premium) -[Amazon AppFlow](https://docs-preview.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration/?plan=premium) +[Amazon AppFlow](https://docs.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration/?plan=premium) -[SQL Reference](https://docs-preview.pingcap.com/tidbcloud/basic-sql-operations/?plan=premium) +[SQL Reference](https://docs.pingcap.com/tidbcloud/basic-sql-operations/?plan=premium) -[System Variables](https://docs-preview.pingcap.com/tidbcloud/system-variables/?plan=premium) +[System Variables](https://docs.pingcap.com/tidbcloud/system-variables/?plan=premium) diff --git a/tidb-cloud/premium/manage-user-access-premium.md b/tidb-cloud/premium/manage-user-access-premium.md deleted file mode 100644 index 7cdacccb90a26..0000000000000 --- a/tidb-cloud/premium/manage-user-access-premium.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -title: Identity Access Management for {{{ .premium }}} -summary: Learn how to manage identity access in {{{ .premium }}}. ---- - -# Identity Access Management for {{{ .premium }}} - -This document describes how to manage user access, roles, and permissions across organizations and {{{ .premium }}} instances. - -Before you can use TiDB Cloud, [sign up for an account](https://tidbcloud.com/free-trial). You can either sign up with email and password to [manage your password in TiDB Cloud](/tidb-cloud/tidb-cloud-password-authentication.md), or choose your Google, GitHub, or Microsoft account for single sign-on (SSO) to TiDB Cloud. - -## Organizations and instances - -{{{ .premium }}} uses a hierarchical structure of organizations and instances to help you manage users and {{{ .premium }}} instances efficiently. As an `Organization Owner`, you can create and manage multiple instances within your organization. - -For example: - -``` -- Your organization - - {{{ .premium }}} instance 1 - - {{{ .premium }}} instance 2 - - {{{ .premium }}} instance 3 - ... -``` - -In this structure: - -- Users can access an organization only if they are members of it. -- To access a {{{ .premium }}} instance, users need at least read permissions for that instance in the organization. - -For more information about user roles and permissions, see [User Roles](#user-roles). - -### Organizations - -An organization can include multiple {{{ .premium }}} instances. - -TiDB Cloud calculates billing at the organization level, with the billing details available for each instance. - -If you are an `Organization Owner`, you have full administrative privileges in your organization. - -For example, you can do the following: - -- Create {{{ .premium }}} instances for different purposes. -- Assign organization-level and instance-level roles to different users. -- Configure organization-wide settings such as time zone. - -### {{{ .premium }}} instances - -If you are an `Instance Manager`, you can manage settings and operations for a specific {{{ .premium }}} instance. - -For example, you can do the following: - -- Delete a {{{ .premium }}} instance when it is no longer needed. -- Modify instance configurations as needed. - -## User roles - -TiDB Cloud defines different user roles to control permissions at both the organization and instance levels. - -You can grant roles to users at the organization level or at the instance level. It is recommended to plan your hierarchy carefully to ensure least‑privilege access and maintain security. - -### Organization roles - -At the organization level, TiDB Cloud defines the following roles, in which `Organization Owner` can invite members and grant organization roles to members. - -| Permission | `Organization Owner` | `Organization Billing Manager` | `Organization Billing Viewer` | `Organization Console Audit Manager` | `Organization Viewer` | -|---|---|---|---|---|---| -| Manage organization settings, such as {{{ .premium }}} instances, API keys, and time zones. | ✅ | ❌ | ❌ | ❌ | ❌ | -| Add or remove organization members, and edit organization roles. | ✅ | ❌ | ❌ | ❌ | ❌ | -| `Instance Manager` permissions for all {{{ .premium }}} instances in the organization. | ✅ | ❌ | ❌ | ❌ | ❌ | -| Manage payment information for the organization. | ✅ | ✅ | ❌ | ❌ | ❌ | -| View billing and use [Cost Explorer](/tidb-cloud/tidb-cloud-billing.md#cost-explorer). | ✅ | ✅ | ✅ | ❌ | ❌ | -| Manage [console audit logging](/tidb-cloud/tidb-cloud-console-auditing.md) for the organization. | ✅ | ❌ | ❌ | ✅ | ❌ | -| View all organization members. | ✅ | ❌ | ❌ | ❌ | ❌ | -| View organization name and time zone. | ✅ | ✅ | ✅ | ✅ | ✅ | - -> **Note:** -> -> - The `Organization Console Audit Manager` role manages audit logging in the TiDB Cloud console only, not database audit logging. - -### Instance roles - -At the instance level, TiDB Cloud defines two roles: `Instance Manager` and `Instance Viewer`. - -> **Note:** -> -> - The `Organization Owner` automatically inherits all `Instance Manager` permissions for every instance in the organization. -> - Each instance role inherits all the permissions of the `Organization Viewer` role by default. -> - If a member in your organization does not have any instance roles, the member cannot access any {{{ .premium }}} instances in your organization. - -| Permission | `Instance Manager` | `Instance Viewer` | -|---|---|---| -| Manage instance settings | ✅ | ❌ | -| Manage [database audit logging](/tidb-cloud/tidb-cloud-auditing.md) of the {{{ .premium }}} instances. | ✅ | ❌ | -| Manage instance operations, such as {{{ .premium }}} instance creation, modification, and deletion. | ✅ | ❌ | -| Manage TiDB data, such as data import, data backup and restore, and data migration. | ✅ | ❌ | -| Manage [changefeeds](/tidb-cloud/changefeed-overview.md). | ✅ | ❌ | -| Review and reset the root password for the {{{ .premium }}} instance. | ✅ | ❌ | -| View the overview, backup records, metrics, events, and [changefeeds](/tidb-cloud/changefeed-overview.md) of the {{{ .premium }}} instance. | ✅ | ✅ | - -## Manage organization access - -### View and switch between organizations - -To view and switch between organizations, take the following steps: - -1. In the [TiDB Cloud console](https://tidbcloud.com), click the combo box in the upper-left corner. The list of organizations you belong to is displayed. - - > **Tip:** - > - > - If you are currently on the page of a specific {{{ .premium }}} instance, after clicking the combo box in the upper-left corner, you also need to click **Back to My TiDB** in the combo box to return to the organization list. - > - If you are a member of multiple organizations, you can click the target organization name in the combo box to switch your account between organizations. - -2. To view the detailed information of your organization, such as the organization ID and time zone, click the organization name, and then click **Organization Settings** > **General** in the left navigation pane. - -### Set the time zone for your organization - -If you are in the `Organization Owner` role, you can modify the system display time according to your time zone. - -To change the local timezone setting, take the following steps: - -1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. - -2. In the left navigation pane, click **Organization Settings** > **General**. - -3. In the **Time Zone** section, select your time zone from the drop-down list. - -4. Click **Update**. - -### Invite a user to your organization - -If you are in the `Organization Owner` role, you can invite users to your organization. - -> **Note:** -> -> You can also [invite a user to access or manage a {{{ .premium }}} instance](#invite-a-user-to-access-or-manage-a-premium-instance) directly as needed, which also makes the user your organization member. - -To invite a user to an organization, take the following steps: - -1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. - -2. In the left navigation pane, click **Organization Settings** > **Users**. - -3. On the **Users** page, click **Invite User**. - -4. Enter the email address of the user to be invited, and then select an organization role for the user. - - > **Tip:** - > - > - The default role at the organization level is `Organization Viewer`. - > - If you want to invite multiple users at one time, you can enter multiple email addresses. - > - The invited user does not have access to any {{{ .premium }}} instances by default. To grant instance permissions to the user, see [Invite a user to access or manage a {{{ .premium }}} instance](#invite-a-user-to-access-or-manage-a-premium-instance). - -5. If you only need to assign the user an organization role and do not need to assign any project or instance roles, disable the **Add access for projects and instances** option. - -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 used to sign up for a TiDB Cloud account, the user is directed to the sign-up page to create an account. - -> **Note:** -> -> The verification link in the email expires in 24 hours. If the user you want to invite does not receive the email, click **Resend**. - -### Modify organization roles - -If you are in the `Organization Owner` role, you can modify organization roles of all members in your organization. - -To modify the organization role of a member, take the following steps: - -1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. - -2. In the left navigation pane, click **Organization Settings** > **Users**. - -3. On the **Users** page, click **...** > **Edit Role** in the row of the target member. - -### Remove an organization member - -If you are in the `Organization Owner` role, you can remove organization members from your organization. - -To remove a member from an organization, take the following steps: - -> **Note:** -> -> If a member is removed from an organization, the instance access for the member is also removed. - -1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. - -2. In the left navigation pane, click **Organization Settings** > **Users**. - -3. On the **Users** page, click **...** > **Delete** in the row of the target member. - -## Manage instance access - -### Invite a user to access or manage a {{{ .premium }}} instance {#invite-a-user-to-access-or-manage-a-premium-instance} - -If you are in the `Organization Owner` role, you can invite users to access or manage your {{{ .premium }}} instances. - -> **Note:** -> -> When you invite a user not in your organization to access or manage your {{{ .premium }}} instance, the user automatically joins your organization as well. - -To invite a user to access or manage a {{{ .premium }}} instance, take the following steps: - -1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. - -2. In the left navigation pane, click **Organization Settings** > **Users**. - -3. On the **Users** page, click **Invite User**. - -4. Enter the email address of the user to be invited, and then select an organization role for the user. - -5. Make sure the **Add access for projects and instances** option is enabled, click **Add access** in the **Instance access** section, and then select an instance role for the user. - -6. Click **Add access**. 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. - -> **Note:** -> -> The verification link in the email will expire in 24 hours. If your user doesn't receive the email, click **Resend**. - -### Modify instance roles - -If you are in the `Organization Owner` role, you can modify instance roles of all organization members in your organization. - -To modify the instance role of a member, take the following steps: - -1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. - -2. In the left navigation pane, click **Organization Settings** > **Users**. - -3. On the **Users** page, click **...** > **Edit Role** of the target member. - -## Manage user profiles - -In TiDB Cloud, you can easily manage your profile, including your first name, last name, and phone number. - -1. In the [TiDB Cloud console](https://tidbcloud.com), click in the lower-left corner. - -2. Click **Account Settings**. - -3. In the displayed dialog, update the profile information, and then click **Update**. \ No newline at end of file diff --git a/tidb-cloud/premium/set-up-sink-private-endpoint-premium.md b/tidb-cloud/premium/set-up-sink-private-endpoint-premium.md index ba85a9c645a57..59669c3f668fe 100644 --- a/tidb-cloud/premium/set-up-sink-private-endpoint-premium.md +++ b/tidb-cloud/premium/set-up-sink-private-endpoint-premium.md @@ -19,7 +19,7 @@ Only users with any of the following roles in your organization can create priva - `Organization Owner` - `Instance Manager` for the corresponding instance -For more information about roles in TiDB Cloud, see [User roles](/tidb-cloud/premium/manage-user-access-premium.md#user-roles). +For more information about roles in TiDB Cloud, see [User roles](/tidb-cloud/manage-user-access.md#user-roles). ### Network diff --git a/tidb-cloud/security-concepts.md b/tidb-cloud/security-concepts.md index 03b6c2fdc7bd2..dfffe29572e34 100644 --- a/tidb-cloud/security-concepts.md +++ b/tidb-cloud/security-concepts.md @@ -122,8 +122,8 @@ TiDB Cloud manages users and resources with a hierarchical structure: organizati - In TiDB Cloud, there are three types of projects: - **TiDB Dedicated project**: a project type for {{{ .dedicated }}} clusters only. Dedicated projects manage project-scoped settings such as networking, maintenance, alert subscriptions, integrations, and encryption-related access. - - **TiDB X project**: a logical container for {{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium instances. TiDB X projects are used for grouping resources and applying project-level RBAC, but they do not carry Dedicated-only infrastructure settings. - - **TiDB X virtual project**: a virtual project for {{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium instances that are not grouped in any TiDB X project. This project type is used only for API compatibility and does not provide any management capabilities. + - **TiDB X project**: a logical container for TiDB X instances (including {{{ .starter }}}, Essential, and Premium instances). TiDB X projects are used for grouping resources and applying project-level RBAC, but they do not carry Dedicated-only infrastructure settings. + - **TiDB X virtual project**: a virtual project for TiDB X instances that are not grouped in any TiDB X project. This project type is used only for API compatibility and does not provide any management capabilities. **Resources** diff --git a/tidb-cloud/tidb-cloud-glossary.md b/tidb-cloud/tidb-cloud-glossary.md index dce7b7587369b..b2a6f87f6fb95 100644 --- a/tidb-cloud/tidb-cloud-glossary.md +++ b/tidb-cloud/tidb-cloud-glossary.md @@ -117,14 +117,14 @@ A document that defines permissions applying to a role, user, or organization, s In TiDB Cloud, you can use projects to group and manage your TiDB resources. -- For {{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium instances, projects are optional, which means you can either group these instances in a project or keep these instances at the organization level. +- For TiDB X instances (including {{{ .starter }}}, Essential, and Premium instances), projects are optional, which means you can either group these instances in a project or keep these instances at the organization level. - For {{{ .dedicated }}} clusters, projects are required. The function of a project varies by project type. Currently, there are three types of projects: - **TiDB Dedicated project**: This project type is used only for {{{ .dedicated }}} clusters. It helps you manage settings for {{{ .dedicated }}} clusters separately by project, such as RBAC, networks, maintenance, alert subscriptions, and encryption access. -- **TiDB X project**: This project type is used only for TiDB X instances ({{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page. -- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the project view on the [**My TiDB**](https://tidbcloud.com/tidbs) page. +- **TiDB X project**: This project type is used only for TiDB X instances. It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page. +- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the project view on the [**My TiDB**](https://tidbcloud.com/tidbs) page. For more information about the differences between these project types, see [Projects](/tidb-cloud/manage-user-access.md#projects). @@ -140,18 +140,8 @@ The place where the data of deleted [TiDB Cloud resources](#tidb-cloud-resource) Once a backed-up TiDB Cloud resource is deleted, the existing backup files of it are moved to the Recycle Bin. For backup files from automatic backups, the Recycle Bin will retain them for a specified period. You can configure the backup retention in **Backup Setting**, and the default is 7 days. For backup files from manual backups, there is no expiration date. To avoid data loss, remember to restore the data to a new TiDB Cloud resource in time. Note that if a TiDB Cloud resource **has no backup**, the deleted resource will not be displayed in the Recycle Bin. - - -Currently, only {{{ .dedicated }}} clusters support the Recycle Bin feature. - - - - - Currently, only {{{ .premium }}} instances and {{{ .dedicated }}} clusters support the Recycle Bin feature. - - ### region - TiDB Cloud region @@ -203,20 +193,20 @@ The computing node that aggregates data from queries returned from transactional A TiDB Cloud resource is a manageable TiDB Cloud deployment unit. It can be one of the following: -- A TiDB X instance (a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md)), such as a {{{ .starter }}} or Essential{{{ .starter }}}, Essential, or Premium instance +- A TiDB X instance (a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md)), such as a {{{ .starter }}}, Essential, or Premium instance - A {{{ .dedicated }}} cluster ### TiDB X A new distributed SQL architecture that makes cloud-native object storage the backbone of TiDB. By decoupling compute and storage, TiDB X enables TiDB to scale intelligently, adapting in real time to workload patterns, business cycles, and data characteristics. -The TiDB X architecture is now available in {{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium. For more information, see [Introducing TiDB X: A New Foundation for Distributed SQL in the Era of AI](https://www.pingcap.com/blog/introducing-tidb-x-a-new-foundation-distributed-sql-ai-era/) and [PingCAP Launches TiDB X and New AI Capabilities at SCaiLE Summit 2025](https://www.pingcap.com/press-release/pingcap-launches-tidb-x-new-ai-capabilities/). +The TiDB X architecture is now available in {{{ .starter }}}, Essential, and Premium. For more information, see [Introducing TiDB X: A New Foundation for Distributed SQL in the Era of AI](https://www.pingcap.com/blog/introducing-tidb-x-a-new-foundation-distributed-sql-ai-era/) and [PingCAP Launches TiDB X and New AI Capabilities at SCaiLE Summit 2025](https://www.pingcap.com/press-release/pingcap-launches-tidb-x-new-ai-capabilities/). ### TiDB X instance A TiDB X instance is a service-oriented TiDB Cloud offering built on the [TiDB X architecture](/tidb-cloud/tidb-x-architecture.md). It does not require you to manage or understand the underlying cluster topology. -Among TiDB Cloud plans, {{{ .starter }}} and Essential{{{ .starter }}}, Essential, and Premium are using the TiDB X architecture. Therefore, when "TiDB X instance" is mentioned, it refers to a {{{ .starter }}} or Essential{{{ .starter }}}, Essential, or Premium instance. +Among TiDB Cloud plans, {{{ .starter }}}, Essential, and Premium are using the TiDB X architecture. Therefore, when "TiDB X instance" is mentioned, it refers to a {{{ .starter }}}, Essential, or Premium instance. ### TiFlash node