使用 SOCKS5 代理访问 Kubernetes API

功能状态： Kubernetes v1.24 [稳定]

此页面展示了如何使用 SOCKS5 代理访问远程 Kubernetes 集群的 API。当您要访问的集群没有直接在公共互联网上公开其 API 时，这很有用。

开始之前

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

您的 Kubernetes 服务器必须是 v1.24 或更高版本。要检查版本，请输入 kubectl version。

您需要 SSH 客户端软件（ssh 工具）以及在远程服务器上运行的 SSH 服务。您必须能够登录到远程服务器上的 SSH 服务。

任务上下文

注意

此示例使用 SSH 隧道流量，SSH 客户端和服务器充当 SOCKS 代理。您可以改为使用任何其他类型的 SOCKS5 代理。

图 1 表示您将在本任务中实现的目标。

您有一台客户端计算机，在接下来的步骤中称为本地计算机，您将从这里创建请求以与 Kubernetes API 交谈。
Kubernetes 服务器/API 托管在远程服务器上。
您将使用 SSH 客户端和服务器软件在本地计算机和远程服务器之间创建安全的 SOCKS5 隧道。客户端和 Kubernetes API 之间的 HTTPS 流量将通过 SOCKS5 隧道流动，该隧道本身通过 SSH 隧道。

graph LR; subgraph local[本地客户端机器] client([客户端])-. local
traffic .-> local_ssh[本地 SSH
SOCKS5 代理]; end local_ssh[SSH
SOCKS5
代理]-- SSH 隧道 -->sshd subgraph remote[远程服务器] sshd[SSH
服务器]-- 本地流量 -->service1; end client([客户端])-. 通过代理的 HTTPS 流量
通过代理 .->service1[Kubernetes API]; classDef plain fill:#ddd,stroke:#fff,stroke-width:4px,color:#000; classDef k8s fill:#326ce5,stroke:#fff,stroke-width:4px,color:#fff; classDef cluster fill:#fff,stroke:#bbb,stroke-width:2px,color:#326ce5; class ingress,service1,service2,pod1,pod2,pod3,pod4 k8s; class client plain; class cluster cluster;

图 1. SOCKS5 教程组件

使用 ssh 创建 SOCKS5 代理

以下命令在您的客户端机器和远程 SOCKS 服务器之间启动 SOCKS5 代理

# The SSH tunnel continues running in the foreground after you run this
ssh -D 1080 -q -N username@kubernetes-remote-server.example

SOCKS5 代理允许您根据以下配置连接到集群的 API 服务器

-D 1080：在本地端口 :1080 上打开 SOCKS 代理。
-q：静默模式。导致大多数警告和诊断消息被抑制。
-N：不执行远程命令。对于仅转发端口很有用。
username@kubernetes-remote-server.example：运行 Kubernetes 集群的远程 SSH 服务器（例如：堡垒主机）。

客户端配置

要通过代理访问 Kubernetes API 服务器，您必须指示 kubectl 通过我们之前创建的 SOCKS 代理发送查询。通过设置适当的环境变量或通过 kubeconfig 文件中的 proxy-url 属性来执行此操作。使用环境变量

export HTTPS_PROXY=socks5://localhost:1080

要在特定 kubectl 上下文中始终使用此设置，请在 ~/.kube/config 文件中相关的 cluster 条目中指定 proxy-url 属性。例如

apiVersion: v1
clusters:
- cluster:
    certificate-authority-data: LRMEMMW2 # shortened for readability 
    server: https://<API_SERVER_IP_ADDRESS>:6443  # the "Kubernetes API" server, in other words the IP address of kubernetes-remote-server.example
    proxy-url: socks5://localhost:1080   # the "SSH SOCKS5 proxy" in the diagram above
  name: default
contexts:
- context:
    cluster: default
    user: default
  name: default
current-context: default
kind: Config
preferences: {}
users:
- name: default
  user:
    client-certificate-data: LS0tLS1CR== # shortened for readability
    client-key-data: LS0tLS1CRUdJT=      # shortened for readability

创建了通过前面提到的 ssh 命令创建的隧道，并定义了环境变量或 proxy-url 属性后，您可以通过该代理与您的集群进行交互。例如

kubectl get pods

NAMESPACE     NAME                                     READY   STATUS      RESTARTS   AGE
kube-system   coredns-85cb69466-klwq8                  1/1     Running     0          5m46s

注意

在 kubectl 1.24 之前，大多数 kubectl 命令在使用 socks 代理时都可以正常工作，除了 kubectl exec。
kubectl 支持 HTTPS_PROXY 和 https_proxy 环境变量。这些被其他支持 SOCKS 的程序使用，例如 curl。因此，在某些情况下，最好在命令行上定义环境变量
```
HTTPS_PROXY=socks5://localhost:1080 kubectl get pods
```
使用 proxy-url 时，代理仅用于相关的 kubectl 上下文，而环境变量将影响所有上下文。
k8s API 服务器主机名可以通过使用 socks5h 协议名称而不是上面显示的更常见的 socks5 协议来进一步防止 DNS 泄漏。在这种情况下，kubectl 将要求代理服务器（例如 ssh 堡垒）解析 k8s API 服务器域名，而不是在运行 kubectl 的系统上解析它。还要注意，使用 socks5h 时，类似于 https://localhost:6443/api 的 k8s API 服务器 URL 不会引用您的本地客户端计算机。相反，它引用代理服务器（例如 ssh 堡垒）上已知的 localhost。

清理

通过在运行它的终端上按 CTRL+C 停止 ssh 端口转发进程。

在终端中键入 unset https_proxy 以停止通过代理转发 http 流量。

进一步阅读

OpenSSH 远程登录客户端

上次修改时间：2024 年 2 月 13 日下午 2:14 PST：修复 mermaid 语法错误 (69706582d4)

使用 SOCKS5 代理访问 Kubernetes API

开始之前

任务上下文

注意

使用 ssh 创建 SOCKS5 代理

客户端配置

注意

清理

进一步阅读

反馈