# kubeprober

**Repository Path**: NQL886/kubeprober

## Basic Information

- **Project Name**: kubeprober
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-07
- **Last Updated**: 2022-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

简体中文 | [English](./README.md)

# KubeProber
###  [官网](https://k.erda.cloud) | [文档](https://docs.erda.cloud/1.4/manual/eco-tools/kubeprober/guides/introduction.html) | [RoadMap](./docs/roadmap_CN.md)

## Demo
![Screenshot](https://static.erda.cloud/images/kc-cn.gif)

## 什么是 KubeProber?
KubeProber 是一个针对大规模 Kubernetes 集群设计的诊断工具，用于在 kubernetes 集群中执行诊断项以证明集群的各项功能是否正常，KubeProber 有如下特点:

* **支持大规模集群** 支持多集群管理，支持在管理端配置集群跟诊断项的关系以及统一查看所有集群的诊断结果；
* **云原生** 核心逻辑采用 [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) 来实现，提供完整的Kubernetes API兼容性;
* **可扩展** 支持用户自定义巡检项。

区别于监控系统，kubeProber 从巡检的角度来证明集群的各项功能是否正常，监控作为正向链路，无法覆盖系统的中的所有场景，系统中各个环境的监控数据都正常，也不能保证系统是 100% 可以用的，因此需要一个工具从反向来证明系统的可用性，根本上做到先于用户发现集群中不可用的点，比如：
* 集中的所有节点是否均可以被调度，有没有特殊的污点存在等；
* pod是否可以正常的创建，销毁，验证从 kubernetes，kubelet 到 docker 的整条链路；
* 创建一个service，并测试连通性，验证 kube-proxy 的链路是否正常；
* 解析一个内部或者外部的域名，验证 CoreDNS 是否正常工作；
* 访问一个 ingress 域名，验证集群中的 ingress 组件是否正常工作；
* 创建并删除一个namespace，验证相关的 webhook 是否正常工作；
* 对Etcd执行 put/get/delete 等操作，用于验证 Etcd 是否正常运行；
* 通过 mysql-client 的操作来验证 MySQL 是否正常运行；
* 模拟用户对业务系统进行登录，操作，验证业务的主流程是否常常；
* 检查各个环境的证书是否过期；
* 云资源的到期检查；
* ... 更多


## 架构
![Kubeprober Architecture](./docs/assets/architecture.jpg)

### probe-master
运行在管理集群上的 operator，这个 operator 维护两个 CRD，一个是 Cluster，用于管理被纳管的集群，另一个是 Probe，用于管理内置的以及用户自己便编写的诊断项，probe-master 通过 watch 这两个 CRD，将最新的诊断配置推送到被纳管的集群，同时 probe-master 提供接口用于查看被纳管集群的诊断结果。

### probe-agent
运行在被纳管集群上的 operator，这个 operator 维护两个 CRD，一个是跟 probe-master 完全一致的 Probe，probe-agent 按照 probe 的定义去执行该集群的诊断项，另一个是 ProbeStatus，用于记录每个 Probe 的诊断结果，用户可以在被纳管的集群中通过kubectl get probestatus 来查看本集群的诊断结果。

## 开始使用
[文档](https://docs.erda.cloud/1.2/manual/eco-tools/kubeprober/guides/install.html)
## 开发

你可以在本地运行以及构建probe-master以及probe-agent，运行之前请确保本地存在~/.kube/config可以访问到kubernetes集群。
### 安装 crd && webhook
```
make dev
```
### 运行probe-master
```
APP=probe-master make run
```
### 运行probe-tunnel
```
# export env get from the create cluster crd
export PROBE_MASTER_ADDR="http://127.0.0.1:8088"
export CLUSTER_NAME="moon"
export SECRET_KEY="a944499f-97f3-4986-89fa-bc7dfc7e009a" 

# run probe-agent
APP=probe-tunnel make run
```

### 运行probe-agent
```
APP=probe-agent make run
```
probe-agent 参数优先级与格式
```
# 优先级从上到下依次降低 (e.g --cluster-name)
flag       --cluster-name
env          CLUSTER_NAME
config       cluster_name
default
```



#### 编译为二进制文件
```
APP=probe-master make build
APP=probe-agent make build
```
#### 构建镜像
```
# build with default version: latest
# output image format: kubeprober/probe-master:latest
APP=probe-master make docker-build

# build with custom version: v0.0.1
# output image format: kubeprober/probe-master:v0.0.1
APP=probe-master V=v0.0.1 make docker-build

# build with default version: latest
APP=probe-agent make docker-build

# push with default version: latest
APP=probe-agent make docker-push

# build & push
APP=probe-agent make docker-build-push
```
### 自定义prober
[custom probes](./probers/README.md)

## 贡献
如果您对本项目想做出贡献，请参考 [Contributing to KubeProber](CONTRIBUTING.md) 。


## 联系
如果您有任何其他问题，欢迎跟我们取得联系。
- 邮箱: erda@terminus.io
- 知乎：[Erda技术团队](https://www.zhihu.com/people/erda-project) 
- 微信公众号:

    ![Erda WeChat](./docs/assets/wechat-small.jpg)
    
## 许可证
KubeProber 遵循 Apache 2.0 许可证。有关详细信息请参见 [LICENSE](LICENSE) 文件。