-
Notifications
You must be signed in to change notification settings - Fork 706
cloud: add public connection docs for premium #21926
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
Merged
Merged
Changes from 11 commits
Commits
Show all changes
58 commits
Select commit
Hold shift + click to select a range
639913e
add Premium feature documentation
ljun0712 752cf1a
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 8a39414
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 eaf887c
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 d62f310
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 3c207bc
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 3d0e23d
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 af8c55f
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 3266d67
Update tidb-cloud/delete-tidb-cluster-premium.md
ljun0712 8201d09
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 22cc932
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 0e0071c
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 c80a67d
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 1dddf13
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 c9f7451
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 8b49536
Update tidb-cloud/configure-ip-access-list-premium.md
ljun0712 1186d42
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 e07ee43
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 5e70962
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 7260508
Update tidb-cloud/connect-via-standard-connection-premium.md
ljun0712 9dfb9bc
Update tidb-cloud/connect-via-standard-connection-premium.md
ljun0712 add2905
Update tidb-cloud/delete-tidb-cluster-premium.md
ljun0712 9d980dd
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 d273ea3
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 dab226d
Update tidb-cloud/connect-to-tidb-cluster-serverless.md
ljun0712 035d1a4
Update tidb-cloud/connect-via-standard-connection-premium.md
ljun0712 8a24646
Update tidb-cloud/delete-tidb-cluster-premium.md
ljun0712 12c8623
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 70e7ded
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 e20f381
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 c3d8090
Update tidb-cloud/delete-tidb-cluster-premium.md
ljun0712 e85baa6
Update tidb-cloud/delete-tidb-cluster-premium.md
ljun0712 0fa5df9
Update tidb-cloud/delete-tidb-cluster-premium.md
ljun0712 2ad6dd0
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 773e342
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 53be0b8
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 325e02f
Update tidb-cloud/tidb-cloud-tls-connect-to-premium.md
ljun0712 3bf15bc
Update tidb-cloud/delete-tidb-cluster-premium.md
qiancai ffb2dc5
Merge branch 'release-8.5' into pr/21926
qiancai 0494c73
move premium docs to the premium folder
qiancai 6a59b04
revert "tidb-cloud/connect-to-tidb-cluster-serverless.md" unchanged
qiancai 44acb85
cluster -> instance
qiancai b46c065
replace TiDB Cloud Premium with {{{ .premium }}}
qiancai 906be7e
Update tidb-cloud/premium/tidb-cloud-tls-connect-to-premium.md
ljun0712 fa2d4f4
excluded the outdated example code with ljun0712's confirmation
qiancai bce3b0d
connect-to-premium-via-standard-connection.md -> connect-to-premium-v…
qiancai d0282ba
minor wording updates
qiancai 67ba6b9
fix broken links
qiancai ec92aa2
fix broken links
qiancai b7a667a
Delete tidb-cloud/premium/tidb-cloud-tls-connect-to-premium.md
ljun0712 f8fd7eb
remove “tidb-cloud-tls-connect-to-premium.md” from this PR
qiancai 554bb72
Apply suggestions from code review
qiancai d578810
Update tidb-cloud/premium/delete-tidb-instance.md
qiancai 4bb0fcd
Merge branch 'release-8.5' into pr/21926
qiancai 8140b80
Update create-tidb-instance-premium.md
qiancai 2e8e344
Update indentation
lilin90 0ba2720
Update link to premium public connection guide
lilin90 5e9ec6f
Fix an anchor link
lilin90 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: Configure an IP Access List | ||
| summary: Learn how to configure IP addresses that are allowed to access your TiDB Cloud Premium cluster. | ||
| --- | ||
|
|
||
| # Configure an IP Access List | ||
|
|
||
| For each TiDB Cloud Premium cluster in TiDB Cloud, you can configure an IP access list to filter internet traffic trying to access the cluster, which works similarly to a firewall access control list. After the configuration, only the clients and applications whose IP addresses are in the IP access list can connect to your TiDB Cloud Premium cluster. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > This document applies to [**TiDB Cloud Premium**](/tidb-cloud/select-cluster-tier.md#tidb-cloud-premium). For instructions on configuring an IP access list for **{{{ .starter }}}** or **{{{ .essential }}}**, see [Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). | ||
| To configure an IP access list for your TiDB Cloud Premium cluster, take the following steps: | ||
|
|
||
| 1. Navigate to the [**TiDBs**](https://tidbcloud.com/tidbs) page, and then click the name of your target cluster to go to its overview page. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| > **Tip:** | ||
| > | ||
| > You can use the combo box in the upper-left corner to switch between organizations. | ||
| 2. In the left navigation pane, click **Settings** > **Networking**. | ||
| 3. On the **Networking** page, click **Enable** on the **Public Endpoint** to enable connections to the public endpoint of this cluster. Then click **Edit IP Address**. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 4. In the displayed dialog, choose one of the following options: | ||
|
|
||
| - **Allow access from anywhere**: allows all IP addresses to access TiDB Cloud. This option exposes your cluster to the internet completely and is highly risky. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - **Use IP addresses** (recommended): you can add a list of IPs and CIDR addresses that are allowed to access TiDB Cloud via a SQL client. | ||
|
|
||
| 5. If you choose **Use IP addresses**, add IP addresses or CIDR ranges with an optional description. For each TiDB Cloud Premium cluster, you can add up to 100 IP addresses. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 6. Click **Confirm** to save your changes. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| title: Connect to TiDB Cloud Premium via Public Connection | ||
| summary: Learn how to connect to your TiDB Cloud cluster via public connection. | ||
| --- | ||
|
|
||
| # Connect to TiDB Cloud Premium via Public Connection | ||
|
|
||
| This document describes how to connect to your TiDB Cloud Premium cluster via public connection. The public connection exposes a public endpoint with traffic filters, so you can connect to your TiDB Cloud Premium cluster via a SQL client from your laptop. | ||
qiancai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| > **Tip:** | ||
| > | ||
| > - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public connection, see [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). | ||
| > - To learn how to connect to a TiDB Cloud Dedicated cluster via public endpoint, see [Connect to TiDB Cloud Dedicated via Public Connection](/tidb-cloud/connect-via-standard-connection.md). | ||
| ## Prerequisite: Configure IP access list | ||
|
|
||
| For public connections, TiDB Cloud Premium only allows client connections from addresses in the IP access list. If you have not configured the IP access list, follow the steps in [Configure an IP Access List](/tidb-cloud/configure-ip-access-list-premium.md) to configure it before your first connection. | ||
|
|
||
| ## Connect to the cluster | ||
|
|
||
| To connect to a TiDB Cloud Premium cluster via public connection, take the following steps: | ||
|
|
||
| 1. Open the overview page of the target cluster. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**TiDBs**](https://tidbcloud.com/tidbs) page of your project. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > You can use the combo box in the upper-left corner to switch between organizations. | ||
| 2. Click the name of your target cluster to go to its overview page. | ||
|
|
||
| 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. | ||
|
|
||
| 3. In the connection dialog, select **Public** from the **Connection Type** drop-down list. | ||
|
|
||
| If you have not configured the IP access list, click **Configure IP Access List** or follow the steps in [Configure an IP Access List](/tidb-cloud/configure-ip-access-list-premium.md) to configure it before your first connection. | ||
|
|
||
| 4. Click **CA cert** to download CA cert for TLS connection to TiDB clusters. The CA cert supports TLS 1.2 version by default. | ||
|
|
||
| 5. Choose your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your cluster. | ||
|
|
||
| ## What's next | ||
|
|
||
| After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md). | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: Delete a TiDB Cluster | ||
| summary: Learn how to delete a TiDB cluster. | ||
| --- | ||
|
|
||
| # Delete a TiDB Cluster | ||
|
|
||
| This document describes how to delete a TiDB cluster on TiDB Cloud. | ||
|
|
||
| You can delete a cluster at any time by performing the following steps: | ||
|
|
||
| 1. Navigate to the [**TiDBs**](https://tidbcloud.com/tidbs) page of your project. | ||
| 2. In the row of your target cluster to be deleted, click **...**. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > Alternatively, you can also click the name of the target cluster to go to its overview page, and then click **...** in the upper-right corner. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 3. Click **Delete** in the drop-down menu. | ||
| 4. In the cluster deleting window, confirm the deletion: | ||
qiancai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Enter `<organization name>/<cluster name>` to ensure the cluster is deleted correctly. | ||
|
|
||
| If you want to restore the cluster sometime in the future, make sure that you have a backup of the cluster. Otherwise, you cannot restore it anymore. For more information about how to back up TiDB Cloud Dedicated clusters, see [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore-premium.md). | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| > **Note:** | ||
| > | ||
| > [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters do not support restoring data after the deletion. If you want to delete a {{{ .starter }}} or {{{ .essential }}} cluster and restore its data in the future, see [Export Data from {{{ .starter }}} or Essential](/tidb-cloud/serverless-export.md) to export your data as a backup. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 5. Click **I understand, delete it**. | ||
|
|
||
| Once a backed up TiDB Cloud Dedicated cluster is deleted, the existing backup files of the cluster are moved to the recycle bin. | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Automatic backups will expire and be automatically deleted once the retention period ends. The default retention period is 7 days if you don't modify it. | ||
| - Manual backups will be kept in the Recycle Bin until manually deleted. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > Please be aware that backups will continue to incur charges until deleted. | ||
| If you want to restore a TiDB Cloud Premium cluster from recycle bin, see [Restore a deleted cluster](/tidb-cloud/backup-and-restore-premium.md#restore-a-deleted-cluster). | ||
ljun0712 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.