Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erda-project/kubeprober
Large-scale Kubernetes cluster diagnostic tool.
https://github.com/erda-project/kubeprober
cluster-analysis docker go golang k8s kubernetes observability
Last synced: 5 days ago
JSON representation
Large-scale Kubernetes cluster diagnostic tool.
- Host: GitHub
- URL: https://github.com/erda-project/kubeprober
- Owner: erda-project
- License: apache-2.0
- Created: 2021-06-09T01:52:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T05:31:12.000Z (10 months ago)
- Last Synced: 2024-11-04T13:37:31.708Z (12 days ago)
- Topics: cluster-analysis, docker, go, golang, k8s, kubernetes, observability
- Language: Go
- Homepage:
- Size: 268 MB
- Stars: 136
- Watchers: 16
- Forks: 39
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- awesome-k8s - kubeprober - scale Kubernetes clusters. (Kubernetes tooling)
README
English | [简体中文](./README_CN.md)
# KubeProber
### [Home](https://k.erda.cloud) | [Document](https://docs.erda.cloud/latest/manual/eco-tools/kubeprober/guides/introduction.html) | [RoadMap](./docs/roadmap.md)
## Demo
## What is KubeProber?
KubeProber is a diagnostic tool designed for large-scale Kubernetes clusters. It is used to perform diagnostic items in the kubernetes cluster to prove that the functions of the cluster are normal, KubeProber has the following characteristics:
* **Large-scale clusters support** Supports multi-cluster management, supports configuring the relationship between clusters and diagnostic items on the management side and viewing the diagnostic results of all clusters in a unified manner;
* **Cloud Native** The core logic is implemented by [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/), providing complete Kubernetes API compatibility;
* **Extensible** Support user-defined diagnostic items
Different from the monitoring system, KubeProber proves the functions of the cluster are normal from the perspective of diagnostic. Monitoring is a forward link and cannot cover all scenarios in the system. The monitoring data of each environment in the system is normal and cannot prove the system is 100% normal, so a tool is needed to prove the availability of the system from the reverse, and fundamentally to discover unavailable points in the cluster before users, such as:
* Whether all nodes in the set can be scheduled, whether there are special taints, etc;
* Whether the pod can be normally created, destroyed, and verified the entire link from kubernetes, kubelet to docker;
* Create a service and test unicom to verify whether the kube-proxy link is normal;
* Resolve an internal or external domain name to verify whether CoreDNS is working properly;
* Visit an ingress domain name to verify whether the ingress component in the cluster is working properly;
* Create and delete a namespace to verify whether the related webhook is working properly;
* Perform operations such as put/get/delete on Etcd to verify whether Etcd is running normally;
* Verify the normal operation of MySQL through the operation of mysql-client;
* Simulate users to log in and operate the business system to verify whether the main business process is frequent;
* Check whether the certificates of each environment have expired;
* Expiration check of cloud resources;
* ... more!
## Architecture
### probe-master
The operator running on the management cluster. This operator maintains two CRDs, one is Cluster, which is used to manage the managed cluster, and the other is Probe, which is used to manage the built-in and user-written diagnostic items, probe-master Through watch these two CRDs, the latest diagnostic configuration is pushed to the managed cluster, and probe-master provides an interface for viewing the diagnosis results of the managed cluster.
### probe-agent
The operator running on the managed cluster. This operator maintains two CRDs. One is a Probe that is exactly the same as the probe-master. The probe-agent executes the cluster’s diagnostic items according to the definition of the probe. The other is ProbeStatus for Record the diagnosis results of each Probe. Users can view the diagnosis results of the cluster through kubectl get probestatus in the managed cluster.
## Getting started
Get start with this [doc](https://docs.erda.cloud/latest/manual/eco-tools/kubeprober/guides/install.html).
## To start developing kubeprober
You can run and build probe-master and probe-agent locally. please make sure that ~/.kube/config can access the kubernetes cluster.
### install crd && webhook resources
```
make dev
```
### run probe-master
```
APP=probe-master make run
```
### 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
```
### run probe-agent
```
APP=probe-agent make run
```
probe-agent parameters precedence order and format
```
# precedence order and format, each item takes precedence over the item below it, (e.g --cluster-name)
flag --cluster-name
env CLUSTER_NAME
config cluster_name
default
```
### build binary file
```
APP=probe-master make build
APP=probe-agent make build
```
### build image
```
# 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
```
### Write your prober
[custom probes](./probers/README.md)
## Contributing
Contributions are always welcomed. Please refer to [Contributing to KubeProber](CONTRIBUTING.md) for details.
## Contact Us
If you have any questions, please feel free to contact us.
- Email: [email protected]
- Zhihu：[Erda技术团队](https://www.zhihu.com/people/erda-project) (A Chinese knowledge community, similar to Quora.)
- WeChat Official Account:
## License
KubeProber is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.