kubectl proxy

Synopsis

在 localhost 和 Kubernetes API 服务器之间创建一个代理服务器或应用层网关。它还允许通过指定的 HTTP 路径提供静态内容。所有传入的数据都通过一个端口进入,并转发到远程 Kubernetes API 服务器端口,但匹配静态内容路径的路径除外。

kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]

示例

  # To proxy all of the Kubernetes API and nothing else
  kubectl proxy --api-prefix=/
  
  # To proxy only part of the Kubernetes API and also some static files
  # You can get pods info with 'curl localhost:8001/api/v1/pods'
  kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
  
  # To proxy the entire Kubernetes API at a different root
  # You can get pods info with 'curl localhost:8001/custom/api/v1/pods'
  kubectl proxy --api-prefix=/custom/
  
  # Run a proxy to the Kubernetes API server on port 8011, serving static content from ./local/www/
  kubectl proxy --port=8011 --www=./local/www/
  
  # Run a proxy to the Kubernetes API server on an arbitrary local port
  # The chosen port for the server will be output to stdout
  kubectl proxy --port=0
  
  # Run a proxy to the Kubernetes API server, changing the API prefix to k8s-api
  # This makes e.g. the pods API available at localhost:8001/k8s-api/v1/pods/
  kubectl proxy --api-prefix=/k8s-api

Options

--accept-hosts string     默认值: "^localhost$,^127\.0\.0\.1$,^\[::1\]$"

代理服务器应接受的主机名的正则表达式。

--accept-paths string     默认值: "^.*"

代理服务器应接受的路径的正则表达式。

--address string     默认值: "127.0.0.1"

要服务的 IP 地址。

--api-prefix string     默认值: "/"

代理 API 的前缀。

--append-server-path

如果为 true,则为每个请求启用 kube context 服务器路径的自动追加。

--disable-filter

如果为 true,则禁用代理中的请求过滤。这很危险,当与可访问端口一起使用时,可能会使您容易受到 XSRF 攻击。

-h, --help

proxy 的帮助

--keepalive duration

keepalive 指定活动网络连接的保持活动周期。设置为 0 可禁用 keepalive。

-p, --port int     默认值: 8001

运行代理的端口。设置为 0 可选择一个随机端口。

--reject-methods string     默认值: "^$"

代理服务器应拒绝的 HTTP 方法的正则表达式(例如 --reject-methods='POST,PUT,PATCH')。

--reject-paths string     默认值: "^/api/.*/pods/.*/exec,
^/api/.*/pods/.*/attach"

代理服务器应拒绝的路径的正则表达式。即使被 --accept-paths 接受,此处指定的路径也将被拒绝。

-u, --unix-socket string

运行代理的 Unix 套接字。

-w, --www string

在指定的前缀下也从给定目录提供静态文件。

-P, --www-prefix string     默认值: "/static/"

如果指定了静态文件目录,则用于提供静态文件的前缀。

继承的父选项

--as string

为操作假定的用户名。用户可以是常规用户或命名空间中的服务帐户。

--as-group strings

为操作假定的组,此标志可以重复以指定多个组。

--as-uid string

为操作假定的 UID。

--cache-dir string     默认值: "$HOME/.kube/cache"

默认缓存目录

--certificate-authority string

证书颁发机构的证书文件路径

--client-certificate string

TLS 的客户端证书文件路径

--client-key string

TLS 的客户端密钥文件路径

--cluster string

要使用的 kubeconfig 集群名称

--context string

要使用的 kubeconfig 上下文名称

--disable-compression

如果为 true,则选择退出所有到服务器的请求的响应压缩

--insecure-skip-tls-verify

如果为 true,则不会检查服务器证书的有效性。这将使您的 HTTPS 连接不安全。

--kubeconfig string

用于 CLI 请求的 kubeconfig 文件路径。

--kuberc string

用于首选项的 kuberc 文件路径。可以通过导出 KUBECTL_KUBERC=false 功能标志或关闭 KUBERC=off 功能来禁用此功能。

--match-server-version

要求服务器版本与客户端版本匹配

-n, --namespace string

如果存在,则为本次 CLI 请求的命名空间范围

--password string

API 服务器基本身份验证的密码

--profile string     默认值: "none"

要捕获的配置文件名称。选择之一(none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output string     默认值: "profile.pprof"

要将配置文件写入的文件的名称

--request-timeout string     默认值: "0"

在放弃单个服务器请求之前等待的时间。非零值应包含相应的时间单位(例如 1s、2m、3h)。零值表示不超时请求。

-s, --server string

Kubernetes API 服务器的地址和端口

--storage-driver-buffer-duration duration     默认值: 1m0s

存储驱动程序中的写入将缓冲此持续时间,并作为单个事务提交到非内存后端。

--storage-driver-db string     默认值: "cadvisor"

数据库名称

--storage-driver-host string     默认值: "localhost:8086"

数据库主机:端口

--storage-driver-password string     默认值: "root"

数据库密码

--storage-driver-secure

使用安全的数据库连接

--storage-driver-table string     默认值: "stats"

表名

--storage-driver-user string     默认值: "root"

数据库用户名

--tls-server-name string

用于服务器证书验证的服务器名称。如果未提供,则使用用于联系服务器的主机名。

--token string

API 服务器身份验证的 Bearer token

--user string

要使用的 kubeconfig 用户名

--username string

API 服务器基本身份验证的用户名

--version version[=true]

--version, --version=raw 打印版本信息并退出;--version=vX.Y.Z... 设置报告的版本

--warnings-as-errors

将从服务器收到的警告视为错误,并以非零退出代码退出。

另请参阅

  • kubectl - kubectl 控制 Kubernetes 集群管理器

本页面是自动生成的。

如果你打算报告此页面存在的问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

最后修改于 2025 年 9 月 4 日下午 3:30 PST: Update kubectl reference for v1.34 (bdc4bba2a5)