# Bloodraven

> Kubernetes operator for MySQL async replication failover groups across sites. Automates failover detection, promotion, DNS steering, fencing, clone bootstrap, backup and restore.

## Documentation Sets

- [Bloodraven - complete documentation](https://bloodraven.dev/llms-full.txt): Every Bloodraven documentation page in a single file.

## Docs

- [Bloodraven](https://bloodraven.dev/raw/docs.md)
- [License token contract](https://bloodraven.dev/raw/docs/license-token.md): This is the contract the Bloodraven operator verifies offline. Tokens are
minted on demand at /license from a Polar order. The operator
never calls Polar; it only checks this JWT.
- [Licensing](https://bloodraven.dev/raw/docs/licensing.md): Bloodraven is source-available, not open source. The full source is public,
you can read it, build it, modify it, and contribute to it. Running it in
production at a commercial company requires a one-time license.
- [Known limitations](https://bloodraven.dev/raw/docs/get-started/known-limitations.md)
- [How to create your first MysqlFailoverGroup](https://bloodraven.dev/raw/docs/get-started/getting-started.md)
- [Playground](https://bloodraven.dev/raw/docs/get-started/playground.md)
- [Production Install](https://bloodraven.dev/raw/docs/get-started/install-production.md)
- [Production install examples](https://bloodraven.dev/raw/docs/get-started/production-install-examples.md)
- [Configuration Overview](https://bloodraven.dev/raw/docs/configuration/configuration.md)
- [Production hardening checklist](https://bloodraven.dev/raw/docs/configuration/production-hardening.md)
- [CRD Reference](https://bloodraven.dev/raw/docs/configuration/crd-reference.md)
- [CRD versioning and migration plan](https://bloodraven.dev/raw/docs/configuration/crd-versioning.md)
- [Placement Contract](https://bloodraven.dev/raw/docs/configuration/placement-contract.md)
- [App Integration](https://bloodraven.dev/raw/docs/configuration/app-integration.md)
- [Credentials And TLS](https://bloodraven.dev/raw/docs/configuration/credentials-and-tls.md)
- [Tenant Databases](https://bloodraven.dev/raw/docs/configuration/tenant-databases.md): MysqlDatabase is a namespaced CRD that declares one database on a MysqlFailoverGroup, the user that owns it, any additional Secret-backed principals on it, and grants for principals that already exist.
- [Data-at-rest encryption](https://bloodraven.dev/raw/docs/configuration/encryption-at-rest.md): Bloodraven can run MySQL with InnoDB data-at-rest encryption turned on,
keeping the encryption key off the MySQL data PVC and off worker-node
disks. It uses the GPL component_keyring_file keyring component that
ships in MySQL Community Edition, so it needs no Oracle Enterprise
licence and no CSI-level encrypted storage.
- [Security model](https://bloodraven.dev/raw/docs/configuration/security-model.md)
- [Architecture](https://bloodraven.dev/raw/docs/architecture/architecture.md): How the Bloodraven operator, sidecars, MySQL pods, optional Dragonfly sidekicks, Services, and DNS records interact during normal operation and failover.
- [Multi-site topology](https://bloodraven.dev/raw/docs/architecture/multi-site.md)
- [Multi-cluster disaster recovery](https://bloodraven.dev/raw/docs/architecture/multi-cluster-dr.md): This page is the operational runbook for recovering a MysqlFailoverGroup
into a separate Kubernetes cluster when the source cluster is lost. It
covers every step from topology to DNS cutover using only the existing
MysqlFailoverGroup CRD surface (available today on main). No new
CRDs or controllers are required to execute this runbook.
- [Why not Group Replication?](https://bloodraven.dev/raw/docs/architecture/why-not-group-replication.md)
- [Operator availability](https://bloodraven.dev/raw/docs/architecture/operator-availability.md)
- [Durability and RPO](https://bloodraven.dev/raw/docs/architecture/durability-and-rpo.md)
- [Architecture Diagrams](https://bloodraven.dev/raw/docs/architecture/architecture-diagrams.md)
- [Operations Overview](https://bloodraven.dev/raw/docs/operations/operations-overview.md)
- [Upgrade and version-skew policy](https://bloodraven.dev/raw/docs/operations/upgrade-policy.md): What MySQL and sidecar versions Bloodraven supports, how to move
between them, and what mismatches the operator tolerates during a
rollout.
- [GitOps guidance](https://bloodraven.dev/raw/docs/operations/gitops.md)
- [Operations](https://bloodraven.dev/raw/docs/operations/operations.md)
- [kubectl bloodraven plugin](https://bloodraven.dev/raw/docs/operations/kubectl-plugin.md): kubectl-bloodraven is the operator's day-2 sidekick: a single static
binary that wraps the annotation grammars and on-demand CR shapes
the operator already understands. It is the recommended way to drive
a planned failover, kick off an ad-hoc backup or verification, or
peek at the current health of a MysqlFailoverGroup without
reaching for raw kubectl annotate / kubectl apply incantations.
- [Runbooks](https://bloodraven.dev/raw/docs/operations/runbooks.md)
- [Troubleshooting](https://bloodraven.dev/raw/docs/operations/troubleshooting.md)
- [Failover](https://bloodraven.dev/raw/docs/operations/failover.md)
- [Planned failover](https://bloodraven.dev/raw/docs/operations/planned-failover.md)
- [Network partitions](https://bloodraven.dev/raw/docs/operations/network-partitions.md)
- [Failure-mode matrix](https://bloodraven.dev/raw/docs/operations/failure-mode-matrix.md)
- [Backup And Restore Overview](https://bloodraven.dev/raw/docs/backup-and-restore/backup-overview.md)
- [Backup and restore](https://bloodraven.dev/raw/docs/backup-and-restore/backup-restore.md)
- [S3 Backups](https://bloodraven.dev/raw/docs/backup-and-restore/backup-s3.md)
- [PVC Backups](https://bloodraven.dev/raw/docs/backup-and-restore/backup-pvc.md)
- [Backup encryption at rest](https://bloodraven.dev/raw/docs/backup-and-restore/backup-encryption.md)
- [Backup verification](https://bloodraven.dev/raw/docs/backup-and-restore/backup-verification.md)
- [Observability Overview](https://bloodraven.dev/raw/docs/observability/observability-overview.md)
- [Monitoring](https://bloodraven.dev/raw/docs/observability/monitoring.md)
- [Prometheus Setup](https://bloodraven.dev/raw/docs/observability/monitoring-prometheus.md)
- [Grafana Dashboards](https://bloodraven.dev/raw/docs/observability/monitoring-grafana.md)
- [Alert To Runbook Map](https://bloodraven.dev/raw/docs/observability/alert-runbook-map.md)
- [Observability Change Checklist](https://bloodraven.dev/raw/docs/observability/observability-change-checklist.md): Use this checklist for pull requests and releases that add, remove, or change observability signals. It applies to metrics, recording rules, alerts, dashboard panels, Kubernetes Events, structured-log Events, and runbook links.
- [Log schema contract](https://bloodraven.dev/raw/docs/observability/log-schema.md)
- [Example Manifests](https://bloodraven.dev/raw/docs/maintenance/examples.md)
- [Docs Maintenance](https://bloodraven.dev/raw/docs/maintenance/docs-maintenance.md): Use this page before releases and when changing CRDs, Helm values, metrics, dashboards, Events, or logs.

## Landing

- [Bloodraven - MySQL failover for Kubernetes](https://bloodraven.dev/raw/index.md): Kubernetes operator for MySQL async replication failover groups across sites. Automatic promotion, DNS steering, split-brain fencing, clone bootstrap, encryption and backups.