Skip to main content

Kube-Debugger is a Kubernetes CLI Tool which will help you debug your cluster

Project description

K8S-Debugger: Diagnose-Your-K8S-Environment

K8S-Debugger is a Kubernetes Diagnosing tool, which helps developers debug what's wrong with their cluster, This will save developers time, as they don't have to deep dive into Logs and try to understand as K8S-Debugger does it for you

Version 0.0.1 Features

  1. Pod Debugging : The V1 is a start of the project, and this is only going to debug the pod based issues, although there are multiple pod based issues that can occur in a kubernetes cluster, but Apparently most frequent and most occuring errors have been included in this iteration

  2. AI Feature : Some Pod based errors in K8S cluster might not be detected by the tool. In that case i would highly encourage you to use --explain feature, ensure to setup GROQ_API_KEY before using the --explain feature

Installation

PIP Installation

pip install kube-debugger

Git Setup

Create venv

On Windows

python -m venv venv
venv/Scripts/activate

On Linux/MacOs

python3 -m venv venv
source venv/bin/activate

Clone Repo

git clone https://github.com/Ayushmishra05/KubeDebugger.git 

GROQ API KEY SETUP

  • Step 1: Head over to groq.com and get your free API KEY

  • Step 2: Setup GROQ_API_KEY in your system environment variables

export GROQ_API_KEY=<api_key> 

⚠️ Remember: AI is an Experimental feature, and we will soon rollout the working Version

Contributions are Encouraged

  • I would love to know your perspective
  • Create a Pull Request or reach out to me at ayush89718@gmail.com
  • Star the Repository for future references

Made with ❤️ for K8S Community by Ayush Mishra

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kube_debugger-0.0.1.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kube_debugger-0.0.1-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file kube_debugger-0.0.1.tar.gz.

File metadata

  • Download URL: kube_debugger-0.0.1.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for kube_debugger-0.0.1.tar.gz
Algorithm Hash digest
SHA256 37a01cfefca856729f0c7c63ac22547c37fbab8306ea8573569e7db91ce1d564
MD5 46d78b147433514c6b316bbff81a0922
BLAKE2b-256 354a000f21b805fa579e19c1efc3e58f9c2d652deab16688abe0867fb5cb98bd

See more details on using hashes here.

File details

Details for the file kube_debugger-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: kube_debugger-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for kube_debugger-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e61322ee58e849c817133ebe584bf729728541409d04fed4279ad0a7d2950775
MD5 b068076718558a54d5a31c9969d3e524
BLAKE2b-256 7e9a8c879fa761fb4cc7a0a6506fff783a043f05d1cf227df00c0005bf930a6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page