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

本页展示了如何使用 kubectl port-forward 连接到在 Kubernetes 集群中运行的 MongoDB 服务器。这种类型的连接对于数据库调试非常有用。

开始之前

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

    您的 Kubernetes 服务器必须是或高于 v1.10 版本。

    要检查版本，请输入 kubectl version。

  • 安装 MongoDB Shell。

创建 MongoDB 部署和 Service

  1. 创建一个运行 MongoDB 的 Deployment

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

    成功命令的输出验证了 Deployment 已创建

    deployment.apps/mongo created

    查看 Pod 状态以检查其是否已就绪

    kubectl get pods

    输出显示创建的 Pod

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

    查看 Deployment 的状态

    kubectl get deployment

    输出显示 Deployment 已创建

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

    Deployment 会自动管理一个 ReplicaSet。使用以下命令查看 ReplicaSet 状态

    kubectl get replicaset

    输出显示 ReplicaSet 已创建

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

  2. 创建一个 Service 以在网络上暴露 MongoDB

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

    成功命令的输出验证了 Service 已创建

    service/mongo created

    检查创建的 Service

    kubectl get service mongo

    输出显示创建的 Service

    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 PST：在文档中明确说明 27017 是 MongoDB 的官方 TCP 端口 (ea6624ee62)