Home

telectl is a Telegram bot for Kubernetes cluster management. Browse pods, deployments, services and more; read logs; scale, restart and exec — all from chat, with per-user RBAC via Kubernetes impersonation.

flowchart LR
    User([Telegram user]) -->|message / callback| TG[Telegram Bot API]
    TG --> Bot[telectl pod]
    Bot --> K8s[(Kubernetes API server)]
    K8s -->|RBAC decision| Bot

📚 Documentation

Getting Started

Quick Start — running in 5 minutes
Installation Guide — binaries, Docker, Helm
Configuration Reference — every config option

User Guides

Menu Navigation — interactive menus
Command Reference — all typed commands
Inline Queries — @telectl … lookups in any chat
Context Management — switch clusters in-session
Monitoring — top, events, watch

Deployment

Try It Locally — kind, minikube, k3d, k3s, MicroK8s
Helm Chart Guide — full Helm reference + RBAC + impersonation
Docker Deployment — running with Docker
Two Deployment Modes — Helm pod vs normal user
Kubernetes RBAC — setting up permissions
Impersonation & RBAC — per-user permissions
Production Checklist — pre-deployment checklist

Development

Architecture Overview — components, data flow, diagrams
How It Works — deep dive into menus, commands, sessions
Development Setup — local dev environment
Contributing Guide — how to contribute
Testing Guide — unit, integration, e2e
Release Process — how releases work
Versioning & Releases — SemVer, K8s-style pre-releases

Operations

Security — tokens, impersonation, least-privilege
Troubleshooting — common issues
FAQ — frequently asked questions
Upgrading — version upgrade procedures
Adopters — who’s using telectl

🔗 Quick Links

⚙️ Helm Chart Repository

Add the chart repo directly from GitHub Pages:

helm repo add telectl https://ksauraj.github.io/telectl/charts
helm repo update
helm install telectl telectl/telectl \
  --namespace telectl --create-namespace \
  --set telegram.botToken="YOUR_BOT_TOKEN"