Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mariadb-operator/mariadb-operator

🦭 Run and operate MariaDB in a cloud native way
https://github.com/mariadb-operator/mariadb-operator

backup cert-manager database galera high-availability kubernetes kubernetes-operator kubernetes-operators mariadb mariadb-galera mariadb-replication mariadb-server maxscale mysql openshift operator prometheus-operator s3 sql storage

Last synced: 9 days ago
JSON representation

🦭 Run and operate MariaDB in a cloud native way

Awesome Lists containing this project

README 

        


mariadb






CI

Release

Helm

Helm release






Go Report Card

Go Reference

Slack

Artifact Hub

Operator Hub




# 🦭 mariadb-operator



Run and operate MariaDB in a cloud native way. Declaratively manage your MariaDB using Kubernetes [CRDs](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) rather than imperative commands.

- [Easily provision](./examples/manifests/mariadb_minimal.yaml) and [configure](./examples/manifests/mariadb_full.yaml) MariaDB servers in Kubernetes.

- Multiple [HA modes](./docs/HA.md): Galera Cluster or MariaDB Replication.

- Automated Galera [primary failover](./docs/HA.md) and [cluster recovery](./docs/GALERA.md#galera-cluster-recovery).

- Advanced HA with [MaxScale](./docs/MAXSCALE.md): a sophisticated database proxy, router, and load balancer for MariaDB.

- Flexible [storage](./docs/STORAGE.md) configuration. [Volume expansion](./docs/STORAGE.md#volume-resize).

- Take, restore and schedule [backups](./docs/BACKUP.md). 

- Multiple [backup storage types](./docs/BACKUP.md#storage-types): S3 compatible, PVCs and Kubernetes volumes.

- Policy-driven [backup](./docs/BACKUP.md#retention-policy) retention with bzip and gzip [compression options](./docs/BACKUP.md#compression).

- [Target recovery time](./docs/BACKUP.md#target-recovery-time): restore the closest available backup to the specified time.

- [Bootstrap new instances](./docs/BACKUP.md#bootstrap-new-mariadb-instances-from-backups) from: Backups, S3, PVCs ...

- [Cluster-aware rolling update](./docs/UPDATES.md#replicasfirstprimarylast): roll out replica Pods one by one, wait for each of them to become ready, and then proceed with the primary Pod, using `ReplicasFirstPrimaryLast`.

- Manual [update strategies](./docs/UPDATES.md#update-strategies): `OnDelete` and `Never`.

- Automated [data-plane updates](./docs/UPDATES.md#auto-update-data-plane).

- [my.cnf change detection](./docs/CONFIGURATION.md#mycnf). Automatically trigger [updates](./docs/UPDATES.md) when my.cnf changes.

- [Suspend](./docs/SUSPEND.md) operator reconciliation for maintenance operations.

- Issue, configure and rotate [TLS certificates](./docs/TLS.md) and CAs.

- Native integration with [cert-manager](https://github.com/cert-manager/cert-manager). Automatically create `Certificate` resources.

- [Prometheus metrics](./docs/METRICS.md) via [mysqld-exporter](https://github.com/prometheus/mysqld_exporter) and maxscale-exporter.

- Native integration with [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator). Automatically create `ServiceMonitor` resources.

- Declaratively manage [SQL resources](./docs/SQL_RESOURCES.md): [users](./examples/manifests/user.yaml), [grants](./examples/manifests/grant.yaml) and logical [databases](./examples/manifests/database.yaml).

- Configure [connections](./examples/manifests/connection.yaml) for your applications.

- Orchestrate and schedule [sql scripts](./examples/manifests/sqljobs).

- Validation webhooks to provide CRD immutability.

- Additional printer columns to report the current CRD status.

- CRDs designed according to the Kubernetes [API conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md).

- Install it using [helm](./docs/HELM.md), [OLM](https://operatorhub.io/operator/mariadb-operator) or [static manifests](./deploy/manifests).

- Multiple [deployment modes](./docs/HELM.md#deployment-modes): cluster-wide and single namespace.

- Multi-arch distroless [image](https://github.com/orgs/mariadb-operator/packages/container/package/mariadb-operator).

- [GitOps](#gitops) friendly.



Please, refer to the [documentation](./docs/), [release notes](https://github.com/mariadb-operator/mariadb-operator/releases), the [API reference](./docs/API_REFERENCE.md) and the [example catalog](./examples/) for further detail, or dive into the [quickstart](./docs/QUICKSTART.md).



## Helm installation



You can easily deploy the operator to your cluster by installing the `mariadb-operator-crds` and `mariadb-operator` Helm charts:



```bash

helm repo add mariadb-operator https://helm.mariadb.com/mariadb-operator

helm install mariadb-operator-crds mariadb-operator/mariadb-operator-crds

helm install mariadb-operator mariadb-operator/mariadb-operator

```



Refer to the [helm documentation](./docs/HELM.md) for further detail.



## Upgrading from older releases

When upgrading from an older version of the operator, it’s important to understand how both operator and operand resources are affected.  Ensure you read both the [updates section of the helm docs](https://github.com/mariadb-operator/mariadb-operator/blob/main/docs/HELM.md#updates), and the [release notes](https://github.com/mariadb-operator/mariadb-operator/releases) for any additional version-specific steps that may be required. Do not attempt to skip intermediate version upgrades. Upgrade progressively through each version to the next.



## Openshift installation



The Openshift installation is managed separately in the [mariadb-operator-helm](https://github.com/mariadb-operator/mariadb-operator-helm) repository, which contains a [helm based operator](https://sdk.operatorframework.io/docs/building-operators/helm/) that allows you to install `mariadb-operator` via [OLM](https://olm.operatorframework.io/docs/).



## Image compatibility

`mariadb-operator` is only compatible with official MariaDB images. Refer to the [images documentation](./docs/DOCKER.md) for further detail.



## MariaDB compatibility

- MariaDB Community >= 10.5



## MaxScale compatibility

- MaxScale >= 23.08 

- MaxScale >= 24.02



## Kubernetes compatibility

- Kubernetes >= 1.26

- OpenShift >= 1.13



## Migrate your MariaDB instance to Kubernetes



This [migration guide](./docs/BACKUP.md#migrating-an-external-mariadb-to-a-mariadb-running-in-kubernetes) will streamline your onboarding process and assist you in migrating your data into a `MariaDB` instance running on Kubernetes.



## GitOps



You can embrace [GitOps](https://opengitops.dev/) best practises by using this operator, just place your CRDs in a git repo and reconcile them with your favorite tool, see an example with [flux](https://fluxcd.io/):

- [Run and operate MariaDB in a GitOps fashion using Flux](./examples/flux/)



## Roadmap



Take a look at our [roadmap](./ROADMAP.md) and feel free to open an issue to suggest new features.



## Adopters



Please create a PR and add your company or project to our [ADOPTERS.md file](./ADOPTERS.md) if you are using our project!



## Contributing



We welcome and encourage contributions to this project! Please check our [contributing](./CONTRIBUTING.md) and [development](./docs/DEVELOPMENT.md) guides. PRs welcome!



## Community



- [We Tested and Compared 6 Database Operators. The Results are In!](https://www.youtube.com/watch?v=l33pcnQ4cUQ&t=17m25s) - KubeCon EU, March 2024

- [Get Started with MariaDB in Kubernetes and mariadb-operator](https://mariadb.com/resources/blog/get-started-with-mariadb-in-kubernetes-and-mariadb-operator/) - MariaDB Corporation blog, February 2024

- [Run and operate MariaDB in Kubernetes with mariadb-operator](https://mariadb.org/mariadb-in-kubernetes-with-mariadb-operator/) - MariaDB Foundation blog, July 2023

- [L'enfer des DB SQL sur Kubernetes face à la promesse des opérateurs](https://www.youtube.com/watch?v=d_ka7PlWo1I&t=2415s&ab_channel=KCDFrance) - KCD France, March 2023



## Get in touch



Join us on Slack: **[MariaDB Community Slack](https://r.mariadb.com/join-community-slack)**.



## Star history



[![Star history](https://api.star-history.com/svg?repos=mariadb-operator/mariadb-operator&type=Date)](https://star-history.com/#mariadb-operator/mariadb-operator&Date)