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

How To ?

kubectl get pods

Output

debug pod pod2

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.5.tar.gz (11.1 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.5-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kube_debugger-0.0.5.tar.gz
  • Upload date:
  • Size: 11.1 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.5.tar.gz
Algorithm Hash digest
SHA256 c05219b4409ab46ecc7c8a4385aa76b0f412febab445f46665857b83a6c36d73
MD5 88cc00668bf5b01275ded04a3af0b30b
BLAKE2b-256 8560d61a41f207a71a844858806e6f1f10568ea72319348af2e5f39fd23abab8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kube_debugger-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 12.8 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5c6ff755f9dc23f4f4dbb60bf63a76ad5f6aec3648aac039fab41c61eb1b4b2d
MD5 cefb4d77dbb965616e029e44f0cc842c
BLAKE2b-256 3a70a351e04596671d140f7bd2f682c59256ca8919007e818aba98d2ebbc20d8

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