- 🧩0. KubeDoor 组件说明
- ✨1. 全新部署(您的K8S没有部署监控系统)
- 🧱2. 独立部署ClickHouse与VictoriaMetrics
- 🎭3. 接入部署(已经有完整的多K8S监控系统)
- kubedoor-master: 对接agent,提供api接口
- kubedoor-web: 前端界面,整合nginx
- kubedoor-dash: Grafana
- kubedoor-alarm: 接收alertmanager的告警,执行通知与入库
- kubedoor-collect: 定时任务,调用api采集高峰期资源
- alertmanager: 告警路由服务
- vmalert: 告警规则计算与管理,触发告警后通知到alertmanager
- VictoriaMetrics: 时序数据库
- ClickHouse:列式数据库
- kubedoor-agent: 对接master,调用K8S API
- vmagent: 替代Prometheus,采集监控指标
- KubeStateMetrics: 获取K8S的指标
- NodeExporter: 获取主机的指标
### 【下载helm包】
wget https://StarsL.cn/kubedoor/kubedoor-1.6.0.tgz
tar -zxvf kubedoor-1.6.0.tgz
cd kubedoor
- master部署:
- 配置文件修改:
values-master.yaml
| 变量名 | 描述 |
|---|---|
storageClass |
【特别注意】默认的部署方案会把ClickHouse(单机版)和VictoriaMetrics(单机版)都部署在K8S(kubedoor命名空间)内,这2个服务需要存储,注意要填写正确您K8S的storageClass。 |
CK_PASSWORD |
【可保持默认】自动部署ClickHouse时会将这个密码设置为default用户的密码。 |
external_labels_key |
【可保持默认】这是用于多K8S监控数据,通过远程写方式,写入到同一个时序数据库的场景。使用远程存储时,这个key/value会作为标签增加到每一个指标中,这样通过这个标签就可以区分出指标属于哪个K8S了。注意agent端的external_labels_key要和master端的external_labels_key保持一致。如果是新安装VictoriaMetrics可以使用默认配置的origin_prometheus不变。 |
vm_single |
【可保持默认】自动部署Victoria-Metrics-Single时需要配置的账号密码,存储时长等信息。 |
nginx_auth |
【可保持默认】这个是web登录的账号密码信息,是使用的nginx basic认证,默认设置了2个用户,一个用于web登录,一个用于agent与master通讯使用,可以根据需要修改。 |
MSG_TYPE/MSG_TOKEN |
【需要修改】master端的通知IM类型和机器人token,主要用于告警的默认通知的群机器人,你也可以在alertmanager配置更详细的通知路由。 |
- 完成配置修改后执行检查与安装:
# try
helm upgrade -i kubedoor . --namespace kubedoor --create-namespace --values values-master.yaml --dry-run --debug
# install
helm upgrade -i kubedoor . --namespace kubedoor --create-namespace --values values-master.yaml
- 访问WebUI:使用K8S节点IP + kubedoor-web的NodePort访问,默认账号密码都是
kubedoor - 告警逻辑说明:
vmalert从VictoriaMetrics读取数据,并进行规则比较后,如果触发了告警就会通知到alertmanager,alertmanager收到告警后会路由到kubedoor-alarm进行告警通知和入库。即使您的K8S内已经有alertmanager也不用担心,KubeDoor的alertmanager会安装在kubedoor命名空间,不会冲突。
- agent部署:
- 配置文件修改:
values-agent.yaml
| 变量名 | 描述 |
|---|---|
ws |
agent和master是同一个K8S:配置为ws://kubedoor-master.kubedoor即可,免认证。如果是跨K8S的情况,请配置为您的kubedoor-web外部可访问的地址端口,并按照例子配置认证信息。 |
MSG_TYPE/MSG_TOKEN |
大部分对该K8S的操作会通过该机器人进行通知。(不同的K8S可以配置不同的群机器人) |
OSS_URL |
java服务执行dump、jfr、jstack时会把数据存放到OSS,请填写您的OSS地址。(注意设置允许内网免认证上传) |
external_labels_key |
注意部署到多套K8S时,请保持external_labels_key都相同,并且与kubedoor-master的也相同。 |
external_labels_value |
设置为您的K8S的名称。 |
remoteWriteUrl |
这是vmagent远程写时序数据库的完整URL。agent和master是同一个K8S:配置为http://monit:dduF1E3sj@victoria-metrics.kubedoor:8428/api/v1/write,如果是跨K8S的情况,注意修改victoria-metrics.kubedoor:8428为您的Victoria-Metrics外部可访问的地址端口。注意账号密码是mater配置中的vm_single的账号密码。 |
kube_state_metrics |
如果您开启了vmagent安装,请确保kube_state_metrics也是开启的,vmagent需要采集kubedoor的kube_state_metrics的指标,kube_state_metrics会部署在kubedoor命名空间内,不会与您已有的kube_state_metrics冲突。 |
node_exporter |
如果您的K8S节点已部署node-exporter,请设置为false,否则会冲突。 |
- 完成配置修改后执行检查与安装:
# try
helm upgrade -i kubedoor-agent . --namespace kubedoor --create-namespace --values values-agent.yaml --dry-run --debug
# install
helm upgrade -i kubedoor-agent . --namespace kubedoor --create-namespace --values values-agent.yaml
- 访问KubeDoor-Web,点击
agent管理,找到您部署agent的K8S名称,状态应该是在线,先开启自动采集,设置好高峰期时段,再执行采集:输入需要采集的历史数据时长,点击采集,即可采集历史数据并更新高峰时段数据到管控表。
开启自动采集后,每天凌晨1点会采集前一天的高峰期数据,并将10天内最大资源消耗日的数据写入到更新管控表。
重复执行
采集不会导致重复写入数据,请放心使用;每次采集后都会自动将10天内最大资源消耗日的数据写入到管控表。如果耗时较长,请等待采集完成或缩短采集时长。
如果您是新安装的监控系统,并且已过了当天的高峰期时段,将会无法采集到数据;需要等第二天高峰期时段之后才能采集到数据。
- 在其它的K8S部署agent。
helm upgrade -i kubedoor-agent . --namespace kubedoor --create-namespace --values values-agent.yaml --set tsdb.external_labels_value=xxxxxx
ClickHouse可以使用docker compose在主机上部署。
# 默认使用docker compose运行,部署在/opt/clickhouse目录下。
curl -s https://StarsL.cn/kubedoor/install-clickhouse.sh|sudo bash
# 启动ClickHouse(启动后会自动初始化表结构)
cd /opt/clickhouse && docker compose up -d
VictoriaMetrics可以使用docker compose在主机上部署。
mkdir -p /opt/victoriametrics/data
wget https://StarsL.cn/kubedoor/victoriametrics-docker-compose.yaml -O /opt/victoriametrics/docker-compose.yaml
# 请编辑下载的yaml文件修改账号密码和数据存储时长
cd /opt/victoriametrics/
docker compose up -d
前提1:每个K8S内已经部署Prometheus/vmagent,采集的数据统一远程写到已有的
VictoriaMetrics
前提2:如果使用已有的ClickHouse,需要逐条运行建库建表sql。👉🏻初始化数据库SQL
- master部署:
- master部署和全新部署差别不大,注意下配置部分需要填一些已有资源的值。
- 配置文件修改:
values-master.yaml
| 变量名 | 描述 |
|---|---|
clickhouse.enable |
如果您使用已有的ClickHouse,不需要KubeDoor为你安装,请设置为false |
CK_PASSWORD/CK_HOST/CK_PORT/CK_HTTP_PORT/CK_USER |
根据您已有的ClickHouse信息填写 |
tsdb.type |
根据您已有的时序数据库填写Victoria-Metrics-Single或Victoria-Metrics-Cluster |
external_labels_key |
注意填写您已经在Prometheus/vmagent中配置的external_labels的key,如果您没有配置过请在您的Prometheus/vmagent中新增一个。 |
url/remoteRead/remoteWrite |
单机版配置url即可,集群版需要配置remoteRead/remoteWrite,请按照示例规范填写。 |
MSG_TYPE/MSG_TOKEN |
master端的通知IM类型和机器人token,主要用于告警的默认通知的群机器人,你也可以在alertmanager配置更详细的通知路由。 |
- 完成配置修改后执行检查与安装:
# try
helm upgrade -i kubedoor . --namespace kubedoor --create-namespace --values values-master.yaml --dry-run --debug
# install
helm upgrade -i kubedoor . --namespace kubedoor --create-namespace --values values-master.yaml
- 访问WebUI:使用K8S节点IP + kubedoor-web的NodePort访问,默认账号密码都是
kubedoor - 告警逻辑说明:
vmalert从VictoriaMetrics读取数据,并进行规则比较后,如果触发了告警就会通知到alertmanager,alertmanager收到告警后会路由到kubedoor-alarm进行告警通知和入库。即使您的K8S内已经有alertmanager也不用担心,KubeDoor的alertmanager会安装在kubedoor命名空间,不会冲突。
- agent部署:
- agent部分因为已经有监控系统了,要注意配置中的:monit下面的所有
enable都配置成false,并且需要修改已有的Prometheus/vmagentJOB配置,具体看以下配置说明: - 配置文件修改:
values-agent.yaml
| 变量名 | 描述 |
|---|---|
ws |
agent和master是同一个K8S:配置为ws://kubedoor-master.kubedoor即可,免认证。如果是跨K8S的情况,请配置为您的kubedoor-web外部可访问的地址端口,并按照例子配置认证信息。 |
MSG_TYPE/MSG_TOKEN |
大部分对该K8S的操作会通过该机器人进行通知。(不同的K8S可以配置不同的群机器人) |
OSS_URL |
java服务执行dump、jfr、jstack时会把数据存放到OSS,请填写您的OSS地址。(注意设置允许内网免认证上传) |
external_labels_key |
注意部署到多套K8S时,请保持external_labels_key都相同,并且与kubedoor-master的也相同。 |
external_labels_value |
注意填写您当前K8S已经在Prometheus/vmagent中配置的external_labels的value,如果您没有配置过请在您的Prometheus/vmagent中新增一个。 |
remoteWriteUrl |
如果你的是新K8S没有安装Prometheus/vmagent,但你已有VictoriaMetrics,这里填写的你VictoriaMetrics远程写的地址就行了。如果你的K8S已经安装好了Prometheus/vmagent,那就不用管这个变量,并且下面monit的所有enable都配置成false。 |
monit |
如果你需要安装vmagent,保持下面的所有enable为true即可,如果你已经有Prometheus/vmagent了,monit下面的所有enable都配置成false。 |
-
调整你已有的
Prometheus/vmagentJOB配置(因为您的JOB配置可能与KubeDoor需求的会有不一样,请参考以下配置调整。)配置完成后确保您的有以下指标:- container_cpu_usage_seconds_total
- container_memory_working_set_bytes
- container_spec_cpu_quota
- kube_pod_container_info
- kube_pod_container_resource_limits
- kube_pod_container_resource_requests
-
完成配置修改后执行检查与安装:
# try
helm upgrade -i kubedoor-agent . --namespace kubedoor --create-namespace --values values-agent.yaml --dry-run --debug
# install
helm upgrade -i kubedoor-agent . --namespace kubedoor --create-namespace --values values-agent.yaml
- 访问KubeDoor-Web,点击
agent管理,找到您部署agent的K8S名称,状态应该是在线,先开启自动采集,设置好高峰期时段,再执行采集:输入需要采集的历史数据时长,点击采集,即可采集历史数据并更新高峰时段数据到管控表。
开启自动采集后,每天凌晨1点会采集前一天的高峰期数据,并将10天内最大资源消耗日的数据写入到更新管控表。
重复执行
采集不会导致重复写入数据,请放心使用;每次采集后都会自动将10天内最大资源消耗日的数据写入到管控表。如果耗时较长,请等待采集完成或缩短采集时长。
如果您是新安装的监控系统,并且已过了当天的高峰期时段,将会无法采集到数据;需要等第二天高峰期时段之后才能采集到数据。
- 在其它的K8S部署agent。
helm upgrade -i kubedoor-agent . --namespace kubedoor --create-namespace --values values-agent.yaml --set tsdb.external_labels_value=xxxxxx

