Skip to content

Latest commit

 

History

History
117 lines (89 loc) · 2.91 KB

README.md

File metadata and controls

117 lines (89 loc) · 2.91 KB
Raw

Kubervigil

Kubervigil is a command-line tool for analyzing the health of Kubernetes resources ,API endpoints and API versions in a given namespace. It provides detailed health reports for different Kubernetes resources and checks the status of API endpoints.

Installation

To install Kubervigil, follow these steps:

  1. Clone the repository:
git clone https://github.com/Parthiba-Hazra/kubervigil.git

Change to the project directory:

cd kubervigil

Build the project:

go build

Move the binary to a directory in your system's PATH:

go install

Usage

To use Kubervigil, you need to have a valid kubeconfig file with access to your Kubernetes cluster.

kubervigil check [command]

Commands

Preferred APIversion command

Check preferred api-versions for all resources.

kubervigil check recomapiv

preferred api demo

NOTE: Providing kubeconfig path or namespace is optional if you dont provide config path it will try to get path from ~/.kube/config, and if you dont provide any namespace it will autometically serlect the default namespace.

Compare APIversion command

Check preferred api-version and current api version are same or not for all resources.

kubervigil check compareapiv

compare demo

Current APIversion command

Check current api version for all resources.

kubervigil check currentapiv

current api demo

API Command

Check the preferred Kubernetes API versions for resources in a given namespace.

kubervigil check api --config=<path/to/kubeconfig> --ns=<namespace>

Pods Command

Analyze the health of Pods in a given namespace.

kubervigil check pods --config=<path/to/kubeconfig> --ns=<namespace>

pods demo

Services Command

Analyze the health of Services in a given namespace.

kubervigil check services --config=<path/to/kubeconfig> --ns=<namespace>

service demo

Deployments Command

Analyze the health of Deployments in a given namespace.

kubervigil check deployments --config=<path/to/kubeconfig> --ns=<namespace>

Daemonsets Command

Analyze the health of DaemonSets in a given namespace.

kubervigil check daemonsets --config=<path/to/kubeconfig> --ns=<namespace>

Statefulsets command

Analyze the health of Statefulsets in a given namespace.

kubervigil check statefulsets --config=<path/to/kubeconfig> --ns=<namespace>

Configmaps Command

Analyze the health of ConfigMaps in a given namespace.

kubervigil check configmaps --config=<path/to/kubeconfig> --ns=<namespace>

Ingress Command

Analyze the health of Ingress resources in a given namespace.

kubervigil check ingress --config=<path/to/kubeconfig> --ns=<namespace>

We will be add more helath analysis features. Feel free to contribute..