PingKai Logo下载

通过 AWS PrivateLink 连接平凯数据库云服务 Starter 或 Essential

本文档介绍如何通过 AWS PrivateLink 连接到你的平凯数据库云服务 Starter 或 Essential 实例。

平凯数据库云服务支持通过 AWS PrivateLink 在 AWS VPC 中对平凯数据库云服务进行高度安全的单向 access,就像 service 部署在你自己的 VPC 中一样。你的 VPC 中会暴露一个私有端点,你可以通过该端点并具备权限后连接到平凯数据库云服务。

借助 AWS PrivateLink,端点连接安全且私密,不会将你的数据暴露在公网。此外,端点连接支持 CIDR 重叠,便于网络管理。

私有端点的 architecture 如下所示:

Private endpoint architecture

如需了解私有端点和端点 service 的更详细定义,请参见以下 AWS 文档:

限制

  • 目前,平凯数据库云服务仅支持当端点 service 托管在 AWS 时的 AWS PrivateLink 连接。如果 service 托管在其他云服务商,AWS PrivateLink 连接不适用。
  • 不支持跨 Region 的私有端点连接。

前提条件

请确保在 AWS VPC 设置中已启用 DNS hostnames 和 DNS resolution。在 AWS Management Console 中创建 VPC 时,这些选项默认是禁用的。

选择端点模型

要通过私有端点连接到你的平凯数据库云服务 Starter 或 Essential 实例,请按照以下步骤操作:

  1. 选择 平凯云 Starter 或 Essential 实例
  2. 创建 AWS interface 端点
  3. 在平凯数据库云服务中授权你的私有端点
  4. 连接到你的 平凯云 Starter 或 Essential 实例

Step 1. 选择 平凯云 Starter 或 Essential 实例

  1. 在 My TiDB 页面,点击目标 平凯云 Starter 或 平凯云 Essential 实例的名称,进入其概览页面。

  2. 点击右上角的 Connect。此时会显示连接对话框。

  3. 在 Connection Type 下拉列表中,选择 Private Endpoint。

  4. 记下 Service Name、Availability Zone ID 和 Region ID。

Step 2. 创建 AWS interface 端点

如需使用 AWS Management Console 创建 VPC interface 端点,请执行以下步骤:

  1. 登录 AWS Management Console,并打开 Amazon VPC 控制台 https://console.aws.amazon.com/vpc/。

  2. 在导航栏点击 Endpoints,然后点击右上角的 Create Endpoint。

    会显示 Create endpoint 页面。

    Verify endpoint service

  3. 选择 Endpoint services that use NLBs and GWLBs。

  4. 输入你在 step 1 获取的 service name。

  5. 点击 Verify service。

  6. 在下拉列表中选择你的 VPC。展开 Additional settings 并勾选 Enable DNS name 复选框。

  7. 在 Subnets 区域,选择你的 平凯云 Starter 或 Essential 实例所在的 availability zone,并选择 Subnet ID。

  8. 在 Security groups 区域,正确选择你的安全组。

  9. 点击 Create endpoint。

然后你可以通过私有 DNS name 连接到端点 service。

Step 3. 在平凯数据库云服务中授权你的私有端点

创建 AWS interface 端点后,你可以为目标 平凯云 Starter 或 平凯云 Essential 实例授权该端点以限制访问。

  1. 在 My TiDB 页面,点击目标平凯数据库云服务 Starter 或 Essential 实例的名称,进入其概览页面。

  2. 在左侧导航栏点击 Settings > Networking。

  3. 向下滚动到 Private Endpoint 部分,找到 Authorized Networks 表格。

  4. 点击 Add Rule 添加防火墙规则。

    • Endpoint Service Name:粘贴你在 Step 1 获取的 service name。
    • Firewall Rule Name:输入用于标识此连接的名称。
    • Your VPC Endpoint ID:粘贴你在 AWS Management Console 获取的 22 位 VPC Endpoint ID(以 vpce- 开头)。
  5. 点击 Submit。

Step 4. 连接到你的 平凯云 Starter 或 Essential 实例

创建 interface 端点后,返回平凯数据库云服务控制台并执行以下步骤:

  1. 在 My TiDB 页面,点击目标 平凯云 Starter 或 Essential 实例的名称,进入其概览页面。
  2. 点击右上角的 Connect。此时会显示连接对话框。
  3. 在 Connection Type 下拉列表中,选择 Private Endpoint。
  4. 在 Connect With 下拉列表中,选择你偏好的连接方式。对话框底部会显示相应的连接字符串。
  5. 使用该连接字符串连接到你的 平凯云 Starter 或 Essential 实例。

使用 AWS 设置私有端点(端点独占模型)

在端点独占模型中,每个 平凯云 Essential 实例使用其各自独立的私有端点。此模型无需在连接时包含账户前缀,但你需要为每个 平凯云 Essential 实例重复执行设置步骤。

要使用独占模型通过私有端点连接到 平凯云 Essential 实例,请执行以下步骤:

  1. 选择 平凯云 Essential 实例
  2. 创建 AWS interface 端点
  3. 创建私有端点连接
  4. 启用私有 DNS
  5. 连接到你的 平凯云 Essential 实例

如果你有多个实例,则需要为每个要使用 AWS PrivateLink 连接的实例重复执行这些步骤。

Step 1. 选择 平凯云 Essential 实例

  1. 在平凯数据库云服务控制台的 My TiDB 页面上,点击目标 平凯云 Essential 实例的名称,进入其概览页面。
  2. 点击右上角的 Connect。此时会显示连接对话框。
  3. 在 Connection Type 下拉列表中,选择 Private Endpoint,然后点击 Create Private Endpoint Connection。

Step 2. 创建 AWS interface 端点

在连接对话框中,如果你看到 TiDB Private Link Service is ready 消息,则表示对应的端点服务已就绪。你可以提供以下信息来创建端点。

  1. 在连接对话框中,点击 How to Generate VPC Endpoint ID,然后填写 Your VPC ID 和 Your Subnet IDs 字段。你可以从 AWS Management Console 中找到这些 ID。对于多个子网,请输入以空格分隔的 ID。

  2. 点击 Generate Command 获取以下端点创建命令。

    aws ec2 create-vpc-endpoint --vpc-id ${your_vpc_id} --region ${your_region} --service-name ${your_endpoint_service_name} --vpc-endpoint-type Interface --subnet-ids ${your_application_subnet_ids}

然后,你可以使用 AWS CLI 或 AWS Management Console 创建 AWS interface 端点。

要使用 AWS CLI 创建 VPC interface 端点,请执行以下步骤:

  1. 复制生成的命令并在终端中运行。
  2. 记录刚刚创建的 VPC 端点 ID。

Step 3. 创建私有端点连接

  1. 返回平凯数据库云服务控制台。
  2. 在 Create AWS Private Endpoint Connection 页面上,输入你的 VPC 端点 ID。
  3. 点击 Create Private Endpoint Connection。

Step 4. 启用私有 DNS

在 AWS 中启用私有 DNS。你可以使用 AWS CLI 或 AWS Management Console。

要使用 AWS CLI 启用私有 DNS,请从 Create Private Endpoint Connection 页面复制以下 aws ec2 modify-vpc-endpoint 命令,并在 AWS CLI 中运行。

aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${your_vpc_endpoint_id} --private-dns-enabled

或者,你也可以在实例的 Networking 页面上找到该命令。找到私有端点后,在 Action 列中点击 ... > Enable DNS。

Step 5. 连接到你的 平凯云 Essential 实例

接受私有端点连接后,你会被重定向回连接对话框。

  1. 等待私有端点连接状态从 System Checking 变为 Active(大约 5 分钟)。
  2. 在 Connect With 下拉列表中,选择你偏好的连接方法。对应的连接字符串会显示在对话框底部。
  3. 使用该连接字符串连接到你的实例。

故障排查

I cannot connect to a 平凯云 Starter or Essential instance via a private endpoint after enabling private DNS. Why?

你可能需要在 AWS Management Console 中正确设置 VPC 端点的安全组。前往 VPC > Endpoints。右键点击你的 VPC 端点,然后选择合适的 Manage security groups。应选择 VPC 内允许你的 EC2 实例通过 Port 4000 或自定义端口进行入站访问的安全组。

Manage security groups