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

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

开始之前

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

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

创建 MongoDB 部署和服务

  1. 创建一个运行 MongoDB 的 Deployment

    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
    

    查看 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. 创建一个服务以在网络上公开 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 PST: 在文档中说明 27017 是 MongoDB 的官方 TCP 端口 (ea6624ee62)