Skip to content
GitHub stars

Roadmap ​

Future plans and feature roadmap for Lynq.

v1.0 βœ… ​

Status

Released

Features ​

  • βœ… MySQL datasource support
  • βœ… Template-based resource generation
  • βœ… Server-Side Apply (SSA)
  • βœ… Dependency management with DAG
  • βœ… Policy-based lifecycle (Creation/Deletion/Conflict)
  • βœ… Patch strategies (apply/merge/replace)
  • βœ… Fast reconciliation (30s requeue)
  • βœ… Smart watch predicates
  • βœ… Multi-template support
  • βœ… Webhook validation
  • βœ… Prometheus metrics
  • βœ… Comprehensive documentation

Performance ​

  • βœ… Event-driven architecture
  • βœ… Optimized reconciliation
  • βœ… Label-based namespace tracking
  • βœ… Efficient database querying

v1.1 (Current) βœ… ​

Focus

Cross-namespace support and operational improvements

New Features ​

  • βœ… Helm Chart Distribution

  • βœ… Cross-Namespace Resource Provisioning

    • Support creating node resources in different namespaces using targetNamespace field
    • Uses label-based tracking (lynq.sh/node, lynq.sh/node-namespace) for cross-namespace resources
    • Automatic detection: same-namespace uses ownerReferences, cross-namespace uses labels
    • Dual watch system: Owns() for same-namespace + Watches() with label selectors for cross-namespace
    • Enables multi-namespace node isolation and organizational boundaries
  • βœ… Orphan Resource Cleanup

    • Automatic detection and cleanup of resources removed from templates
    • Status-based tracking with appliedResources field
    • Respects DeletionPolicy (Delete/Retain)
    • Orphan labels for retained resources for easy identification

v1.2 ​

Focus

Additional datasources and enhanced observability

New Features ​

  • [ ] PostgreSQL Datasource

    • Full PostgreSQL support
    • Connection pooling
    • SSL/TLS support
    • Query optimization
  • [ ] Enhanced Metrics Dashboard

    • Pre-built Grafana dashboards
    • Comprehensive AlertManager rules
    • Multi-node metrics visualization
    • Performance analytics

Improvements ​

  • [ ] Improved error messages
  • [ ] Performance optimizations
  • [ ] Extended template functions
  • [ ] Better documentation examples

v1.3 ​

Focus

Scalability and advanced multi-tenancy features

New Features ​

  • [ ] Node Sharding for Large-Scale Deployments

    • Horizontal sharding of node workloads across multiple operator instances
    • Shard key-based node distribution
    • Load balancing across shards
    • Shard rebalancing and migration support
    • Use cases:
      • Supporting 10,000+ nodes per cluster
      • Isolating node failures to specific shards
      • Reducing controller resource consumption
      • Enabling independent scaling of operator replicas
  • [ ] Advanced Multi-Tenancy Isolation

    • Node priority and resource quotas
    • Per-node rate limiting
    • Node lifecycle hooks
    • Custom node tagging and filtering

Breaking Changes ​

Breaking Changes in v1.3.0

The following deprecated features will be removed in v1.3.0:

  • [ ] Removal of Deprecated .hostOrUrl and .host Variables
    • Deprecated since: v1.1.11
    • Removed in: v1.3.0
    • Migration required: Use extraValueMappings + toHost() template function
    • Impact: LynqHub configurations using valueMappings.hostOrUrl will fail validation
    • Migration guide:
      yaml
      # Before (deprecated - will fail in v1.3.0)
      valueMappings:
        uid: node_id
        hostOrUrl: domain_url  # ❌ Removed
        activate: is_active
      
      # After (v1.3.0+)
      valueMappings:
        uid: node_id
        activate: is_active
      extraValueMappings:
        nodeUrl: domain_url    # βœ… Use extraValueMappings
      
      # In templates: {{ .nodeUrl | toHost }}
    • Rationale: Lynq evolved from "tenant-operator" to a general database-driven automation platform, removing hardcoded host/URL requirements provides flexibility for diverse use cases

Improvements ​

  • [ ] Enhanced reconciliation performance for large node counts
  • [ ] Improved status reporting and aggregation
  • [ ] Optimized database query batching
  • [ ] Better scaling metrics and recommendations

Contributing to Roadmap ​

Want to influence the roadmap?

  1. Open a Discussion: Share your use case
  2. Vote on Features: Upvote existing requests
  3. Submit PRs: Implement features yourself
  4. Join Community: Participate in discussions

Stability Commitments ​

API Stability ​

  • v1 API: Stable, no breaking changes
  • Future versions: Migration guides provided
  • Deprecation policy: 6 months notice

Backwards Compatibility ​

  • Database schema changes: Automatic migration
  • Template syntax: Backwards compatible
  • Metrics: No breaking changes without notice

Getting Involved ​

See Also ​

Released under the Apache 2.0 License.
Built with ❀️ using Kubebuilder, Controller-Runtime, and VitePress.