https://github.com/emirozer/kubectl-doctor

kubectl cluster triage plugin for k8s - 🏥 (brew doctor equivalent)
https://github.com/emirozer/kubectl-doctor

kubernetes kubernetes-cluster kubernetes-deployment kubernetes-monitoring

Last synced: 3 months ago
JSON representation

kubectl cluster triage plugin for k8s - 🏥 (brew doctor equivalent)

• Host: GitHub
• URL: https://github.com/emirozer/kubectl-doctor
• Owner: emirozer
• License: apache-2.0
• Created: 2019-07-23T08:25:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T14:33:46.000Z (over 2 years ago)
• Last Synced: 2024-08-02T06:14:11.558Z (6 months ago)
• Topics: kubernetes, kubernetes-cluster, kubernetes-deployment, kubernetes-monitoring
• Language: Go
• Homepage:
• Size: 77.1 KB
• Stars: 353
• Watchers: 6
• Forks: 26
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kubectl-plugins - kubectl-doctor - scan your cluster for anomalies (brew doctor equivalent) | Uncategorized | [](https://github.com/emirozer/kubectl-doctor/stargazers) | (kubectl Plugins / Installing plugins via awesome-kubectl-plugins)

README

        
# Kubernetes CLI Plugin - Doctor

This plugin is inspired from [brew](http://brew.sh/) doctor :) It will scan your currently `target`ed k8s cluster to see if there are anomalies or useful action points that it can report back to you.

This plugin does *not* change any state or configuration, it merely just scans and gathers information than reports back anomalies in yaml format.

![Demo](./docs/example.svg)

## Install

1. Download a zip that contains the binary from [releases](https://github.com/emirozer/kubectl-doctor/releases) that is compatible with your os/arch

2. Unzip to get `kubectl-doctor`  (or `kubectl-doctor.exe` if windows)

3. Add it to your `PATH`

## Usage

When the plugin binary is found from `PATH` you can just execute it through `kubectl` CLI

```shell

kubectl doctor

```

## Current list of anomaly checks

* core component health (etcd cluster members, scheduler, controller-manager)

* orphan endpoints (endpoints with no ipv4 attached)

* persistent-volume available & unclaimed

* persistent-volume-claim in lost state

* k8s nodes that are not in ready state

* orphan replicasets (desired number of replicas are bigger than 0 but the available replicas are 0)

* leftover replicasets (desired number of replicas and the available # of replicas are 0)

* orphan deployments (desired number of replicas are bigger than 0 but the available replicas are 0)

* leftover deployments (desired number of replicas and the available # of replicas are 0)

* leftover cronjobs (last active date is more than 30 days)