Skip to content

Installation & Updates

This section covers everything you need to deploy, configure, and maintain Lyra Platform.

Installation Overview

Lyra Platform is deployed as a Helm chart to Kubernetes clusters. The deployment process includes:

  1. Prerequisites - Preparing your environment and infrastructure
  2. Kubernetes Setup - Creating and configuring your Kubernetes cluster
  3. Infrastructure Deployment - Deploying storage, databases, and networking
  4. Initial Deployment - Installing Lyra Platform applications
  5. Updates & Maintenance - Keeping your Lyra installation up-to-date

Installation Guides

Prerequisites

System requirements, dependencies, and infrastructure preparation.

Topics covered: - Kubernetes cluster requirements - Storage requirements (Ceph/Rook) - Container registry setup (Harbor) - Network and ingress configuration - SSL/TLS certificates

Kubernetes Setup

Create and configure a Kubernetes cluster using Rancher.

Topics covered: - Creating Kubernetes cluster via Rancher - Configuring cluster nodes (control plane and workers) - Node role configuration (etcd, control plane, worker) - Rancher project setup for Lyra - Harbor registry integration - Cluster verification

Infrastructure Deployment

Deploy required infrastructure components for Lyra Platform.

Topics covered: - Ceph/Rook storage cluster deployment - PostgreSQL database cluster (HA with 3 replicas) - Redis HA and Ephemeral instances - CSI drivers for external storage (SMB, NFS, S3) - MetalLB load balancer configuration - Infrastructure verification

Initial Deployment

Step-by-step guide for deploying Lyra Platform for the first time.

Topics covered: - Deploying Lyra application via Rancher UI - Using predefined Helm chart values - Verifying deployment status - Creating initial superuser account

Updates & Maintenance

Managing updates, upgrades, and ongoing maintenance.

Topics covered: - Update strategies and best practices - Rolling vs. blue-green deployments - Backup and restore procedures - Rollback procedures - Health monitoring

Quick Start

For experienced users, here's the quick installation workflow:

  1. Complete Prerequisites
  2. Set up Kubernetes cluster via Rancher
  3. Deploy infrastructure (Ceph, PostgreSQL, Redis, CSI drivers, MetalLB)

  4. Deploy Lyra via Rancher UI

  5. Navigate to Apps & Marketplace → Charts
  6. Search for lyra-app in Harbor catalog
  7. Click Install with predefined values
  8. Wait for deployment to complete

  9. Verify and Configure

    # Check deployment status
    kubectl get pods -n lyra
    
    # Create initial superuser
    kubectl exec -it -n lyra <backend-pod> -- python -m app.scripts.create_superuser
    

Deployment Architecture

Lyra uses a modern Kubernetes-native deployment architecture:

┌─────────────────────────────────────────────────────────────┐
│                      Ingress / Load Balancer                │
│                    (MetalLB + Nginx Ingress)                │
└────────────────────┬────────────────────────────────────────┘
     ┌───────────────┴───────────────┐
     │                               │
┌────▼─────┐                   ┌────▼──────┐
│ Frontend │                   │  Backend  │
│  (React) │◄─────────────────►│ (FastAPI) │
└──────────┘                   └─────┬─────┘
                    ┌────────────────┼────────────────┐
                    │                │                │
               ┌────▼─────┐    ┌────▼─────┐    ┌────▼────┐
               │PostgreSQL│    │  Redis   │    │Scheduler│
               └──────────┘    └──────────┘    └─────────┘
                              ┌──────▼──────┐
                              │  Kubernetes │
                              │   (Tenant   │
                              │  Namespaces)│
                              └─────────────┘

Container Images

Lyra consists of three main container images stored in Harbor:

Image Purpose Build Script
lyra-frontend React web interface build-and-push-frontend.sh
lyra-backend FastAPI REST API build-and-push-backend.sh
lyra-scheduler Background job processor build-and-push-scheduler.sh

All images are versioned and stored in your Harbor registry at registry.lyra.ovh/lyra/.

Helm Chart

The Lyra Helm chart (lyra-app) is stored in Harbor's Helm repository and includes:

  • Kubernetes deployments for all components
  • Services and ingress configuration
  • ConfigMaps and Secrets management
  • Resource quotas and limits
  • Health checks and probes
  • HPA (Horizontal Pod Autoscaler) configurations

Support & Troubleshooting

If you encounter issues during installation:

  1. Check the Prerequisites are met
  2. Review logs: kubectl logs -n lyra -l app=lyra-backend
  3. Verify connectivity: kubectl get pods -n lyra
  4. Visit GitHub Issues

Getting Started

Ready to deploy Lyra Platform? Follow this installation workflow:

  1. Prerequisites - Prepare your environment
  2. Kubernetes Setup - Create your cluster
  3. Infrastructure Deployment - Deploy infrastructure
  4. Initial Deployment - Deploy Lyra applications
  5. Updates & Maintenance - Keep your system updated

Begin with the Prerequisites guide.