cloud: add public connection docs for premium #21926
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
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 for {{{ .premium }}} | ||
| summary: Learn how to configure IP addresses that are allowed to access your {{{ .premium }}} instance. | ||
| --- | ||
|
|
||
| # Configure an IP Access List for {{{ .premium }}} | ||
|
|
||
| For each {{{ .premium }}} instance in TiDB Cloud, you can configure an IP access list to filter internet traffic trying to access the instance, 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 {{{ .premium }}} instance. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > This document applies to **{{{ .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 {{{ .premium }}} instance, take the following steps: | ||
|
|
||
| 1. Navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page. | ||
|
|
||
| > **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** for **Public Endpoint** to to make the instance accessible via a public endpoint, and then click **Add IP Address**. | ||
| 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 instance to the internet completely and is highly risky. | ||
| - **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. | ||
| 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| title: Connect to {{{ .premium }}} via Public Connection | ||
| summary: Learn how to connect to your {{{ .premium }}} via public connection. | ||
| --- | ||
|
|
||
| # Connect to {{{ .premium }}} via Public Connection | ||
|
|
||
| This document describes how to connect to your {{{ .premium }}} instance via public connection. The public connection exposes a public endpoint with traffic filters, so you can connect to your {{{ .premium }}} instance via a SQL client from your laptop. | ||
|
|
||
| > **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, {{{ .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/premium/configure-ip-access-list-premium.md) to configure it before your first connection. | ||
|
|
||
| ## Connect to the instance | ||
|
|
||
| To connect to a {{{ .premium }}} instance via public connection, take the following steps: | ||
|
|
||
| 1. Open the overview page of the target instance. | ||
|
|
||
| 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > You can use the combo box in the upper-left corner to switch between organizations. | ||
| 2. Click the name of your target instance 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/premium/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 instances. The CA cert supports TLS 1.2 version by default. | ||
|
Collaborator
There was a problem hiding this comment. Do we need to delete this step for now? |
||
|
|
||
| 5. Choose your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your instance. | ||
|
|
||
| ## What's next | ||
|
|
||
| After you have successfully connected to your TiDB instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). | ||
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,46 @@ | ||
| --- | ||
| title: Connect to Your {{{ .premium }}} Instance | ||
| summary: Learn how to connect to your {{{ .premium }}} instance via different methods. | ||
| --- | ||
|
|
||
| # Connect to Your {{{ .premium }}} Instance | ||
|
|
||
| This document describes how to connect to your {{{ .premium }}} instance. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > To learn how to connect to a TiDB Cloud Dedicated cluster, see [Connect to Your TiDB Cloud Dedicated Cluster](/tidb-cloud/connect-to-tidb-cluster.md). | ||
|
|
||
| ## Connection methods | ||
|
|
||
| After your {{{ .premium }}} instance is created on TiDB Cloud, you can connect to it via direct connections. | ||
|
|
||
| Direct connections mean the MySQL native connection system over TCP. You can connect to your instance using any tool that supports MySQL connection, such as [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). | ||
|
|
||
| | Connection method | User interface | Scenario | | ||
| |--------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | Direct connections | SQL/ORM | Long-running environment, such as Java, Node.js, and Python. | | ||
|
|
||
| ## Network | ||
|
|
||
| There are two network connection types for {{{ .premium }}}: | ||
|
|
||
| - [Private endpoint](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md) (recommended) | ||
|
|
||
| Private endpoint connection provides a private endpoint to allow SQL clients in your VPC to securely access services over AWS PrivateLink, which provides highly secure and one-way access to database services with simplified network management. | ||
|
|
||
| - [Public endpoint](/tidb-cloud/premium/connect-to-premium-via-public-connection.md) | ||
|
|
||
| The standard connection exposes a public endpoint, so you can connect to your TiDB instance via a SQL client from your laptop. | ||
|
|
||
| <!-- To ensure the security of data transmission, you need to [establish a TLS connection](/tidb-cloud/premium/tidb-cloud-tls-connect-to-premium.md) from your client to your instance. --> | ||
|
|
||
| The following table shows the network you can use: | ||
|
|
||
| | Connection method | Network | Description | | ||
| |----------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------| | ||
| | Direct connections | Public or private endpoint | Direct connections can be made via both public and private endpoints. | | ||
|
|
||
| ## What's next | ||
|
|
||
| After you have successfully connected to your TiDB instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). |
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,36 @@ | ||
| --- | ||
| title: Delete a {{{ .premium }}} instance | ||
| summary: Learn how to delete a {{{ .premium }}} instance. | ||
| --- | ||
|
|
||
| # Delete a {{{ .premium }}} instance | ||
|
|
||
| This document describes how to delete a {{{ .premium }}} instance. | ||
|
|
||
| You can delete an instance at any time by performing the following steps: | ||
|
|
||
| 1. Navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. | ||
| 2. In the row of your target instance to be deleted, click **...**. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > Alternatively, you can also click the name of the target instance to go to its overview page, and then click **...** in the upper-right corner. | ||
|
|
||
| 3. Click **Delete** in the drop-down menu. | ||
| 4. In the deletion confirmation window, confirm the deletion: | ||
|
|
||
| Enter `<organization name>/<instance name>` to ensure the instance is deleted correctly. | ||
|
|
||
| If you want to restore the instance some time in the future, make sure that you have a backup of the instance. Otherwise, you cannot restore it. For more information about how to back up {{{ .premium }}} instances, see [Back Up and Restore {{{ .premium }}} Data](/tidb-cloud/premium/backup-and-restore-premium.md). | ||
|
|
||
| 5. Click **I understand, delete it**. | ||
|
|
||
| Once you delete a backed up {{{ .premium }}} instance, the existing backup files of the instance are moved to the recycle bin. | ||
|
|
||
| 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. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > Please be aware that backups will continue to incur charges until deleted. | ||
|
|
||
| If you want to restore a {{{ .premium }}} instance from the recycle bin, see [Restore from Recycle Bin](/tidb-cloud/premium/backup-and-restore-premium.md#restore-from-recycle-bin). |
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.