Skip to main content

Natural language interface for Kubernetes and Amazon EKS

Project description

EKS Speak

A natural language interface for Kubernetes (with Amazon EKS support)

Overview

EKS Speak is a command-line tool that allows users to interact with Kubernetes clusters using plain English commands. It translates natural language queries into proper kubectl commands, making it easier for beginners to work with Kubernetes and for experienced users to speed up common operations.

Features

  • Translate plain English commands to kubectl commands
  • Support for Amazon EKS clusters
  • Context-aware command processing
  • Support for common Kubernetes resources:
    • Pods
    • Services
    • Deployments
    • Nodes
    • ConfigMaps
    • Secrets
    • Namespaces
    • Ingresses

Installation

# Clone the repository
git clone https://github.com/ImRohitSingh/k8s-speak.git

# Navigate to the project directory
cd k8s-speak

# Install the package
pip install -e .

Prerequisites

  • Python 3.6 or higher
  • kubectl installed and in your PATH
  • AWS CLI (for EKS-specific functionality)
  • Valid Kubernetes configuration

Usage

Simply run the k8s-speak command to start the interactive shell:

k8s-speak

For verbose output (helpful for debugging):

k8s-speak -v

Examples

Here are some example commands you can use:

k8s-speak> show all pods in namespace kube-system
k8s-speak> get services in production namespace
k8s-speak> list all deployments in namespace default
k8s-speak> describe pod named my-pod-xyz in namespace app
k8s-speak> show nodes in cluster my-eks-cluster
k8s-speak> get logs for pod web-server in namespace frontend

How It Works

  1. The tool parses your natural language input
  2. It identifies the intent (get, describe, delete, etc.)
  3. It extracts resource types, namespaces, and names
  4. It constructs the appropriate kubectl command
  5. It executes the command and returns the output

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

k8s_speak-0.0.1.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

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

k8s_speak-0.0.1-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file k8s_speak-0.0.1.tar.gz.

File metadata

  • Download URL: k8s_speak-0.0.1.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for k8s_speak-0.0.1.tar.gz
Algorithm Hash digest
SHA256 8c6beb66d6e7822aec59418cee73ec32edf46e0a0c20813376378de1f4b1362d
MD5 4b7fde928b2343df0285bf201b111eac
BLAKE2b-256 28ea858b1f11f06b0e3dd198493a88d1f30eb624e18b59592bb1aa5c6d30ae3b

See more details on using hashes here.

File details

Details for the file k8s_speak-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: k8s_speak-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for k8s_speak-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c26f9ed6896921394bb9f63640634237da9634326d8a53f9e092e5d1adbba58
MD5 a888ade834946e3757f4d47b92a62378
BLAKE2b-256 7a6e51143b5b2e48ae4325392a3bb1d4c6e334353d07aa3819622484fffb4493

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