README
¶
Lynq Operator
Kubernetes-Native Database-Driven Automation
Automate resource lifecycle from database to production
Documentation • Quick Start • Architecture • Contributing
📖 Overview
Lynq Operator is a Kubernetes operator that automates database-driven infrastructure provisioning. It reads data from external datasources and dynamically creates, updates, and manages Kubernetes resources using declarative templates.
💡 Core Concept
[!IMPORTANT] One database row = One complete set of Kubernetes resources
Each row in your database automatically provisions and manages a complete stack of Kubernetes resources (Deployments, Services, Ingresses, ConfigMaps, and more) using declarative templates.
✨ Key Features
- 🗄️ Database-driven automation - Sync resources from MySQL, PostgreSQL, and more
- 📝 Go templates + Sprig functions - Powerful template engine with 200+ built-in functions
- 🔄 Server-Side Apply - Kubernetes-native resource management
- 📊 DAG-based dependencies - Control resource creation order with dependency graphs
- ⚙️ Lifecycle policies - Fine-grained control over creation, deletion, and conflicts
- 🚀 Production-ready - Battle-tested with comprehensive monitoring and observability
📚 Learn More
- Complete Documentation - Full guides, tutorials, and API reference
- Architecture Guide - Deep dive into design and internals
🚀 Quick Start
Get started with Lynq Operator in 5 minutes:
- 🎯 Quick Start Guide - Step-by-step tutorial with working examples
- 📦 Installation Guide - Helm, Kustomize, and manual installation options
- ⚙️ Configuration Examples - LynqHub and LynqForm setup
📚 Documentation
Complete documentation is available at lynq.sh
Getting Started
- Quick Start - Get up and running in minutes
- Installation - Multiple installation methods
Core Concepts
- Architecture - System design and components
- API Reference - CRD specifications
- Templates - Template syntax and functions
Operations
- DataSource Setup - Configure MySQL, PostgreSQL, and more
- Monitoring - Metrics and observability
- Troubleshooting - Common issues and solutions
Integrations
- Crossplane - Infrastructure as Code
- ExternalDNS - Dynamic DNS management
- Flux - GitOps workflows
- Argo CD - Declarative GitOps
🛠️ Development
Getting Started
# Clone the repository
git clone https://github.com/k8s-lynq/lynq.git
cd lynq
# Install CRDs
make install
# Run locally
make run
# Run tests
make test
Resources
- 📖 Development Guide - Building, testing, and contributing
- 🔧 Local Development Setup - Environment configuration
- 🧪 Testing Guide - Unit, integration, and e2e tests
🤝 Contributing
We welcome contributions! Whether you're fixing bugs, adding features, improving documentation, or sharing use cases - all contributions are valued.
How to Contribute
- 🐛 Report Issues - Bug reports and feature requests
- 📋 Contributing Guidelines - Code standards, commit conventions, and PR process
- 🌟 Add a Datasource - Pluggable adapter pattern guide
- 💬 Join Discussions - Ask questions and share ideas
📊 Project Status
Production-ready • Kubernetes v1.28-v1.33 validated • Apache 2.0 License
- ✅ Stable - Used in production environments
- 🗺️ Roadmap - Feature plans and versioning
- 🔄 Active Development - Regular updates and improvements
📝 License
Licensed under the Apache License 2.0.
Copyright 2025 Lynq Operator Authors.
📬 Community & Support
Get Help
- 🐛 Report Issues - Bug reports and feature requests
- 💬 Discussions - Ask questions and share ideas
- 📖 Documentation - Comprehensive guides and tutorials
Stay Updated
- ⭐ Star this repository to show your support
- 👁️ Watch for updates and releases
- 🔔 Follow our releases for the latest features
⭐ Star History
Made with ❤️ by the Lynq community
Directories