查看原文
其他

小米正式开源Istio管理面板Naftis

作者:小米 搜云库技术团队 2019-04-07
搜云库互联网/架构/开发/运维关注

Naftis 是一个基于 web 的 Istio dashboard,通过任务模板的方式来帮助用户更方便地执行 Istio 任务。 用户可以在 Naftis 中定义自己的任务模板,并填充变量来构造单个或多个构造任务实例,从而完成各种服务治理功能。

功能

1、内部集成了一些常用 dashboard

2、可定制的任务模板支持

3、支持回滚指定任务

4、支持指定根服务节点的服务拓扑图

5、提供查看 Istio 的 Services 和 Pod 的支持

6、开箱即用,通过 Kubectl 相关指令即可快速部署

支持 Istio 1.0

依赖

目前 Naftis 仅支持 Kubernetes,不支持其他容器调度平台。

1、Istio > 1.0

2、Kubernetes >= 1.9.0

3、HIUI >= 1.0.0

HIUI

Naftis 前端 UI 使用由小米前端组开源的 React 组件 HIUI 构建,参考:

https://github.com/XiaoMi/hiui

快速开始
  1. kubectl create namespace naftis && kubectl apply -n naftis -f mysql.yaml && kubectl apply -n naftis -f naftis.yaml

  2. # 通过端口转发的方式访问Naftis

  3. kubectl -n naftis port-forward $(kubectl -n naftis get pod -l app=naftis-ui -o jsonpath='{.items[0].metadata.name}') 8080:80 &

  4. # 打开浏览器访问 http://localhost:8080,默认用户名和密码分别为admin、admin。

详细的部署流程

Kubernetes集群内运行

  1. # 创建Naftis命名空间

  2. $ kubectl create namespace naftis

  3. # 确认Naftis命名空间已创建

  4. $ kubectl get namespace naftis

  5. NAME           STATUS    AGE

  6. naftis         Active    18m

  7. # 部署Naftis MySQL服务

  8. $ kubectl apply -n naftis -f mysql.yaml

  9. # 确认MySQL已部署

  10. NAME                           READY     STATUS    RESTARTS   AGE

  11. naftis-mysql-c78f99d6c-kblbq   1/1       Running   0          9s

  12. naftis-mysql-test              1/1       Running   0          10s

  13. # 部署Naftis API和UI服务

  14. kubectl apply -n naftis -f naftis.yaml

  15. # 确认Naftis所有的服务已经正确定义并正常运行中

  16. kubectl get svc -n naftis

  17. NAME           TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)        AGE

  18. naftis-api     ClusterIP      10.233.3.144    <none>        50000/TCP      7s

  19. naftis-mysql   ClusterIP      10.233.57.230   <none>        3306/TCP       55s

  20. naftis-ui      LoadBalancer   10.233.18.125   <pending>     80:31286/TCP   6s

  21. kubectl get pod -n naftis

  22. NAME                           READY     STATUS    RESTARTS   AGE

  23. naftis-api-0                   1/2       Running   0          19s

  24. naftis-mysql-c78f99d6c-kblbq   1/1       Running   0          1m

  25. naftis-mysql-test              1/1       Running   0          1m

  26. naftis-ui-69f7d75f47-4jzwz     1/1       Running   0          19s

  27. # 端口转发访问Naftis

  28. kubectl -n naftis port-forward $(kubectl -n naftis get pod -l app=naftis-ui -o jsonpath='{.items[0].metadata.name}') 8080:80 &

  29. # 打开浏览器,访问 http://localhost:8080 即可。默认用户名和密码分别为admin、admin。

本地运行

数据移植

  1. # 执行sql语句

  2. mysql> source ./tool/naftis.sql;

  3. # 将in-local.toml中的数据库的DSN配置替换成本地数据库实例的DSN。

启动API服务
  • Linux

  1. make build && ./bin/naftis-api start -c config/in-local.toml

  1. ./run

  • Mac OS

  1. GOOS=darwin GOARCH=amd64 make build && ./bin/naftis-api start -c config/in-local.toml

  1. GOOS=darwin GOARCH=amd64 ./run

配置Nginx代理
  1. cp tool/naftis.conf <your-nginx-conf-directory>/naftis.conf

  2. # 酌情修改naftis.conf文件并reload nginx

启动前端Node代理
  1. cd src/ui

  2. npm install

  3. npm run dev

  4. # 打开浏览器访问 http://localhost:5200。

预览

Dashboard

Dashboard页面集成了一些常用的图表,比如请求成功率、4XX请求数量等。

服务管理

服务详情

服务详情页面可以查看查看已部署到Kubernetes中服务信息。

服务Pod和拓扑图等

服务详情页面可以查看指定服务Pod和拓扑图等信息。

任务模板管理

任务模板列表

任务模板列表也可以查看已经添加好的任务模板卡片列表。

查看指定模板

点击“查看模板”可以查看指定模板信息。

新增模板

点击“新增模板”可以向系统中新增自定义模板。

创建任务

初始化变量值。

确认变量值。

提交创建任务的分步表单。

Istio诊断

Istio诊断页面可以查看Istio Service和Pod状态。

Docker镜像

Naftis的API和UI镜像已经发布到Docker Hub上,见api和ui。

开发者指南

获取源码

  1. go get github.com/xiaomi/naftis

配置环境变量

将下述环境变量添加到 ~/.profile。我们强烈推荐通过autoenv来配置环境变量。

  1. # 根据环境改变GOOS和GOARCH变量

  2. export GOOS="linux"   # 或替换成"darwin"

  3. export GOARCH="amd64" # 或替换成"386"

  4. # 把USER修改成你自己的DockerHub用户名

  5. export USER="sevennt"

  6. export HUB="docker.io/$USER"

如果你使用autoenv,则输入 cd.来使环境变量生效。

Go依赖

我们目前使用dep管理依赖。

  1. # 安装dep

  2. go get -u github.com/golang/dep

  3. dep ensure -v # 安装Go依赖

    其他指令
    1. make                 # 编译所有 targets

    2. make build           # 编译 Go 二进制文件、前端静态资源、Kubernetes清单

    3. make build.api       # 编译 Go 二进制文件

    4. make build.ui        # 编译前端静态资源

    5. make build.manifest  # 编译Kubernetes清单

    6. make fmt   # 格式化 Go 代码

    7. make lint  # lint Go 代码

    8. make vet   # vet Go 代码

    9. make test  # 运行测试用例

    10. make tar   # 打包成压缩文件

    11. make docker      # 编译 docker 镜像

    12. make docker.api  # 编译后端 docker 镜像

    13. make docker.ui   # 编译前端 docker 镜像

    14. make push        # 把镜像推送到 Docker Hub

    15. ./bin/naftis-api -h       # 显示帮助信息

    16. ./bin/naftis-api version  # 显示版本信息

    17. ./tool/genmanifest.sh  # 本地渲染Kubernetes部署清单

    18. ./tool/cleanup.sh      # 清理已部署的Naftis

    其他

    Naftis目前已在Github开源 ,目前功能还比较薄弱,希望更多志同道合的朋友一起参与进来共同完善落地Istio生态。

    https://github.com/XiaoMi/naftis

    往期精彩文章


    福利:1024程序员节送 1500G 架构师视频

    陆奇:除了写好代码,工程师怎样才算优秀?

    面试题:2018最全Redis面试题整理

    面试题:96道常考Java面试题,分享给大家,含答案

    面试题:70道Spring面试题和答案

    微服务:架构下静态数据通用缓存机制

    微服务:小型系统如何“微服务”开发

    微服务:深入理解为什么要设计幂等性的服务

    微服务:有赞服务化架构演进

    缓存穿透:缓存雪崩解决方案分析

    搭建大众点评CAT实时应用监控平台

    应用消息中间件设计可以解决哪些实际问题?

    理解大型分布式架构的演进历史、技术原理、最佳实践

    大数据推荐系统实时架构和离线架构

    长按:二维码关注

    专注于开发技术研究与知识分享

    公众号回复:”进群” 加微信群深入交流

    回复 1024 可获1500G架构师视频

      您可能也对以下帖子感兴趣

      文章有问题?点此查看未经处理的缓存