https://github.com/tkestack/kube-jarvis

https://github.com/tkestack/kube-jarvis

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/tkestack/kube-jarvis
• Owner: tkestack
• License: other
• Created: 2020-02-14T06:58:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-11T02:43:15.000Z (almost 3 years ago)
• Last Synced: 2025-04-02T20:38:35.098Z (over 1 year ago)
• Language: Go
• Size: 533 KB
• Stars: 29
• Watchers: 12
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# kube-jarvis

[![Build Status](https://travis-ci.com/RayHuangCN/kube-jarvis.svg?token=nJm3RqJv2hocVN6fWNzx&branch=master)](https://travis-ci.com/RayHuangCN/kube-jarvis.svg?token=nJm3RqJv2hocVN6fWNzx&branch=master)

[![codecov](https://codecov.io/gh/RayHuangCN/kube-jarvis/branch/master/graph/badge.svg?token=rva9yuTNLO)](https://codecov.io/gh/RayHuangCN/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"

```bash

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

```

# Config struct

```yaml

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:

```bash

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

```

> [you can found all docker images here](https://hub.docker.com/r/raylhuang110/kube-jarvis/tags)

# Run as job or cronjob

create common resource (Namespaces, ServiceAccount ...)

```bash

kubectl apply -f manifests/ 

```

run as job

```bash

kubectl apply -f manifests/workload/job.yaml

```

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

```bash

kubectl apply -f manifests/workload/cronjob.yaml

```

# Plugins

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

> [you can found all plugins lists here](./pkg/plugins/README.md)

# License

Apache License 2.0 - see LICENSE.md for more details