kubectl proxy

提要

在本地主机和 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

选项

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

代理应接受的主机的正则表达式。

--accept-paths string     Default: "^.*"

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

--address string     Default: "127.0.0.1"

监听服务的 IP 地址。

--api-prefix string     Default: "/"

用于提供代理 API 的前缀。

--append-server-path

如果为 true,启用自动路径附加 kube 上下文服务器路径到每个请求。

--disable-filter

如果为 true,禁用代理中的请求过滤。这很危险,与可访问端口一起使用时,可能会使你面临 XSRF 攻击的风险。

-h, --help

proxy 的帮助

--keepalive duration

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

-p, --port int     Default: 8001

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

--reject-methods string     Default: "^$"

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

--reject-paths string     Default: "^/api/.*/pods/.*/exec,
^/api/.*/pods/.*/attach"

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

-u, --unix-socket string

运行代理的 Unix 套接字。

-w, --www string

也从给定目录在指定前缀下服务静态文件。

-P, --www-prefix string     Default: "/static/"

在静态文件目录指定时,服务静态文件的前缀。

继承的父选项

--as string

操作时要模拟的用户名。用户可以是普通用户或命名空间中的服务账户。

--as-group strings

操作时要模拟的组,此标志可以重复以指定多个组。

--as-uid string

操作时要模拟的 UID。

--cache-dir string     Default: "$HOME/.kube/cache"

默认缓存目录

--certificate-authority string

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

--client-certificate string

用于 TLS 的客户端证书文件的路径

--client-key string

用于 TLS 的客户端密钥文件的路径

--cluster string

要使用的 kubeconfig 集群名称

--context string

要使用的 kubeconfig 上下文名称

--default-not-ready-toleration-seconds int     Default: 300

指示默认添加到每个尚未具有此类容忍度的 Pod 的 notReady:NoExecute 容忍度的容忍秒数。

--default-unreachable-toleration-seconds int     Default: 300

指示默认添加到每个尚未具有此类容忍度的 Pod 的 unreachable:NoExecute 容忍度的容忍秒数。

--disable-compression

如果为 true,则选择不对此服务器的所有请求进行响应压缩

--insecure-skip-tls-verify

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

--kubeconfig string

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

--match-server-version

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

-n, --namespace string

如果存在,则表示此 CLI 请求的命名空间范围

--password string

用于对 API 服务器进行基本认证的密码

--profile string     Default: "none"

要捕获的性能配置文件的名称。可选值为 (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output string     Default: "profile.pprof"

写入性能配置文件的文件名

--request-timeout string     Default: "0"

等待单个服务器请求的超时时间长度。非零值应包含相应的时间单位(例如 1s、2m、3h)。零值表示不对请求设置超时。

-s, --server string

Kubernetes API 服务器的地址和端口

--storage-driver-buffer-duration duration     Default: 1m0s

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

--storage-driver-db string     Default: "cadvisor"

数据库名称

--storage-driver-host string     Default: "localhost:8086"

数据库主机:端口

--storage-driver-password string     Default: "root"

数据库密码

--storage-driver-secure

与数据库使用安全连接

--storage-driver-table string     Default: "stats"

表名

--storage-driver-user string     Default: "root"

数据库用户名

--tls-server-name string

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

--token string

用于对 API 服务器进行身份验证的持有者令牌

--user string

要使用的 kubeconfig 用户名称

--username string

用于对 API 服务器进行基本身份验证的用户名

--version version[=true]

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

--warnings-as-errors

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

另请参阅

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

此页面是自动生成的。

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

最后修改于 2024 年 8 月 19 日太平洋标准时间下午 5:14:更新 v1.31 的 kubectl 参考 (59df28c340)