Skip to main content

cloudnative-mysql Documentation

cloudnative-mysql is a Kubernetes operator for Percona Server for MySQL, designed around operator-owned lifecycle management, physical backups, failover, and point-in-time recovery.

Guides​

  • Quickstart: build local images, deploy the operator, install the CLI plugin, create a Cluster, inspect services, scale, and take a first Backup.
  • Cluster Lifecycle: how a Cluster becomes Pods, PVCs, credentials, TLS material, Services, and status.
  • Instance Images and Versions: supported Percona versions, slim image layout, rootless runtime, and image selection.
  • Security Model: mTLS, MySQL TLS, RBAC, secrets, object-store credentials, and current security limits.
  • Multi-Tenancy: cluster-per-tenant vs schema-per-tenant, declarative roles and Database resources, privilege scoping, isolation, and reclaim policies.
  • Operations Runbooks: scaling, switchover, failover, retained PVCs, status inspection, and maintenance habits.
  • Replication and Failover: GTID replicas, role routing, planned switchover, automatic failover, and former-primary rejoin.
  • Physical Backup and Recovery: one-shot XtraBackup archives, object-store layout, Backup status, and restore flow.
  • Backup Retention and Deletion: current deletion semantics, ScheduledBackup owner references, and planned retention GC.
  • Object Store Configuration: S3-compatible fields, credentials, TLS, object layout, and provider notes.
  • API Reference: field guide for Cluster, Database, Backup, ScheduledBackup, ImageCatalog, and ClusterImageCatalog.
  • Scheduled Backups: six-field cron scheduling, deterministic Backup creation, owner modes, and retention notes.
  • Point-In-Time Recovery: architecture, components, recovery flow, RPO/RTO model, and operational risks.
  • Troubleshooting: common symptoms, likely causes, and first commands to run.