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
-
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
-
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kube_debugger-0.0.3.tar.gz.
File metadata
- Download URL: kube_debugger-0.0.3.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a8604477333dbe2b234e68dd60295e97a00b1db7d5704aa371e0a61baea522e
|
|
| MD5 |
10d584b9c2b757588d3e30c75f5648ae
|
|
| BLAKE2b-256 |
1391470ab91df8280410ca8f2c16f1d80ed04aca56750c7f02acfde2863c1a49
|
File details
Details for the file kube_debugger-0.0.3-py3-none-any.whl.
File metadata
- Download URL: kube_debugger-0.0.3-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e7a2e998c961521e68b3c82b942019199560e0065dd1eb41fabe1a7afdf420e
|
|
| MD5 |
0b5d8d2cbe26f0426bfd1256b5d07c32
|
|
| BLAKE2b-256 |
77ef8d416bb2c72583dc90d7be5bfd682d03613136ed72a4217345db670580fd
|