-
Notifications
You must be signed in to change notification settings - Fork 695
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
61c74a4
commit c7d0be5
Showing
2 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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,58 @@ | ||
--- | ||
title: Configure an IP Access List | ||
summary: Learn how to configure IP addresses that are allowed to access your Dedicated Tier cluster. | ||
--- | ||
|
||
# Configure an IP Access List | ||
|
||
For each Dedicated Tier 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 Dedicated Tier cluster. | ||
|
||
> **Note:** | ||
> | ||
> Configuring the IP access list is only available for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. | ||
For a Dedicated Tier cluster, you can configure its IP access list in either of the following ways: | ||
|
||
- [Configure an IP access list in standard connection](#configure-an-ip-access-list-in-standard-connection) | ||
|
||
- [Configure an IP access list in security settings](#configure-an-ip-access-list-in-security-settings) | ||
|
||
## Configure an IP access list in standard connection | ||
|
||
To configure an IP access list for your Dedicated Tier cluster in standard connection, take the following steps: | ||
|
||
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. | ||
2. In the row of your Dedicated Tier cluster, click **...** and select **Connect**. A dialog is displayed. | ||
3. In the dialog, locate **Step 1: Create traffic filter** on the **Standard Connection** tab and configure the IP access list. | ||
|
||
- If the IP access list of your cluster has not been set, you can click **Add My Current IP Address** to add your current IP address to the IP access list, and then click **Add Item** to add more IP addresses if necessary. Next, click **Update Filter** to save the configuration. | ||
|
||
> **Note:** | ||
> | ||
> For each Dedicated Tier cluster, you can add up to 7 IP addresses to the IP access list. To apply for a quota to add more IP addresses, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). | ||
- If the IP access list of your cluster has been set, click **Edit** to add, edit, or remove IP addresses, and then click **Update Filter** to save the configuration. | ||
|
||
- To allow any IP address to access your cluster (not recommended), click **Allow Access From Anywhere**, and then click **Update Filter**. According to security best practices, it is NOT recommended that you allow any IP address to access your cluster, as this would expose your cluster to the internet completely, which is highly risky. | ||
|
||
## Configure an IP access list in security settings | ||
|
||
To configure an IP access list for your Dedicated Tier cluster in security settings, take the following steps: | ||
|
||
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. | ||
2. In the row of your Dedicated Tier cluster, click **...** and select **Security Settings**. A security setting dialog is displayed. | ||
3. In the dialog, configure the IP access list as follows: | ||
|
||
- To add your current IP address to the IP access list, click **Add My Current IP Address**. | ||
|
||
- To add an IP address to the IP access list, enter the IP address and description, and click **Add to IP List**. | ||
|
||
> **Note:** | ||
> | ||
> For each Dedicated Tier cluster, you can add up to 7 IP addresses to the IP access list. To apply for a quota to add more IP addresses, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). | ||
- To allow any IP address to access your cluster (not recommended), click **Allow Access From Anywhere**. According to security best practices, it is NOT recommended that you allow any IP address to access your cluster, as this would expose your cluster to the internet completely, which is highly risky. | ||
|
||
- To remove an IP address from the access list, click **Remove** in the line of the IP address. | ||
|
||
4. Click **Apply** to save the configuration. |