mariadb-operator

README

🦭 mariadb-operator

Run and operate MariaDB in a cloud native way. Declaratively manage your MariaDB using Kubernetes CRDs rather than imperative commands.

• Provisioning highly configurable MariaDB servers
• Take and restore backups. Scheduled backups. Backup rotation
• Bootstrap new instances from a backup
• Support for managing users, grants and logical databases
• Prometheus metrics
• Validation webhooks to provide CRD inmutability
• Additional printer columns to report the current CRD status
• CRDs designed according to the Kubernetes API conventions
• GitOps friendly
• Multi-arch Docker image
• Helm chart

Installation

• Provision a Kubernetes cluster. If you don't have one already, you can easily create a KIND cluster by running:

make cluster

• Install kube-prometheus-stack

helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update
helm install kube-prometheus-stack prometheus-community/kube-prometheus-stack \
  -n kube-prometheus-stack --create-namespace

• Install cert-manager

helm repo add jetstack https://charts.jetstack.io
helm repo update
helm install cert-manager jetstack/cert-manager \
  -n cert-manager --create-namespace \
  --set installCRDs=true 

• Install mariadb-operator 🦭

helm repo add mmontes https://charts.mmontes-dev.duckdns.org
helm repo update
helm install mariadb-operator mmontes/mariadb-operator \
  -n mariadb-system --create-namespace

Quickstart

Let's see mariadb-operator in action! First of all, install the following configuration manifests that will be referenced by the CRDs further:

kubectl apply -f config/samples/config

To start with, let's provision a MariaDB server with Prometheus metrics:

kubectl apply -f config/samples/database_v1alpha1_mariadb.yaml

kubectl get mariadbs
NAME      READY   STATUS    AGE
mariadb   True    Running   75s

kubectl get statefulsets
NAME      READY   AGE
mariadb   1/1     2m12s

kubectl get services
NAME         TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
mariadb      ClusterIP   10.96.235.145   <none>        3306/TCP,9104/TCP   2m17s

kubectl get servicemonitors
NAME      AGE
mariadb   2m37s

Up and running 🚀, we can now create our first logical database and grant access to users:

kubectl apply -f config/samples/database_v1alpha1_databasemariadb.yaml
kubectl apply -f config/samples/database_v1alpha1_usermariadb.yaml
kubectl apply -f config/samples/database_v1alpha1_grantmariadb.yaml

kubectl get databasemariadbs
NAME        READY   STATUS    CHARSET   COLLATE           AGE
data-test   True    Created   utf8      utf8_general_ci   22s

kubectl get usermariadbs
NAME              READY   STATUS    MAXCONNS   AGE
mariadb-metrics   True    Created   3          19m
user              True    Created   20         29s

kubectl get grantmariadbs
NAME              READY   STATUS    DATABASE   TABLE   USERNAME          GRANTOPT   AGE
mariadb-metrics   True    Created   *          *       mariadb-metrics   false      19m
user              True    Created   *          *       user              true       36s

Now that everything seems to be in place, let's take a backup:

kubectl apply -f config/samples/database_v1alpha1_backupmariadb_scheduled.yaml

After one minute, the backup should have completed:

kubectl get backupmariadbs
NAME               COMPLETE   STATUS    MARIADB   AGE
backup-scheduled   True       Success   mariadb   15m

kubectl get cronjobs
NAME               SCHEDULE      SUSPEND   ACTIVE   LAST SCHEDULE   AGE
backup-scheduled   */1 * * * *   False     0        56s             15m

kubectl get jobs
NAME                                    COMPLETIONS   DURATION   AGE
backup-scheduled-27782894               1/1           4s         3m2s

Last but not least, let's provision a second MariaDB instance bootstrapping from the previous backup:

kubectl apply -f config/samples/database_v1alpha1_mariadb_from_backup.yaml

kubectl get mariadbs
NAME                       READY   STATUS    AGE
mariadb                    True    Running   39m
mariadb-from-backup        True    Running   85s

kubectl get restoremariadbs
NAME                                         COMPLETE   STATUS    MARIADB                    BACKUP   AGE
bootstrap-restore-mariadb-from-backup        True       Success   mariadb-from-backup        backup   72s

kubectl get jobs
NAME                                         COMPLETIONS   DURATION   AGE
backup                                       1/1           9s         12m
bootstrap-restore-mariadb-from-backup        1/1           5s         84s

You can take a look at the whole suite of example CRDs available in config/samples.

Contributing

Contributions are welcome! If you think something could be improved, request a new feature or just want to leave some feedback, please check our contributing guide and take a look at our open issues.