An open API service indexing awesome lists of open source software.

https://github.com/corapoid/orphelix

Modern Kubernetes dashboard with real-time monitoring, topology visualization, and GitOps integration. Features demo mode, AI-powered YAML editing, pod management, and GitHub PR workflow.
https://github.com/corapoid/orphelix

dashboard gitops kubernetes

Last synced: 2 months ago
JSON representation

Modern Kubernetes dashboard with real-time monitoring, topology visualization, and GitOps integration. Features demo mode, AI-powered YAML editing, pod management, and GitHub PR workflow.

Awesome Lists containing this project

README

          





Orphelix Logo

Orphelix

[![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)](https://github.com/corapoid/orphelix)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Node](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/)
[![Next.js](https://img.shields.io/badge/Next.js-16.0-black.svg)](https://nextjs.org/)
[![React](https://img.shields.io/badge/React-19.2-61dafb.svg)](https://reactjs.org/)
[![Tests](https://img.shields.io/badge/tests-passing-brightgreen.svg)](https://github.com/corapoid/orphelix)
[![Built with Claude Code](https://img.shields.io/badge/Built_with-Claude_Code-5A67D8.svg)](https://claude.ai/claude-code)

> **🚧 Active Development**: This project is under active development. Features and APIs may change.
>
> **πŸ€– Built with AI**: Developed with [Claude Code](https://claude.ai/claude-code) - Anthropic's AI-powered coding assistant.

**Orphelix** is a comprehensive web dashboard for monitoring and managing Kubernetes resources. The application offers a demo mode with realistic test data, live updates via Server-Sent Events, pod management, topology visualization, and GitHub integration for GitOps workflows.

![Orphelix Dashboard](docs/screenshots/dashboard.png)

## πŸš€ Quick Start

### Install and running the application

```bash
cd app
npm run orphelix start
```

### Open in browser

```bash
npm run orphelix open
```

### Other commands

```bash
npm run orphelix stop # Stop the application
npm run orphelix status # Check status
npm run orphelix help # Show all commands
```

## ✨ Features

### 🎯 Core Capabilities
- **Multi-Cluster & Namespace Support** - Switch between clusters and namespaces seamlessly (essential for namespace-scoped access control)
- **Comprehensive Resource Management** - View and manage all Kubernetes resources: Deployments, Pods, Nodes, ConfigMaps, Secrets, Services, Ingress, Jobs, CronJobs, StatefulSets, DaemonSets, HPA, PersistentVolumes, and Events
- **Quick Actions** - Restart deployments or individual pods with a single click
- **Real-time Updates** - Server-Sent Events (SSE) with automatic reconnection and heartbeat monitoring
- **Resource Metrics** - CPU/Memory monitoring with color-coded indicators
- **Demo Mode** - Explore the full application without cluster access - no login required (perfect for demos and evaluation)

### πŸ”§ Advanced Operations
- **YAML Manifest Editor** - Built-in Monaco editor with syntax highlighting and Kubernetes schema validation
- **GitOps Workflow** - Edit manifests and create pull requests directly from the dashboard (code-based changes only)
- **ConfigMap Editor** - Modify ConfigMaps in-place with automatic PR creation
- **Kustomization Support** - Automatically detect and edit Kustomize base & overlay structures
- **Smart File Matching** - AI-powered automatic deployment-to-file matching using YAML comparison

### πŸ€– AI-Powered Features
- **Intelligent Troubleshooting** - AI analyzes logs and identifies root causes when deployments fail
- **System Notifications** - Real-time desktop notifications for cluster issues and critical events
- **Topology Visualization** - Interactive dependency graphs showing resource relationships for deployments

### πŸ” Security & Authentication
- **Dual GitHub Authentication** - OAuth and GitHub App support with granular repository permissions
- **Server-Side Protection** - NextAuth v5 with route protection that cannot be bypassed from client
- **Local Credentials** - Uses kubeconfig from local system - no credentials stored

### 🎨 User Experience
- **Modern Glass UI** - Beautiful liquid glass design with dark/light mode support
- **Advanced Search & Filters** - Find resources quickly with powerful filtering
- **Namespace-Scoped Views** - Perfect for teams with namespace-based access control

...and this is just the beginning!

## πŸ—ΊοΈ What's Coming Next?

- **Resource Optimization** - Analyze CPU/memory usage against limits and suggest cost-saving adjustments
- **Advanced Log Analysis** - AI-powered troubleshooting for non-deployment issues (services, networking, configuration)
- **Cluster Cost Insights** - Track and optimize infrastructure spending
- **Multi-Cluster Dashboard** - Unified view across multiple Kubernetes clusters
- **Custom Alerts & Rules** - Define your own notification rules and thresholds

...and much more!

## πŸ“‹ Requirements

### Minimum (Demo Mode)
- **Nothing!** Just run the application and explore

### Production Mode (Real Cluster)
- **kubectl** configured with cluster access
- **GitHub OAuth App** for login authentication ([setup guide](docs/user/github/oauth-setup.mdx))

### GitOps Features (Optional)
- **GitHub App** for YAML editor and PR workflow ([setup guide](docs/user/github/github-app-setup.mdx))

> **Note**: GitHub OAuth (for login) and GitHub App (for GitOps) are separate. See [SECURITY.md](SECURITY.md#github-authentication) for details.

## πŸ“– Documentation

πŸ“š **[Full Documentation](https://orphelix.mintlify.app)** - Complete user guide, CLI reference, developer docs, and API documentation

### πŸ“‹ Additional Resources

- **[Security & Privacy](SECURITY.md)** - Authentication, security features, and best practices
- **[Changelog](CHANGELOG.md)** - Version history and updates
- **[License](LICENSE)** - Apache License 2.0

### πŸ€– AI Assistant Documentation

If you're an AI assistant working on this project, see the **[.ai-docs](.ai-docs/)** directory for:
- Project context and architecture
- Development setup guides
- Security implementation details
- Contributing guidelines