For the complete documentation index, see llms.txt. This page is also available as Markdown.

Examples Catalog

A collection of YAML manifests and configuration examples for various common deployment scenarios and resource management tasks.

The examples catalog contains a number of sample manifests that aim to show the operator functionality in a practical way. Follow these instructions for getting started:

curl -sLO https://operator.mariadb.com/examples/manifests.tar.gz
mkdir -p examples
tar -xzf manifests.tar.gz -C examples
  • Install the configuration shared by all the examples:

kubectl apply -f examples/config
  • Start deploying examples:

kubectl apply -f examples/mariadb.yaml

Some examples rely on external dependencies for specific tasks, make sure to install them when it applies:

It is recommended to complement the examples with the API reference documentation to understand the full range of configuration options available.

If you are looking for production-grade examples, you can check the following manifests:

  • mariadb_replication_production.yaml and maxscale_replication_production.yaml for asynchronous replication

  • mariadb_galera_production.yaml and maxscale_galera_production.yaml for Galera

For TLS client certificate authentication, you can check the following manifests:

  • mariadb_replication_client_tls.yaml and maxscale_replication_client_tls.yaml: a replication MariaDB and its MaxScale that authenticate with TLS client certificates instead of passwords.

  • mariadb_galera_client_tls.yaml: a Galera MariaDB with TLS client certificate authentication, including the SST settings it requires.

  • user_client_certificate.yaml: a User with a dedicated TLS client certificate issued by the operator.

  • migrate-to-client-auth/: step-by-step manifests to migrate a password-based MariaDB to TLS client certificate authentication through a logical backup, as described in the migration guide.

  • migrate-to-client-auth-replication/: manifests and a script to migrate with a shorter downtime, by replicating from the old instance until the cutover.

For restoring and backing up large datasets, check the following manifests, which use long timeouts and large volumes:

  • physicalbackup_pvc_large.yaml and physicalbackup_volumesnapshot_large.yaml: physical backups to a PVC and to a VolumeSnapshot, with long timeouts.

  • mariadb_galera_from_physicalbackup_large.yaml and mariadb_galera_from_volumesnapshot_large.yaml: Galera clusters bootstrapped from a physical backup and from a VolumeSnapshot.

This page is: Copyright © 2026 MariaDB. All rights reserved.

spinner

Last updated

Was this helpful?