借助 Kuboard Proxy
,登录 Kuboard 的用户可以直接访问 Service/Pod,而无需为 Service 做额外的 NodePort、Ingress 等配置。Kuboard Proxy 是 kubectl proxy
命令一种替代选项。
与 kubectl proxy
相比:
- 用户可以直接在 Kuboard 界面进行操作,而无需使用命令行;
- 用户权限控制;
- 支持更加细致的 rebase 控制;
- 可以对接支持 Auth-Proxy 认证方式的后端服务,实现单点登录,例如 Grafana。
本文后面的章节将描述 Kuboard Proxy 的基本使用方法。并有另外三篇文档对 Kuboard Proxy 做进一步的阐述:
- 授权用户访问 Kuboard Proxy
- 为什么我的网页通过 Kuboard Proxy 代理后显示不正常 - Rebase - (少数情况)
- 通过 Auth-Proxy 实现 Grafana 与 Kuboard 的单点登录
按照如下步骤,可以非常方便地使用 Kuboard Proxy:
-
进入工作负载查看页面,此处以 导入 example 中导入的 web-example 作为例子,如下图所示:
如果您看不到途中的 代理 按钮,很可能是您的 Kuboard 版本低于 v1.0.7-beta.4;也可能是因为您没有该Service 的
service/proxy
对应的权限,请参考 授权用户访问 KuboardProxy -
点击上图中的 代理 按钮,将打开如下界面:
界面中显示了三个区域:
-
KuboardProxy 代理配置信息,点击 修改 按钮后可以 修改KuboardProxy配置;
-
KuboardProxy 代理发现信息(显示了此次所获得 Token 的有效期);
-
访问代理目标(显示了代理的进一步操作区):
- 选择代理协议,此处支持
http
、https
两种选择,该协议要访问的容器内端口所支持的协议; - 选择访问方法,可以直接在浏览器中打开网页,也可以通过 crul/postman 等测试工具调用容器内的 restful 接口。
- 选择代理协议,此处支持
-
-
通过代理访问目标 Service
KuboardProxy代理的设置有:
- 环境变量
- 全局生效;
- 代理设置
- 只针对 Service/Pod 的单个端口代理生效;
与 KuboardProxy 相关的环境变量有如下两个:
名称 | 变量类型 | 默认值 | 描述 |
---|---|---|---|
KUBOARD_AUTH_ENCRYPT_KEY | String | 随机 | |
KUBOARD_PROXY_COOKIE_TTL | Long | 36000 |
在 KuboardProxy 对话框上,点击 修改 按钮,可以修改针对该端口的 KuboardProxy 设置参数,如下图所示:
可以配置的参数有:
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
用户名添加到 Header | String | X-WEBAUTH-USER | Auth-Proxy 重要参数 |
组名添加到 Header | String | X-WEBAUTH-GROUP | Auth-Proxy 重要参数 |
Cookie TTL / 单位:秒 | Long | 环境变量KUBOARD_PROXY_COOKIE_TTL 或36000 |
Cookie 的有效时长 |
禁用 Rebase | Boolean | false | 禁用 Rebase |
使用 kubectl proxy
之前,请确保您已经 在客户端配置 kubectl。如果已经配置,可按照如下步骤使用 kubectl proxy
。
-
执行命令以启动
kubectl proxy
程序$ kubectl proxy
-
通过代理访问您的服务/Pod:
- 以上述
example
名称空间的 Serviceweb-example
为例,如需要使用 http 协议访问该 Service 的 80 端口,实现上面使用 Kuboard Proxy 的例子中一样的访问效果,请在浏览器打开如下链接:
http://localhost:8001/api/v1/namespaces/example/services/https:web-example:80/proxy/
- 以上述