Skip to main content

AI-native Kubernetes Operational Workspace

Project description

🚀 Kubsome

AI-native Kubernetes Operational Workspace

Faster debugging. Safer operations. Less cognitive load.

Install

From PyPI (recommended)

pip install kubsome
kubsome init              # Generate default config
kubsome                   # Start

With optional features:

pip install "kubsome[tui]"   # + Full-screen TUI
pip install "kubsome[all]"   # Everything

From source

git clone https://github.com/aloketewary/kubsome.git && cd kubsome && ./install.sh

Docker

docker run -p 8000:8000 -v ~/.kube:/root/.kube ghcr.io/aloketewary/kubsome:latest

Helm

helm install kubsome deploy/helm/kubsome/ -n kubsome --create-namespace

Quick Start

kubsome                          # Interactive CLI
kubsome serve                    # API + Web UI (auto-opens browser)
kubsome tui                      # Full-screen terminal dashboard
kubsome --exec "pods"            # Single command (CI/CD)

Commands (100+)

Type help inside Kubsome for the full list. Highlights:

# Observe
overview                         # Cluster dashboard + anomaly alerts
pods                             # Pod list with health
pods watch                       # Live monitoring
top pods                         # CPU/memory usage
uptime                           # Cluster availability
scorecard                        # A-F health grade

# Operate
logs payment                     # Fuzzy-match pod logs
correlate-logs pod-a pod-b       # Multi-pod log timeline
rollout billing-api              # Rollout status
restart gateway                  # Rolling restart
scale payment 5                  # Scale replicas
rollback-preview billing         # Diff before rollback

# Diagnose
inspect customer                 # Deep pod inspection
diagnose payment                 # Root cause analysis + playbook
dep-health payment-api           # Dependency health map
trace payment-api                # Resource relationship map
fix payment-api                  # Auto-remediate (non-prod)

# AI (natural language)
why is payment-api failing       # Root cause explanation
how many customer pods running   # Pod count
is it safe to restart billing    # Risk analysis
summarize cluster health         # Health summary
what changed recently            # Activity analysis

# kubectl (fuzzy)
describe pod customer            # Fuzzy → full inspect view
get pods                         # Pretty table
kubectl describe customer        # Auto-resolves pod name
delete pod billing               # Fuzzy match + confirm

# Cost & Security
cost-estimate                    # $/month per deployment
security                         # Misconfiguration scan
optimize                         # Resource right-sizing

# Monitoring
watch-alert payment crash        # Background monitor
watch-status                     # Active watches
diff-timeline                    # What changed in 24h
pin "health" "scorecard"         # Save query for dashboard
pins                             # List saved queries

# Incident Mode
incident start API outage        # Start tracking
note found OOM in payment        # Add observation
incident stop                    # Close & export report

Features

  • NLP Intent Engine — structured intent classification + entity extraction
  • Fuzzy matching — type partial names, Kubsome finds the resource
  • Smart suggestions — typo correction ("Did you mean: pods")
  • Natural language — "show me logs for payment" just works
  • AI disambiguation — asks which pod when multiple match
  • Auto-remediation — safe auto-fix with production guard
  • Cluster scorecard — A-F grade across 4 dimensions
  • Cost estimation — $/month per deployment
  • Dependency health — find root cause via service graph
  • Watch & alert — background monitoring with notifications
  • 26 runbooks — step-by-step remediation guides
  • Command chainingpods && events && alerts
  • Aliasesp=pods, o=overview, d=diagnose, l=logs
  • Bookmarks — save and recall frequent commands
  • Workflows — chain commands into reusable sequences
  • Watch modewatch <any-command> for live refresh
  • Multi-pod log correlation — merged timeline from multiple pods
  • YAML diff — side-by-side revision comparison
  • Multi-cluster compare — drift detection between environments
  • Export — Markdown/JSON reports for sharing
  • Audit log — tracks all destructive operations
  • Plugin system — extend with custom commands
  • 114 tests — comprehensive test coverage

Requirements

  • Python 3.9+
  • kubectl configured with cluster access
  • metrics-server (for top commands)

Configuration

Settings in ~/.kubsome/config.yaml:

refresh_interval: 2
notifications: true
theme: dark                      # dark, light, minimal, hacker
aliases:
  p: pods
  o: overview
  d: diagnose
llm:
  provider: local                # or: ollama

Architecture

User Input
   ↓
Command Resolver (exact match)
   ↓ (not found)
Rule-Based NLP (regex patterns)
   ↓ (not found)
Intent Engine (fuzzy classification + entity extraction)
   ↓ (not found)
Suggestion Fallback ("Did you mean: pods")
main.py              → Entry point (CLI, serve, tui, exec)
core/nlp/            → Intent engine (intents, matcher, actions)
core/ai/             → 8 intelligence modules + 26 playbooks
core/collectors/     → 30+ data collectors
core/renderers/      → 21 presentation renderers
core/diagnostics/    → Root cause engine
core/remediation.py  → Auto-fix with safety guards
core/watch_alert.py  → Background condition monitoring
core/cache.py        → TTL cache for kubectl calls
api/                 → FastAPI REST + WebSocket backend
ui/                  → Angular 20 + PrimeNG web dashboard
deploy/helm/         → Helm chart for in-cluster deployment
tests/               → 114 tests

Web UI

Access at http://localhost:8000/app after kubsome serve.

Pages: Dashboard, Monitor, Pods, Events, Metrics, Deployments, Logs, Jobs, RBAC, Network, Resources, Scorecard, Cost, Runbooks, Compare, AI Assistant, Terminal, Settings.

See docs/web-ui.md for detailed page descriptions.

Documentation

License

MIT

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

kubsome-1.9.1.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

kubsome-1.9.1-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file kubsome-1.9.1.tar.gz.

File metadata

  • Download URL: kubsome-1.9.1.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kubsome-1.9.1.tar.gz
Algorithm Hash digest
SHA256 3f9d61fd3736c4b6d31d12c0b8f19e521b2bb2e0a645d6d8346300d5c5699654
MD5 cc320bf11e1c8a059c0ce6bace1529fd
BLAKE2b-256 50df2fe1cb3b01a37d895d771d3094737826dbef30dfc31394bf3b9537c54652

See more details on using hashes here.

Provenance

The following attestation bundles were made for kubsome-1.9.1.tar.gz:

Publisher: workflows.yml on aloketewary/kubsome

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kubsome-1.9.1-py3-none-any.whl.

File metadata

  • Download URL: kubsome-1.9.1-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kubsome-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04b1fd1bc4eb20a5f5b844b67d8c39610f8cdf7e6c131b4a29a168683d8cc670
MD5 dd0fc7d85e87309772e227066003cad9
BLAKE2b-256 85d71d21e72aba86a82397ba3851cc589ad291d343b3343ddb906c7faa905d72

See more details on using hashes here.

Provenance

The following attestation bundles were made for kubsome-1.9.1-py3-none-any.whl:

Publisher: workflows.yml on aloketewary/kubsome

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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