使用端口转发访问集群中的应用程序

本页面介绍如何使用 kubectl port-forward 连接到 Kubernetes 集群中运行的 MongoDB 服务器。这种连接方式对于数据库调试非常有用。

准备工作

  • 您需要有一个 Kubernetes 集群，并且 kubectl 命令行工具必须配置为与您的集群通信。建议在至少有两个节点且这些节点不充当控制平面主机的集群上运行本教程。如果您还没有集群，可以使用 minikube 创建一个集群，或者可以使用以下 Kubernetes 游乐场之一：

    您的 Kubernetes 服务器版本必须是 v1.10 或更高版本。要检查版本，请输入 kubectl version。
  • 安装 MongoDB Shell。

创建 MongoDB 部署和服务

  1. 创建一个运行 MongoDB 的部署

    kubectl apply -f https://k8s.io/examples/application/mongodb/mongo-deployment.yaml

    成功执行命令的输出将验证是否已创建部署

    deployment.apps/mongo created

    查看 Pod 状态以检查它是否已准备就绪

    kubectl get pods

    输出显示已创建的 Pod

    NAME                     READY   STATUS    RESTARTS   AGE
mongo-75f59d57f4-4nd6q   1/1     Running   0          2m4s

    查看部署的状态

    kubectl get deployment

    输出显示已创建部署

    NAME    READY   UP-TO-DATE   AVAILABLE   AGE
mongo   1/1     1            1           2m21s

    部署会自动管理 ReplicaSet。使用以下命令查看 ReplicaSet 状态：

    kubectl get replicaset

    输出显示已创建 ReplicaSet

    NAME               DESIRED   CURRENT   READY   AGE
mongo-75f59d57f4   1         1         1       3m12s

  2. 创建一个服务以在网络上公开 MongoDB

    kubectl apply -f https://k8s.io/examples/application/mongodb/mongo-service.yaml

    成功执行命令的输出将验证是否已创建服务

    service/mongo created

    检查已创建的服务

    kubectl get service mongo

    输出显示已创建的服务

    NAME    TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)     AGE
mongo   ClusterIP   10.96.41.183   <none>        27017/TCP   11s

  3. 验证 MongoDB 服务器是否正在 Pod 中运行，并且是否正在监听端口 27017

    # Change mongo-75f59d57f4-4nd6q to the name of the Pod
kubectl get pod mongo-75f59d57f4-4nd6q --template='{{(index (index .spec.containers 0).ports 0).containerPort}}{{"\n"}}'

    输出显示该 Pod 中 MongoDB 的端口

    27017

    27017 是 MongoDB 的官方 TCP 端口。

将本地端口转发到 Pod 上的端口

  1. kubectl port-forward 允许使用资源名称（例如 Pod 名称）来选择要转发到的匹配 Pod。

    # Change mongo-75f59d57f4-4nd6q to the name of the Pod
kubectl port-forward mongo-75f59d57f4-4nd6q 28015:27017

    这与以下命令相同：

    kubectl port-forward pods/mongo-75f59d57f4-4nd6q 28015:27017

    或者

    kubectl port-forward deployment/mongo 28015:27017

    或者

    kubectl port-forward replicaset/mongo-75f59d57f4 28015:27017

    或者

    kubectl port-forward service/mongo 28015:27017

    以上任何命令都有效。输出类似于以下内容：

    Forwarding from 127.0.0.1:28015 -> 27017
Forwarding from [::1]:28015 -> 27017

  2. 启动 MongoDB 命令行界面

    mongosh --port 28015

  3. 在 MongoDB 命令行提示符下，输入 ping 命令

    db.runCommand( { ping: 1 } )

    成功的 ping 请求将返回以下内容：

    { ok: 1 }

（可选）让 *kubectl* 选择本地端口

如果您不需要特定的本地端口，可以让 kubectl 选择并分配本地端口，从而避免您必须管理本地端口冲突，语法稍微简单一些：

kubectl port-forward deployment/mongo :27017

kubectl 工具会查找未使用的本地端口号（避免使用低端口号，因为这些端口号可能会被其他应用程序使用）。输出类似于以下内容：

Forwarding from 127.0.0.1:63753 -> 27017
Forwarding from [::1]:63753 -> 27017

讨论

连接到本地端口 28015 的连接将转发到运行 MongoDB 服务器的 Pod 的端口 27017。建立此连接后，您可以使用本地工作站调试在 Pod 中运行的数据库。

后续步骤

详细了解 kubectl port-forward。

上次修改时间：2024 年 2 月 26 日下午 4:59（太平洋标准时间）：在文档中阐明 27017 是 MongoDB 的官方 TCP 端口 (ea6624ee62)