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.2.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.2-py3-none-any.whl (2.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kube_debugger-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 41a8ae312b4c965431a074fb5687c2cdd88a5a54cda2553c7ac3b567a6646fa4
MD5 1be0f1df3600221d97ca61d9f526b8b1
BLAKE2b-256 09ba8e99010309a2849015df233e6c500be28ff1c525bc419c7b5dd23d4438e0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kube_debugger-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 2.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6c1558a73ffa4e4ec7cad8d10111d870261533cfb855598ff15f7fc4d2084c14
MD5 bfcbf8e130a4906190d32124a7920356
BLAKE2b-256 ecc9cc463dce59c48ae1f1a5a9613ae22477a4d6cceb6fbe80405db82515c4a0

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