API Reference

Packages

• enterprise.mariadb.com/v1alpha1

enterprise.mariadb.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group

Resource Types

• Backup

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#affinity-v1-core.

Appears in:

AffinityConfig defines policies to schedule Pods in Nodes.

Appears in:

Agent is a sidecar agent that co-operates with mariadb-enterprise-operator.

Appears in:

Appears in:

Backup is the Schema for the backups API. It is used to define backup jobs and its storage.

Underlying type: string

BackupContentType defines the backup content type.

Appears in:

BackupSpec defines the desired state of Backup

Appears in:

BackupStorage defines the final storage for backups.

Appears in:

BasicAuth refers to the basic authentication mechanism utilized for establishing a connection from the operator to the agent.

Appears in:

BootstrapFrom defines a source to bootstrap MariaDB from.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#csivolumesource-v1-core.

Appears in:

CertConfig defines parameters to configure a certificate.

Appears in:

Underlying type: string

CleanupPolicy defines the behavior for cleaning up a resource.

Appears in:

Underlying type: string

CompressAlgorithm defines the compression algorithm for a Backup resource.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#configmapkeyselector-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#configmapvolumesource-v1-core.

Appears in:

Connection is the Schema for the connections API. It is used to configure connection strings for the applications connecting to MariaDB.

ConnectionSpec defines the desired state of Connection

Appears in:

ConnectionTemplate defines a template to customize Connection objects.

Appears in:

Container object definition.

Appears in:

ContainerTemplate defines a template to configure Container objects.

Appears in:

Underlying type: string

CooperativeMonitoring enables coordination between multiple MaxScale instances running monitors. See: https://mariadb.com/docs/server/architecture/components/maxscale/monitors/mariadbmon/use-cooperative-locking-ha-maxscale-mariadb-monitor/

Appears in:

Cordoning defines the parameters for cordoning a resource, resulting in the connections being blocked.

Appears in:

CronJobTemplate defines parameters for configuring CronJob objects.

Appears in:

Database is the Schema for the databases API. It is used to define a logical database as if you were running a 'CREATE DATABASE' statement.

DatabaseSpec defines the desired state of Database

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#emptydirvolumesource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#envfromsource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#envvarsource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#envvarsource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#ephemeralvolumesource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#execaction-v1-core.

Appears in:

Exporter defines a metrics exporter container.

Appears in:

ExternalMariaDB is the Schema for the external MariaDBs API. It is used to define external MariaDB server.

ExternalMariaDBSpec defines the desired state of an External MariaDB

Appears in:

ExternalTLS defines the TLS configuration for external MariaDB instances.

Appears in:

Galera allows you to enable multi-master HA via Galera in your MariaDB cluster.

Appears in:

GaleraConfig defines storage options for the Galera configuration files.

Appears in:

GaleraInitJob defines a Job used to be used to initialize the Galera cluster.

Appears in:

GaleraRecovery is the recovery process performed by the operator whenever the Galera cluster is not healthy. More info: https://galeracluster.com/library/documentation/crash-recovery.html.

Appears in:

GaleraRecoveryJob defines a Job used to be used to recover the Galera cluster.

Appears in:

GaleraSpec is the Galera desired state specification.

Appears in:

GeneratedSecretKeyRef defines a reference to a Secret that can be automatically generated by mariadb-enterprise-operator if needed.

Appears in:

Grant is the Schema for the grants API. It is used to define grants as if you were running a 'GRANT' statement.

GrantSpec defines the desired state of Grant

Appears in:

Underlying type: string

Gtid indicates which Global Transaction ID (GTID) position mode should be used when connecting a replica to the master. See: https://mariadb.com/kb/en/gtid/#using-current_pos-vs-slave_pos.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#httpgetaction-v1-core.

Appears in:

HealthCheck defines intervals for performing health checks.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#hostpathvolumesource-v1-core

Appears in:

InitContainer is an init container that runs in the MariaDB Pod and co-operates with mariadb-enterprise-operator.

Appears in:

Job defines a Job used to be used with MariaDB.

Appears in:

JobContainerTemplate defines a template to configure Container objects that run in a Job.

Appears in:

JobPodTemplate defines a template to configure Container objects that run in a Job.

Appears in:

KubernetesAuth refers to the Kubernetes authentication mechanism utilized for establishing a connection from the operator to the agent. The agent validates the legitimacy of the service account token provided as an Authorization header by creating a TokenReview resource.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#labelselector-v1-meta

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#labelselectorrequirement-v1-meta

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#lifecycle-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#lifecyclehandler-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#localobjectreference-v1-core.

Appears in:

MariaDB is the Schema for the mariadbs API. It is used to define MariaDB clusters.

MariaDBMaintenance defines different capabilities of the operator to allow for maintenance to be performed on MariaDB.

Appears in:

MariaDBPodTemplate defines a template for MariaDB Pods. Refer to the Kubernetes dos: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#pod-v1-core.

Appears in:

MariaDBRef is a reference to a MariaDB object.

Appears in:

MariaDBSpec defines the desired state of MariaDB

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#volume-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#volume-v1-core.

Appears in:

MariadbMetrics defines the metrics for a MariaDB.

Appears in:

MaxScale is the Schema for the maxscales API. It is used to define MaxScale clusters.

MaxScaleAdmin configures the admin REST API and GUI.

Appears in:

MaxScaleAuth defines the credentials required for MaxScale to connect to MariaDB.

Appears in:

MaxScaleConfig defines the MaxScale configuration.

Appears in:

MaxScaleConfigSync defines how the config changes are replicated across replicas.

Appears in:

MaxScaleListener defines how the MaxScale server will listen for connections.

Appears in:

MaxScaleMaintenance defines different capabilities of the operator to allow for maintenance to be performed on MaxScale.

Appears in:

MaxScaleMetrics defines the metrics for a Maxscale.

Appears in:

MaxScaleMonitor monitors MariaDB server instances

Appears in:

MaxScalePodTemplate defines a template for MaxScale Pods.

Appears in:

MaxScaleServer defines a MariaDB server to forward traffic to.

Appears in:

Services define how the traffic is forwarded to the MariaDB servers.

Appears in:

MaxScaleSpec defines the desired state of MaxScale.

Appears in:

TLS defines the PKI to be used with MaxScale.

Appears in:

Metadata defines the metadata to added to resources.

Appears in:

Underlying type: string

MonitorModule defines the type of monitor module

Appears in:

MultiCluster is the multi-cluster topology configuration.

Appears in:

MultiClusterMember defines the configuration for a multi-cluster topology member.

Appears in:

MultiClusterSpec is the specification for the multi-cluster topology.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#nfsvolumesource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#nodeaffinity-v1-core

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#nodeselector-v1-core

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#nodeselectorrequirement-v1-core

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#nodeselectorterm-v1-core

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectfieldselector-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectreference-v1-core.

Appears in:

PasswordPlugin defines the password plugin and its arguments.

Appears in:

Underlying type: string

PersistentVolumeClaimRetentionPolicyType describes the lifecycle of persistent volume claims. Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#persistentvolumeclaimspec-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#persistentvolumeclaimvolumesource-v1-core.

Appears in:

PhysicalBackup is the Schema for the physicalbackups API. It is used to define physical backup jobs and its storage.

PhysicalBackupPodTemplate defines a template to configure Container objects that run in a PhysicalBackup.

Appears in:

PhysicalBackupSchedule defines when the PhysicalBackup will be taken.

Appears in:

PhysicalBackupSpec defines the desired state of PhysicalBackup.

Appears in:

PhysicalBackupStorage defines the storage for physical backups.

Appears in:

Underlying type: string

PhysicalBackupTarget defines in which Pod the physical backups will be taken.

Appears in:

PhysicalBackupVolumeSnapshot defines parameters for the VolumeSnapshots used as physical backups.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#podaffinityterm-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#podantiaffinity-v1-core.

Appears in:

PodDisruptionBudget is the Pod availability bundget for a MariaDB

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#podsecuritycontext-v1-core

Appears in:

PointInTimeRecovery is the Schema for the pointintimerecoveries API. It contains binlog archival and point-in-time restoration settings.

PointInTimeRecoverySpec defines the desired state of PointInTimeRecovery. It contains binlog archive and point-in-time restoration settings.

Appears in:

PointInTimeRecoveryStorage stores the different storage options for PITR

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#preferredschedulingterm-v1-core

Appears in:

PrimaryGalera is the Galera configuration for the primary node.

Appears in:

PrimaryReplication is the replication configuration and operation parameters for the primary.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#probe-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#probe-v1-core.

Appears in:

ReplicaBootstrapFrom defines the sources for bootstrapping new relicas.

Appears in:

ReplicaRecovery defines how the replicas should be recovered after they enter an error state.

Appears in:

ReplicaReplication is the replication configuration and operation parameters for the replicas.

Appears in:

Replication defines replication configuration for a MariaDB cluster.

Appears in:

ReplicationSpec is the replication desired state.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#resourcerequirements-v1-core.

Appears in:

Restore is the Schema for the restores API. It is used to define restore jobs and its restoration source.

RestoreSource defines a source for restoring a logical backup.

Appears in:

RestoreSpec defines the desired state of restore

Appears in:

Appears in:

SQLTemplate defines a template to customize SQL objects.

Appears in:

SSECConfig defines the configuration for SSE-C (Server-Side Encryption with Customer-Provided Keys).

Appears in:

Underlying type: string

SST is the Snapshot State Transfer used when new Pods join the cluster. More info: https://galeracluster.com/library/documentation/sst.html.

Appears in:

Schedule contains parameters to define a schedule

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#secretkeyselector-v1-core.

Appears in:

SecretTemplate defines a template to customize Secret objects.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#secretvolumesource-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#securitycontext-v1-core.

Appears in:

ServiceMonitor defines a prometheus ServiceMonitor object.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#serviceport-v1-core

Appears in:

Underlying type: string

ServiceRouter defines the type of service router.

Appears in:

ServiceTemplate defines a template to customize Service objects.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#sleepaction-v1-core

Appears in:

SqlJob is the Schema for the sqljobs API. It is used to run sql scripts as jobs.

SqlJobSpec defines the desired state of SqlJob

Appears in:

StagingStorage defines the temporary storage used to keep external backups (i.e. S3) while they are being processed.

Appears in:

StatefulSetPersistentVolumeClaimRetentionPolicy describes the lifecycle of PVCs created from volumeClaimTemplates. Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#statefulsetpersistentvolumeclaimretentionpolicy-v1-apps.

Appears in:

Storage defines the storage options to be used for provisioning the PVCs mounted by MariaDB.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#volume-v1-core.

Appears in:

SuspendTemplate indicates whether the current resource should be suspended or not.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#tcpsocketaction-v1-core.

Appears in:

TLS defines the PKI to be used with MariaDB.

Appears in:

Appears in:

TLSRequirements specifies TLS requirements for the user to connect. See: https://mariadb.com/kb/en/securing-connections-for-client-and-server/#requiring-tls.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#topologyspreadconstraint-v1-core.

Appears in:

TypedLocalObjectReference is a reference to a specific object type.

Appears in:

UpdateStrategy defines how a MariaDB resource is updated.

Appears in:

Underlying type: string

UpdateType defines the type of update for a MariaDB resource.

Appears in:

User is the Schema for the users API. It is used to define grants as if you were running a 'CREATE USER' statement.

UserSpec defines the desired state of User

Appears in:

VolumeClaimTemplate defines a template to customize PVC objects.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#volumemount-v1-core.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#volume-v1-core.

Appears in:

Underlying type: string

WaitPoint defines whether the transaction should wait for ACK before committing to the storage engine. More info: https://mariadb.com/kb/en/semisynchronous-replication/#rpl_semi_sync_master_wait_point.

Appears in:

Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#weightedpodaffinityterm-v1-core.

Appears in:

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