Frappe Operator Documentation

Welcome to the comprehensive documentation for the Frappe Operator by Vyogo Technologies — an enterprise-grade Kubernetes operator that automates the deployment, scaling, multi-database provisioning, and lifecycle management of Frappe Framework applications (including ERPNext) on Kubernetes and OpenShift.

What is Frappe Operator?

Frappe Operator brings cloud-native Kubernetes orchestration to Frappe deployments, making it easy to:

• Declarative Deployment — Deploy Frappe & ERPNext applications with declarative YAML manifests
• Multi-Tenancy — Run hundreds of isolated sites on shared bench infrastructure
• Polymorphic Databases — Seamlessly provision PostgreSQL (StackGres & Percona) or MariaDB
• Enterprise Security — Fully compatible with OpenShift restricted-v2 SCCs out-of-the-box
• HTTPS-Only Ingress — Automatic TLS certificate mounting and edge redirection
• Provider-Agnostic Autoscaling — Scale workers and web tiers dynamically using HPA or KEDA
• Zero-Downtime Lifecycles — Rolling updates and declarative schema migrations

Quick Navigation

Core Guides

• Getting Started - 5-minute quickstart on Kubernetes or OpenShift
• Comprehensive Guide - Complete reference guide and production best practices
• Architecture Overview - Internal controller architecture, CRDs, and lifecycle loops

Platform & Installation

• OpenShift Production Guide - Complete OpenShift guide & restricted-v2 SCC compliance
• OpenShift Console Plugin & FPM Store - Dynamic web bundle, dashboards, and air-gapped FPM package catalog
• Helm Installation Guide - Deploy via official Vyogo Helm chart
• OLM Installation Guide - Install via OperatorHub/OLM so the operator appears under Installed Operators
• Upgrade Guide - Seamlessly upgrade to v5.2.0

Database Management

• PostgreSQL Integration Guide - Dedicated (StackGres & Percona) & shared PostgreSQL
• MariaDB Integration Guide - Dedicated & shared MariaDB Operator integration
• External Resources - Connect to external AWS RDS, Cloud SQL, and Redis

Day-2 Operations & Reference

• Operations Guide - Site provisioning, updates, and maintenance
• Site App Installation - Declarative per-site app installation
• API Reference - Complete CRD specification
• Examples - Ready-to-use production manifests
• Troubleshooting Guide - Common issues, diagnostics, and debugging
• Monitoring & Metrics - Prometheus metrics and Grafana dashboards

Quick Start

# 1. Install Frappe Operator using official Helm chart
helm repo add frappe-operator https://vyogotech.github.io/frappe-operator/helm-repo
helm repo update
helm install frappe-operator frappe-operator/frappe-operator \
  --namespace frappe-operator-system \
  --create-namespace

# 2. Deploy a bench
kubectl apply -f https://raw.githubusercontent.com/vyogotech/frappe-operator/main/examples/basic-bench.yaml

# 3. Deploy a site
kubectl apply -f https://raw.githubusercontent.com/vyogotech/frappe-operator/main/examples/basic-site.yaml

Version Information

• Current Version: v5.2.0
• Helm Chart: 5.2.0
• API Group: vyogo.tech/v1
• Kubernetes: 1.22+
• OpenShift: 4.10+ (restricted-v2 SCC compliant)
• Go Version: 1.22+
• License: Elastic License 2.0 (ELv2)

What’s New in v5.2.0

• ✅ Polymorphic Database Architecture: Dedicated and shared PostgreSQL support alongside MariaDB.
• ✅ StackGres Integration: Fully declarative per-site SGCluster and SGScript templates for dedicated PostgreSQL.
• ✅ Percona PostgreSQL Toggle: Dedicated PerconaPGCluster option with backward-compatibility preservation for existing clusters.
• ✅ HTTPS-Only Ingress & Routes: Enforced TLS termination and edge redirect policy (tls.insecureEdgeTerminationPolicy: Redirect) across all sites and custom domains.
• ✅ OpenShift restricted-v2 SCC Compliance: Out-of-the-box support for strict security contexts (dynamic non-root UIDs, platform-allocated fsGroup, no privileged permissions).
• ✅ Provider-Agnostic Autoscaling: Unified componentAutoscaling supporting both Kubernetes HPA and KEDA.

See CHANGELOG for full release history.