可视化k8s API文档

介绍

调用k8s API时,查找接口具体使用方式不是很方便。这时可以使用Swagger UI来实现可视化k8s API文档。

Swagger UI允许任何人可视化API的资源并与之交互,而无需任何实现逻辑。它是由OpenAPI(以前称为Swagger)规范自动生成的,可视化文档使后端实现和客户端使用变得容易。

安装

官方文档:https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/

生成api文档
curl -k https://localhost:6443/openapi/v2 > k8s-swagger.json

file

启动swagger-ui容器
docker pull swaggerapi/swagger-ui
docker run -d -p 33080:80 -e SWAGGER_JSON
### 设置和使用 Kubernetes 可视化 Dashboard #### 1. 安装 Kubernetes Dashboard 为了在 Kubernetes 中部署可视化仪表盘,可以按照以下方法操作。首先需要下载官方推荐的 YAML 文件来创建必要的资源对象。 执行命令以应用默认配置文件: ```bash kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.5.0/aio/deploy/recommended.yaml ``` 上述命令会基于指定版本 `v2.5.0` 创建服务账户、角色绑定以及 Deployment 和 Service 资源等必要组件[^2]。 #### 2. 修改访问模式 默认情况下,Kubernetes Dashboard 使用的是 ClusterIP 类型的服务,这意味着它仅能在集群内部被访问。如果希望外部能够连接到该服务,则需将其类型更改为 NodePort 或 LoadBalancer: 编辑服务定义文件: ```bash kubectl edit svc kubernetes-dashboard -n kubernetes-dashboard ``` 找到 `spec.type` 字段并将它的值由 `ClusterIP` 替换为 `NodePort` 后保存退出即可完成更改[^4]。 接着可以通过下面这条指令获取节点端口信息用于后续浏览器登录尝试: ```bash kubectl get svc -A | grep kubernetes-dashboard ``` #### 3. 获取 Token 并实现身份验证 要成功进入管理页面之前还需要准备认证令牌 (Token),这一步骤可通过两种方式达成——利用已存在的管理员权限或者新增特定用途的新用户账号来进行授权处理。 ##### 方法 A: 利用现有超级用户 token 登录 查找名为 admin-user 的 Secret 对象中的 token 数据项作为凭证字符串提交给前端表单字段完成签入动作。 ```bash ADMIN_SECRET=$(kubectl get secrets -n kube-system | grep ^admin-user | awk '{print $1}') DASHBOARD_TOKEN=$(kubectl describe secret ${ADMIN_SECRET} -n kube-system | grep -E '^token' | awk '{print $2}') echo "${DASHBOARD_TOKEN}" ``` 复制打印出来的 token 值,在打开 dashboard 页面之后粘贴至相应位置处填写完毕后点击继续按钮即刻生效[^1]。 ##### 方法 B: 新增自定义用户的 token 认证流程说明文档链接地址如下所示: https://github.com/kubernetes/dashboard/wiki/Creating-an-API-token-for-a-service-account #### 4. 浏览器访问入口 URL 构建指南 当一切准备工作都就绪以后就可以拼接完整的 HTTP 请求路径啦!假设当前运行环境下的任意一台工作机器 IP 地址为 X.X.X.X ,而刚才调整过的 node port 编号设定了 YYYYYY 。那么最终形成的网址应该是类似于这样的形式 http://X.X.X.X:YYYYYY/#/overview?namespace=default 注意替换实际数值部分哦! --- ###
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

柠是柠檬的檬

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值