README.md

kube-jarvis

kube-jarvis is a tool used to inspect kubernetes cluster

Features

• Comprehensively check the cluster health status
• Support a variety of cloud manufacturers
• Highly configurable
• Highly extensible
• Description statements can be customized

Quick start

On any node has "/$HOME/.kube/config"

wget -O -  https://kube-jarvis-1251707795.cos.ap-guangzhou.myqcloud.com/run.sh | bash

Config struct

global:
  trans: "translation" # the translation file dir 
  lang: "en" # target lang 

cluster: 
  type: "custom"

coordinator:
  type: "default"

diagnostics:
  - type: "master-capacity"
  - type: "master-apiserver"
  - type: "node-sys"
  - type: "requests-limits"

exporters:
  - type: "stdout"

  - type: "file"
    name: "for json"
    config:
      format: "json"
      path: "result.json"

Run in docker

login any node of your cluster and exec cmd:

docker run  -i -t docker.io/raylhuang110/kube-jarvis:latest

you can found all docker images here

Run as job or cronjob

create common resource (Namespaces, ServiceAccount ...)

kubectl apply -f manifests/ 

run as job

kubectl apply -f manifests/workload/job.yaml

run as cronjob (default run at 00:00 every day)

kubectl apply -f manifests/workload/cronjob.yaml

Plugins

we call coordinator, diagnostics, evaluators and exporters as "plugins"

you can found all plugins lists here

License

Apache License 2.0 - see LICENSE.md for more details