Getting Started

Welcome to DB Provision Operator! This section will help you get up and running quickly.

What is DB Provision Operator?

DB Provision Operator is a Kubernetes operator that enables declarative management of database resources. It supports:

• PostgreSQL - Full support including extensions, schemas, and roles
• MySQL - Including authentication plugins and charset configuration
• MariaDB - MySQL-compatible with MariaDB-specific features

Prerequisites

Before installing DB Provision Operator, ensure you have:

• Kubernetes cluster version 1.26 or higher
• kubectl configured to communicate with your cluster
• Helm 3.x (if using Helm installation)
• Database server accessible from the cluster (PostgreSQL, MySQL, or MariaDB)

Installation Methods

Choose your preferred installation method:

Method	Best For	Customization
Helm	Production deployments	Full control via values.yaml
Kustomize	GitOps workflows	Patch-based customization

Quick Links

• Installation Guide - Detailed installation instructions
• Quick Start Tutorial - Create your first database in 5 minutes
• Examples - Ready-to-use YAML examples

Architecture Overview

graph TD
    subgraph K8s["Kubernetes Cluster"]
        subgraph Operator["DB Provision Operator"]
            IC[Instance Controller]
            DC[Database Controller]
            UC[User Controller]
            BC[Backup Controller]
        end
        IC & DC & UC & BC --> Adapters
        subgraph Adapters["Database Adapters"]
            PGA[PostgreSQL]
            MYA[MySQL]
            MRA[MariaDB]
        end
    end
    Adapters --> ExtDB
    subgraph ExtDB["External Databases"]
        PG[PostgreSQL]
        MY[MySQL]
        ETC[...]
    end

Next Steps

1. Install the operator in your cluster
2. Follow the quick start to create your first database
3. Explore the user guide for advanced features