https://github.com/jhzhu89/kubernetes-ai-ops-agent
AI-powered assistant that enables natural language interactions with Kubernetes clusters. Simplifies DevOps workflows using Model Context Protocol (MCP) servers for executing K8s operations through conversational interfaces.
https://github.com/jhzhu89/kubernetes-ai-ops-agent
chainlit kubernetes mcp model-context-protocol openai-agent-sdk prometheus
Last synced: 5 months ago
JSON representation
AI-powered assistant that enables natural language interactions with Kubernetes clusters. Simplifies DevOps workflows using Model Context Protocol (MCP) servers for executing K8s operations through conversational interfaces.
- Host: GitHub
- URL: https://github.com/jhzhu89/kubernetes-ai-ops-agent
- Owner: jhzhu89
- License: mit
- Created: 2025-04-24T05:06:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-29T12:32:14.000Z (5 months ago)
- Last Synced: 2025-04-30T20:58:59.469Z (5 months ago)
- Topics: chainlit, kubernetes, mcp, model-context-protocol, openai-agent-sdk, prometheus
- Language: Python
- Homepage:
- Size: 1.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kubernetes AI Ops Agent
An AI-powered assistant for Kubernetes operations and management through natural language interactions.
## Overview
Kubernetes AI Ops Agent is an intelligent agent that helps DevOps engineers and Kubernetes administrators manage Kubernetes clusters through conversational interfaces. The project leverages Large Language Models (LLMs) to interpret user intents and execute Kubernetes operations using specialized MCP (Model Context Protocol) servers.
## Project Status
**Note**: This project is currently in an experimental stage. It serves primarily as a proof of concept to validate the capabilities and potential benefits of integrating Large Language Models (LLMs) with Kubernetes, Prometheus, and other MCP (Model Context Protocol) servers. Features and functionality may change significantly as the project evolves.
## Features
- 🤖 **AI-Powered Assistance**: Interact with your Kubernetes clusters using natural language
- 🧰 **Tool Integration**: Execute Kubernetes operations through specialized tools
- 🚀 **Deployment Ready**: Packaged with Docker and Helm charts for easy deployment
- 📊 **Web Interface**: Built with Chainlit for an interactive chat experience
## Prerequisites
- Python 3.10+
- Docker
- Kubernetes cluster access
- Helm (for deployment)
## Installation
### Local Development
1. Clone the repository:
```bash
git clone https://github.com/yourusername/kubernetes-ai-ops-agent.git
cd kubernetes-ai-ops-agent
```
2. Install the dependencies:
```bash
pip install -r requirements.txt
```
3. Install the required MCP servers:
```bash
# Install the Kubernetes MCP server
npm install -g @kubernetes-ai/mcp-server-kubernetes
# Install the Prometheus MCP server
pip install prometheus-mcp-server
```
> **Note**: Do not use the MCP servers located in the `deps/` directory for local development. These are customized versions:
> - The Kubernetes MCP server in `deps/` is modified to use `loadFromCluster` for proper initialization in a Pod environment.
> - The MCP servers in `deps/` are included to be packaged directly into the container image rather than downloaded at runtime.
4. Configure your Kubernetes access:
- Ensure your kubeconfig is properly set up
- The agent will use your current kubectl context
5. Start the application:
```bash
chainlit run src/main.py
```
### Helm Chart Deployment
1. Build and push the Docker image:
```bash
# Build the Docker image
docker build -t /kubernetes-ai-ops-agent: .
# Push the image to your container registry
docker push /kubernetes-ai-ops-agent:
```
2. Create a `customized.values.yaml` file with your specific configuration:
```yaml
# Customized values for kubernetes-ai-ops-agent
image:
repository: /kubernetes-ai-ops-agent
# Configure the secrets
secrets:
data:
# Option 1: For Azure OpenAI configuration
AZURE_OPENAI_ENDPOINT: "https://.openai.azure.com/"
AZURE_OPENAI_API_KEY: ""
AZURE_OPENAI_MODEL: ""
OPENAI_API_VERSION: ""
# Option 2: For standard OpenAI configuration
# OPENAI_API_KEY: ""
# OPENAI_MODEL: "" # e.g., "gpt-4o"
# Prometheus configuration
PROMETHEUS_URL: "http://.:9090"
```
3. Install the chart using your customized values:
```bash
cd deploy/helm
helm install kubernetes-ai-ops ./kubernetes-ai-ops-agent -f customized.values.yaml
```
4. Access the application using port-forward:
```bash
# Port-forward the service to access it locally
# Use the namespace where you installed the chart (default used here as example)
kubectl port-forward svc/kubernetes-ai-ops-agent 9000:9000 -n
# Now you can access the web interface at http://localhost:9000
```
> **Note**: Replace `` with the namespace where you installed the Helm chart.
> If you installed without specifying a namespace (`-n` flag), the current context's
> namespace will be used (usually "default").
## Architecture
The application is built with the following components:
- **Chainlit Interface**: Web UI for interacting with the AI assistant
- **Agent Layer**: Processes natural language, plans operations, and executes them
- **MCP Servers**:
- **Kubernetes MCP Server**: Handles Kubernetes API operations
- **Prometheus MCP Server**: Provides monitoring metrics and data
## Model Support
This project currently supports only OpenAI models. You can configure the agent to use either:
- OpenAI API directly
- Azure OpenAI API
Configuration details for both options are provided in the deployment settings.
## Usage Examples
### Basic Cluster Information
```
User: "Show me all pods in the default namespace"
```
### Troubleshooting
```
User: "Why is my pod in CrashLoopBackOff state?"
```
## Project Structure
- `src/`: Main application code
- `main.py`: Main entry point for the Chainlit application
- `chainlit_session_manager.py`: Manages Chainlit user sessions
- `chainlit_session_storage.py`: Handles session data storage
- `interfaces.py`: Defines interfaces and abstractions
- `kubernetes_ai_ops_agent_provider.py`: Provider implementation for Kubernetes operations
- `mcp_server_provider_impl.py`: Implementation for MCP server provider
- `openai_client_factory_impl.py`: Factory for OpenAI client configuration
- `deps/`: Dependencies and MCP servers
- `mcp-server-kubernetes/`: Kubernetes MCP server
- `prometheus-mcp-server/`: Prometheus MCP server
- `deploy/`: Deployment configurations
- `helm/`: Helm charts for Kubernetes deployment
## Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.