Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
Backup is the Schema for the backups API. It is used to define backup jobs and its storage.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
Backup |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec BackupSpec |
BackupSpec defines the desired state of Backup
Appears in:
| Field | Description |
|---|---|
mariaDbRef MariaDBRef |
MariaDBRef is a reference to a MariaDB object. |
storage BackupStorage |
Storage to be used in the Backup. |
args string array |
Args to be used in the Backup container. |
schedule Schedule |
Schedule defines when the Backup will be taken. |
maxRetention Duration |
MaxRetention defines the retention policy for backups. Old backups will be cleaned up by the Backup Job. It defaults to 30 days. |
logLevel string |
LogLevel to be used n the Backup Job. It defaults to 'info'. |
backoffLimit integer |
BackoffLimit defines the maximum number of attempts to successfully take a Backup. |
restartPolicy RestartPolicy |
RestartPolicy to be added to the Backup Pod. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
affinity Affinity |
Affinity to be used in the Backup Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the Backup Pod. |
tolerations Toleration array |
Tolerations to be used in the Backup Pod. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
BackupStorage defines the storage for a Backup.
Appears in:
| Field | Description |
|---|---|
s3 S3 |
S3 defines the configuration to store backups in a S3 compatible storage. |
persistentVolumeClaim PersistentVolumeClaimSpec |
PersistentVolumeClaim is a Kubernetes PVC specification. |
volume VolumeSource |
Volume is a Kubernetes volume specification. |
Connection is the Schema for the connections API. It is used to configure connection strings for the applications connecting to MariaDB.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
Connection |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec ConnectionSpec |
ConnectionSpec defines the desired state of Connection
Appears in:
| Field | Description |
|---|---|
secretName string |
SecretName to be used in the Connection. |
secretTemplate SecretTemplate |
SecretTemplate to be used in the Connection. |
healthCheck HealthCheck |
HealthCheck to be used in the Connection. |
params object (keys:string, values:string) |
Params to be used in the Connection. |
serviceName string |
ServiceName to be used in the Connection. |
port integer |
Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener. |
mariaDbRef MariaDBRef |
MariaDBRef is a reference to the MariaDB to connect to. Either MariaDBRef or MaxScaleRef must be provided. |
maxScaleRef ObjectReference |
MaxScaleRef is a reference to the MaxScale to connect to. Either MariaDBRef or MaxScaleRef must be provided. |
username string |
Username to use for configuring the Connection. |
passwordSecretKeyRef SecretKeySelector |
PasswordSecretKeyRef is a reference to the password to use for configuring the Connection. |
host string |
Host to connect to. If not provided, it defaults to the MariaDB host or to the MaxScale host. |
database string |
Database to use when configuring the Connection. |
ConnectionTemplate defines a template to customize Connection objects.
Appears in:
| Field | Description |
|---|---|
secretName string |
SecretName to be used in the Connection. |
secretTemplate SecretTemplate |
SecretTemplate to be used in the Connection. |
healthCheck HealthCheck |
HealthCheck to be used in the Connection. |
params object (keys:string, values:string) |
Params to be used in the Connection. |
serviceName string |
ServiceName to be used in the Connection. |
port integer |
Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener. |
Container object definition.
Appears in:
| Field | Description |
|---|---|
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
image string |
Image name to be used by the MariaDB instances. The supported format is <image>:<tag>. |
imagePullPolicy PullPolicy |
ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. |
ContainerTemplate defines a template to configure Container objects.
Appears in:
| Field | Description |
|---|---|
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
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:
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.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
Database |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec DatabaseSpec |
DatabaseSpec defines the desired state of Database
Appears in:
| Field | Description |
|---|---|
requeueInterval Duration |
RequeueInterval is used to perform requeue reconcilizations. |
retryInterval Duration |
RetryInterval is the interval used to perform retries. |
mariaDbRef MariaDBRef |
MariaDBRef is a reference to a MariaDB object. |
characterSet string |
CharacterSet to use in the Database. |
collate string |
CharacterSet to use in the Database. |
name string |
Name overrides the default Database name provided by metadata.name. |
Exporter defines a metrics exporter container.
Appears in:
| Field | Description |
|---|---|
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
image string |
Image name to be used as metrics exporter. The supported format is <image>:<tag>. Only mysqld-exporter >= v0.15.0 is supported: https://github.com/prometheus/mysqld_exporter |
imagePullPolicy PullPolicy |
ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. |
port integer |
Port where the exporter will be listening for connections. |
Galera allows you to enable multi-master HA via Galera in your MariaDB cluster.
Appears in:
| Field | Description |
|---|---|
primary PrimaryGalera |
Primary is the Galera configuration for the primary node. |
sst SST |
SST is the Snapshot State Transfer used when new Pods join the cluster. More info: https://galeracluster.com/library/documentation/sst.html. |
replicaThreads integer |
ReplicaThreads is the number of replica threads used to apply Galera write sets in parallel. More info: https://mariadb.com/kb/en/galera-cluster-system-variables/#wsrep_slave_threads. |
agent GaleraAgent |
GaleraAgent is a sidecar agent that co-operates with mariadb-operator. More info: https://github.com/mariadb-operator/agent. |
recovery GaleraRecovery |
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. |
initContainer Container |
InitContainer is an init container that co-operates with mariadb-operator. More info: https://github.com/mariadb-operator/init. |
volumeClaimTemplate VolumeClaimTemplate |
VolumeClaimTemplate is a template for the PVC that will contain the Galera configuration files shared between the InitContainer, Agent and MariaDB. |
enabled boolean |
Enabled is a flag to enable Galera. |
GaleraAgent is a sidecar agent that co-operates with mariadb-operator. More info: https://github.com/mariadb-operator/agent.
Appears in:
| Field | Description |
|---|---|
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
image string |
Image name to be used by the MariaDB instances. The supported format is <image>:<tag>. |
imagePullPolicy PullPolicy |
ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. |
port integer |
Port where the agent will be listening for connections. |
kubernetesAuth KubernetesAuth |
KubernetesAuth to be used by the agent container |
gracefulShutdownTimeout Duration |
GracefulShutdownTimeout is the time we give to the agent container in order to gracefully terminate in-flight requests. |
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:
| Field | Description |
|---|---|
enabled boolean |
Enabled is a flag to enable GaleraRecovery. |
clusterHealthyTimeout Duration |
ClusterHealthyTimeout represents the duration at which a Galera cluster, that consistently failed health checks, is considered unhealthy, and consequently the Galera recovery process will be initiated by the operator. |
clusterBootstrapTimeout Duration |
ClusterBootstrapTimeout is the time limit for bootstrapping a cluster. Once this timeout is reached, the Galera recovery state is reset and a new cluster bootstrap will be attempted. |
podRecoveryTimeout Duration |
PodRecoveryTimeout is the time limit for executing the recovery sequence within a Pod. This process includes enabling the recovery mode in the Galera configuration file, restarting the Pod and retrieving the sequence from a log file. |
podSyncTimeout Duration |
PodSyncTimeout is the time limit we give to a Pod to reach the Sync state. Once this timeout is reached, the Pod is restarted. |
GaleraRecoveryBootstrap indicates when and in which Pod the cluster bootstrap process has been performed.
Appears in:
| Field | Description |
|---|---|
time Time |
|
pod string |
GaleraSpec is the Galera desired state specification.
Appears in:
| Field | Description |
|---|---|
primary PrimaryGalera |
Primary is the Galera configuration for the primary node. |
sst SST |
SST is the Snapshot State Transfer used when new Pods join the cluster. More info: https://galeracluster.com/library/documentation/sst.html. |
replicaThreads integer |
ReplicaThreads is the number of replica threads used to apply Galera write sets in parallel. More info: https://mariadb.com/kb/en/galera-cluster-system-variables/#wsrep_slave_threads. |
agent GaleraAgent |
GaleraAgent is a sidecar agent that co-operates with mariadb-operator. More info: https://github.com/mariadb-operator/agent. |
recovery GaleraRecovery |
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. |
initContainer Container |
InitContainer is an init container that co-operates with mariadb-operator. More info: https://github.com/mariadb-operator/init. |
volumeClaimTemplate VolumeClaimTemplate |
VolumeClaimTemplate is a template for the PVC that will contain the Galera configuration files shared between the InitContainer, Agent and MariaDB. |
Grant is the Schema for the grants API. It is used to define grants as if you were running a 'GRANT' statement.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
Grant |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec GrantSpec |
GrantSpec defines the desired state of Grant
Appears in:
| Field | Description |
|---|---|
requeueInterval Duration |
RequeueInterval is used to perform requeue reconcilizations. |
retryInterval Duration |
RetryInterval is the interval used to perform retries. |
mariaDbRef MariaDBRef |
MariaDBRef is a reference to a MariaDB object. |
privileges string array |
Privileges to use in the Grant. |
database string |
Database to use in the Grant. |
table string |
Table to use in the Grant. |
username string |
Username to use in the Grant. |
host string |
Host to use in the Grant. |
grantOption boolean |
GrantOption to use in the Grant. |
Underlying type: string
Gtid indicates which Global Transaction ID 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:
HealthCheck defines intervals for performing health checks.
Appears in:
| Field | Description |
|---|---|
interval Duration |
Interval used to perform health checks. |
retryInterval Duration |
RetryInterval is the intervañ used to perform health check retries. |
InheritMetadata defines the metadata to be inherited by children resources.
Appears in:
| Field | Description |
|---|---|
labels object (keys:string, values:string) |
Labels to be added to children resources. |
annotations object (keys:string, values:string) |
Annotations to be added to children resources. |
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:
| Field | Description |
|---|---|
enabled boolean |
Enabled is a flag to enable KubernetesAuth |
authDelegatorRoleName string |
AuthDelegatorRoleName is the name of the ClusterRoleBinding that is associated with the "system:auth-delegator" ClusterRole. It is necessary for creating TokenReview objects in order for the agent to validate the service account token. |
MariaDB is the Schema for the mariadbs API. It is used to define MariaDB clusters.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
MariaDB |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec MariaDBSpec |
MariaDBMaxScaleSpec defines a MaxScale resources to be used with the current MariaDB.
Appears in:
| Field | Description |
|---|---|
enabled boolean |
Enabled is a flag to enable a MaxScale instance to be used with the current MariaDB. |
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
initContainers Container array |
InitContainers to be used in the Pod. |
sidecarContainers Container array |
SidecarContainers to be used in the Pod. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccountName string |
ServiceAccountName is the name of the ServiceAccount to be used by the Pods. |
affinity Affinity |
Affinity to be used in the Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the Pod. |
tolerations Toleration array |
Tolerations to be used in the Pod. |
volumes Volume array |
Volumes to be used in the Pod. |
priorityClassName string |
PriorityClassName to be used in the Pod. |
topologySpreadConstraints TopologySpreadConstraint array |
TopologySpreadConstraints to be used in the Pod. |
image string |
Image name to be used by the MaxScale instances. The supported format is <image>:<tag>. Only MaxScale official images are supported. |
imagePullPolicy PullPolicy |
ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. |
imagePullSecrets LocalObjectReference array |
ImagePullSecrets is the list of pull Secrets to be used to pull the image. |
services MaxScaleService array |
Services define how the traffic is forwarded to the MariaDB servers. |
monitor MaxScaleMonitor |
Monitor monitors MariaDB server instances. |
admin MaxScaleAdmin |
Admin configures the admin REST API and GUI. |
config MaxScaleConfig |
Config defines the MaxScale configuration. |
auth MaxScaleAuth |
Auth defines the credentials required for MaxScale to connect to MariaDB. |
connection ConnectionTemplate |
Connection provides a template to define the Connection for MaxScale. |
replicas integer |
Replicas indicates the number of desired instances. |
podDisruptionBudget PodDisruptionBudget |
PodDisruptionBudget defines the budget for replica availability. |
updateStrategy StatefulSetUpdateStrategy |
UpdateStrategy defines the update strategy for the StatefulSet object. |
kubernetesService ServiceTemplate |
Service defines templates to configure the Kubernetes Service object. |
requeueInterval Duration |
RequeueInterval is used to perform requeue reconcilizations. |
MariaDBRef is a reference to a MariaDB object.
Appears in:
| Field | Description |
|---|---|
kind string |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
namespace string |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
name string |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
uid UID |
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
apiVersion string |
API version of the referent. |
resourceVersion string |
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
fieldPath string |
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. |
waitForIt boolean |
WaitForIt indicates whether the controller using this reference should wait for MariaDB to be ready. |
MariaDBSpec defines the desired state of MariaDB
Appears in:
| Field | Description |
|---|---|
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
initContainers Container array |
InitContainers to be used in the Pod. |
sidecarContainers Container array |
SidecarContainers to be used in the Pod. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccountName string |
ServiceAccountName is the name of the ServiceAccount to be used by the Pods. |
affinity Affinity |
Affinity to be used in the Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the Pod. |
tolerations Toleration array |
Tolerations to be used in the Pod. |
volumes Volume array |
Volumes to be used in the Pod. |
priorityClassName string |
PriorityClassName to be used in the Pod. |
topologySpreadConstraints TopologySpreadConstraint array |
TopologySpreadConstraints to be used in the Pod. |
image string |
Image name to be used by the MariaDB instances. The supported format is <image>:<tag>. Only MariaDB official images are supported. |
imagePullPolicy PullPolicy |
ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. |
imagePullSecrets LocalObjectReference array |
ImagePullSecrets is the list of pull Secrets to be used to pull the image. |
inheritMetadata InheritMetadata |
InheritMetadata defines the metadata to be inherited by children resources. |
podAnnotations object (keys:string, values:string) |
PodAnnotations to add to the Pods metadata. |
rootPasswordSecretKeyRef SecretKeySelector |
RootPasswordSecretKeyRef is a reference to a Secret key containing the root password. |
rootEmptyPassword boolean |
RootEmptyPassword indicates if the root password should be empty. |
database string |
Database is the database to be created on bootstrap. |
username string |
Username is the username of the user to be created on bootstrap. |
passwordSecretKeyRef SecretKeySelector |
PasswordSecretKeyRef is a reference to the password of the initial user provided via a Secret. |
myCnf string |
MyCnf allows to specify the my.cnf file mounted by Mariadb. |
myCnfConfigMapKeyRef ConfigMapKeySelector |
MyCnfConfigMapKeyRef is a reference to the my.cnf config file provided via a ConfigMap. If not provided, it will be defaulted with reference to a ConfigMap with the contents of the MyCnf field. |
bootstrapFrom RestoreSource |
BootstrapFrom defines a source to bootstrap from. |
metrics Metrics |
Metrics configures metrics and how to scrape them. |
replication Replication |
Replication configures high availability via replication. |
galera Galera |
Replication configures high availability via Galera. |
maxScaleRef ObjectReference |
MaxScaleRef is a reference to a MaxScale resource to be used with the current MariaDB. Providing this field implies delegating high availability tasks such as primary failover to MaxScale. |
maxScale MariaDBMaxScaleSpec |
MaxScale is the MaxScale specification that defines the MaxScale resource to be used with the current MariaDB. When enabling this field, MaxScaleRef is automatically set. |
replicas integer |
Replicas indicates the number of desired instances. |
port integer |
Port where the instances will be listening for connections. |
ephemeralStorage boolean |
EphemeralStorage indicates whether to use ephemeral storage for the instances. |
volumeClaimTemplate VolumeClaimTemplate |
VolumeClaimTemplate provides a template to define the Pod PVCs. |
podDisruptionBudget PodDisruptionBudget |
PodDisruptionBudget defines the budget for replica availability. |
updateStrategy StatefulSetUpdateStrategy |
PodDisruptionBudget defines the update strategy for the StatefulSet object. |
service ServiceTemplate |
Service defines templates to configure the general Service object. |
connection ConnectionTemplate |
Connection defines templates to configure the general Connection object. |
primaryService ServiceTemplate |
PrimaryService defines templates to configure the primary Service object. |
primaryConnection ConnectionTemplate |
PrimaryConnection defines templates to configure the primary Connection object. |
secondaryService ServiceTemplate |
SecondaryService defines templates to configure the secondary Service object. |
secondaryConnection ConnectionTemplate |
SecondaryConnection defines templates to configure the secondary Connection object. |
MaxScale is the Schema for the maxscales API. It is used to define MaxScale clusters.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
MaxScale |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec MaxScaleSpec |
MaxScaleAdmin configures the admin REST API and GUI.
Appears in:
| Field | Description |
|---|---|
port integer |
Port where the admin REST API and GUI will be exposed. |
guiEnabled boolean |
GuiEnabled indicates whether the admin GUI should be enabled. |
MaxScaleAuth defines the credentials required for MaxScale to connect to MariaDB.
Appears in:
| Field | Description |
|---|---|
generate boolean |
Generate defies whether the operator should generate users and grants for MaxScale to work. It only supports MariaDBs specified via spec.mariaDbRef. |
adminUsername string |
AdminUsername is an admin username to call the admin REST API. It is defaulted if not provided. |
adminPasswordSecretKeyRef SecretKeySelector |
AdminPasswordSecretKeyRef is Secret key reference to the admin password to call the admib REST API. It is defaulted if not provided. |
deleteDefaultAdmin boolean |
DeleteDefaultAdmin determines whether the default admin user should be deleted after the initial configuration. If not provided, it defaults to true. |
clientUsername string |
ClientUsername is the user to connect to MaxScale. It is defaulted if not provided. |
clientPasswordSecretKeyRef SecretKeySelector |
ClientPasswordSecretKeyRef is Secret key reference to the password to connect to MaxScale. It is defaulted if not provided. |
clientMaxConnections integer |
ClientMaxConnections defines the maximum number of connections that the client can establish. If HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections. It defaults to 30 times the number of MaxScale replicas. |
serverUsername string |
ServerUsername is the user used by MaxScale to connect to MariaDB server. It is defaulted if not provided. |
serverPasswordSecretKeyRef SecretKeySelector |
ServerPasswordSecretKeyRef is Secret key reference to the password used by MaxScale to connect to MariaDB server. It is defaulted if not provided. |
serverMaxConnections integer |
ServerMaxConnections defines the maximum number of connections that the server can establish. If HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections. It defaults to 30 times the number of MaxScale replicas. |
monitorUsername string |
MonitorUsername is the user used by MaxScale monitor to connect to MariaDB server. It is defaulted if not provided. |
monitorPasswordSecretKeyRef SecretKeySelector |
MonitorPasswordSecretKeyRef is Secret key reference to the password used by MaxScale monitor to connect to MariaDB server. It is defaulted if not provided. |
monitorMaxConnections integer |
MonitorMaxConnections defines the maximum number of connections that the monitor can establish. If HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections. It defaults to 30 times the number of MaxScale replicas. |
syncUsername string |
MonitoSyncUsernamerUsername is the user used by MaxScale config sync to connect to MariaDB server. It is defaulted when HA is enabled. |
syncPasswordSecretKeyRef SecretKeySelector |
SyncPasswordSecretKeyRef is Secret key reference to the password used by MaxScale config to connect to MariaDB server. It is defaulted when HA is enabled. |
syncMaxConnections integer |
SyncMaxConnections defines the maximum number of connections that the sync can establish. If HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections. It defaults to 30 times the number of MaxScale replicas. |
MaxScaleConfig defines the MaxScale configuration.
Appears in:
| Field | Description |
|---|---|
params object (keys:string, values:string) |
Params is a key value pair of parameters to be used in the MaxScale static configuration file. Any parameter supported by MaxScale may be specified here. See reference: https://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#global-settings. |
volumeClaimTemplate VolumeClaimTemplate |
VolumeClaimTemplate provides a template to define the PVCs for storing MaxScale runtime configuration files. It is defaulted if not provided. |
sync MaxScaleConfigSync |
Sync defines how to replicate configuration across MaxScale replicas. It is defaulted when HA is enabled. |
MaxScaleConfigSync defines how the config changes are replicated across replicas.
Appears in:
| Field | Description |
|---|---|
database string |
Database is the MariaDB logical database where the 'maxscale_config' table will be created in order to persist and synchronize config changes. If not provided, it defaults to 'mysql'. |
interval Duration |
Interval defines the config synchronization interval. It is defaulted if not provided. |
timeout Duration |
Interval defines the config synchronization timeout. It is defaulted if not provided. |
MaxScaleListener defines how the MaxScale server will listen for connections.
Appears in:
| Field | Description |
|---|---|
suspend boolean |
Suspend indicates whether the current resource should be suspended or not. Feature flag --feature-maxscale-suspend is required in the controller to enable this. |
name string |
Name is the identifier of the listener. It is defaulted if not provided |
port integer |
Port is the network port where the MaxScale server will listen. |
protocol string |
Protocol is the MaxScale protocol to use when communicating with the client. If not provided, it defaults to MariaDBProtocol. |
params object (keys:string, values:string) |
Params defines extra parameters to pass to the listener. Any parameter supported by MaxScale may be specified here. See reference: https://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#listener_1. |
MaxScaleMonitor monitors MariaDB server instances
Appears in:
| Field | Description |
|---|---|
suspend boolean |
Suspend indicates whether the current resource should be suspended or not. Feature flag --feature-maxscale-suspend is required in the controller to enable this. |
name string |
Name is the identifier of the monitor. It is defaulted if not provided. |
module MonitorModule |
Module is the module to use to monitor MariaDB servers. It is mandatory when no MariaDB reference is provided. |
interval Duration |
Interval used to monitor MariaDB servers. It is defaulted if not provided. |
cooperativeMonitoring CooperativeMonitoring |
CooperativeMonitoring enables coordination between multiple MaxScale instances running monitors. It is defaulted when HA is enabled. |
params object (keys:string, values:string) |
Params defines extra parameters to pass to the monitor. Any parameter supported by MaxScale may be specified here. See reference: https://mariadb.com/kb/en/mariadb-maxscale-2308-common-monitor-parameters/. Monitor specific parameter are also suported: https://mariadb.com/kb/en/mariadb-maxscale-2308-galera-monitor/#galera-monitor-optional-parameters. https://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-monitor/#configuration. |
MaxScaleServer defines a MariaDB server to forward traffic to.
Appears in:
| Field | Description |
|---|---|
name string |
Name is the identifier of the MariaDB server. |
address string |
Address is the network address of the MariaDB server. |
port integer |
Port is the network port of the MariaDB server. If not provided, it defaults to 3306. |
protocol string |
Protocol is the MaxScale protocol to use when communicating with this MariaDB server. If not provided, it defaults to MariaDBBackend. |
maintenance boolean |
Maintenance indicates whether the server is in maintenance mode. |
params object (keys:string, values:string) |
Params defines extra parameters to pass to the server. Any parameter supported by MaxScale may be specified here. See reference: https://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#server_1. |
Services define how the traffic is forwarded to the MariaDB servers.
Appears in:
| Field | Description |
|---|---|
suspend boolean |
Suspend indicates whether the current resource should be suspended or not. Feature flag --feature-maxscale-suspend is required in the controller to enable this. |
name string |
Name is the identifier of the MaxScale service. |
router ServiceRouter |
Router is the type of router to use. |
listener MaxScaleListener |
MaxScaleListener defines how the MaxScale server will listen for connections. |
params object (keys:string, values:string) |
Params defines extra parameters to pass to the monitor. Any parameter supported by MaxScale may be specified here. See reference: https://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#service_1. Router specific parameter are also suported: https://mariadb.com/kb/en/mariadb-maxscale-2308-readwritesplit/#configuration. https://mariadb.com/kb/en/mariadb-maxscale-2308-readconnroute/#configuration. |
MaxScaleSpec defines the desired state of MaxScale.
Appears in:
| Field | Description |
|---|---|
command string array |
Command to be used in the Container. |
args string array |
Args to be used in the Container. |
env EnvVar array |
Env represents the environment variables to be injected in a container. |
envFrom EnvFromSource array |
EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container. |
volumeMounts VolumeMount array |
VolumeMounts to be used in the Container. |
livenessProbe Probe |
LivenessProbe to be used in the Container. |
readinessProbe Probe |
ReadinessProbe to be used in the Container. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
initContainers Container array |
InitContainers to be used in the Pod. |
sidecarContainers Container array |
SidecarContainers to be used in the Pod. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccountName string |
ServiceAccountName is the name of the ServiceAccount to be used by the Pods. |
affinity Affinity |
Affinity to be used in the Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the Pod. |
tolerations Toleration array |
Tolerations to be used in the Pod. |
volumes Volume array |
Volumes to be used in the Pod. |
priorityClassName string |
PriorityClassName to be used in the Pod. |
topologySpreadConstraints TopologySpreadConstraint array |
TopologySpreadConstraints to be used in the Pod. |
mariaDbRef MariaDBRef |
MariaDBRef is a reference to the MariaDB that MaxScale points to. It is used to initialize the servers field. |
servers MaxScaleServer array |
Servers are the MariaDB servers to forward traffic to. It is required if 'spec.mariaDbRef' is not provided. |
image string |
Image name to be used by the MaxScale instances. The supported format is <image>:<tag>. Only MaxScale official images are supported. |
imagePullPolicy PullPolicy |
ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent. |
imagePullSecrets LocalObjectReference array |
ImagePullSecrets is the list of pull Secrets to be used to pull the image. |
services MaxScaleService array |
Services define how the traffic is forwarded to the MariaDB servers. It is defaulted if not provided. |
monitor MaxScaleMonitor |
Monitor monitors MariaDB server instances. It is required if 'spec.mariaDbRef' is not provided. |
admin MaxScaleAdmin |
Admin configures the admin REST API and GUI. |
config MaxScaleConfig |
Config defines the MaxScale configuration. |
auth MaxScaleAuth |
Auth defines the credentials required for MaxScale to connect to MariaDB. |
connection ConnectionTemplate |
Connection provides a template to define the Connection for MaxScale. |
replicas integer |
Replicas indicates the number of desired instances. |
podDisruptionBudget PodDisruptionBudget |
PodDisruptionBudget defines the budget for replica availability. |
updateStrategy StatefulSetUpdateStrategy |
UpdateStrategy defines the update strategy for the StatefulSet object. |
kubernetesService ServiceTemplate |
Service defines templates to configure the Kubernetes Service object. |
requeueInterval Duration |
RequeueInterval is used to perform requeue reconcilizations. If not defined, it defaults to 10s. |
Metrics defines the metrics for a MariaDB.
Appears in:
| Field | Description |
|---|---|
enabled boolean |
Enabled is a flag to enable Metrics |
exporter Exporter |
Exporter defines the metrics exporter container. |
serviceMonitor ServiceMonitor |
ServiceMonitor defines the ServiceMonior object. |
username string |
Username is the username of the monitoring user used by the exporter. |
passwordSecretKeyRef SecretKeySelector |
PasswordSecretKeyRef is a reference to the password of the monitoring user used by the exporter. |
Underlying type: string
MonitorModule defines the type of monitor module
Appears in:
PodDisruptionBudget is the Pod availability bundget for a MariaDB
Appears in:
| Field | Description |
|---|---|
minAvailable IntOrString |
MinAvailable defines the number of minimum available Pods. |
maxUnavailable IntOrString |
MaxUnavailable defines the number of maximum unavailable Pods. |
PodTemplate defines a template to configure Container objects.
Appears in:
| Field | Description |
|---|---|
initContainers Container array |
InitContainers to be used in the Pod. |
sidecarContainers Container array |
SidecarContainers to be used in the Pod. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
serviceAccountName string |
ServiceAccountName is the name of the ServiceAccount to be used by the Pods. |
affinity Affinity |
Affinity to be used in the Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the Pod. |
tolerations Toleration array |
Tolerations to be used in the Pod. |
volumes Volume array |
Volumes to be used in the Pod. |
priorityClassName string |
PriorityClassName to be used in the Pod. |
topologySpreadConstraints TopologySpreadConstraint array |
TopologySpreadConstraints to be used in the Pod. |
PrimaryGalera is the Galera configuration for the primary node.
Appears in:
| Field | Description |
|---|---|
podIndex integer |
PodIndex is the StatefulSet index of the primary node. The user may change this field to perform a manual switchover. |
automaticFailover boolean |
AutomaticFailover indicates whether the operator should automatically update PodIndex to perform an automatic primary failover. |
PrimaryReplication is the replication configuration for the primary node.
Appears in:
| Field | Description |
|---|---|
podIndex integer |
PodIndex is the StatefulSet index of the primary node. The user may change this field to perform a manual switchover. |
automaticFailover boolean |
AutomaticFailover indicates whether the operator should automatically update PodIndex to perform an automatic primary failover. |
ReplicaReplication is the replication configuration for the replica nodes.
Appears in:
| Field | Description |
|---|---|
waitPoint WaitPoint |
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. |
gtid Gtid |
Gtid indicates which Global Transaction ID should be used when connecting a replica to the master. See: https://mariadb.com/kb/en/gtid/#using-current_pos-vs-slave_pos. |
replPasswordSecretKeyRef SecretKeySelector |
ReplPasswordSecretKeyRef provides a reference to the Secret to use as password for the replication user. |
connectionTimeout Duration |
ConnectionTimeout to be used when the replica connects to the primary. |
connectionRetries integer |
ConnectionRetries to be used when the replica connects to the primary. |
syncTimeout Duration |
SyncTimeout defines the timeout for a replica to be synced with the primary when performing a primary switchover. If the timeout is reached, the replica GTID will be reset and the switchover will continue. |
Replication allows you to enable single-master HA via semi-synchronours replication in your MariaDB cluster.
Appears in:
| Field | Description |
|---|---|
primary PrimaryReplication |
Primary is the replication configuration for the primary node. |
replica ReplicaReplication |
ReplicaReplication is the replication configuration for the replica nodes. |
syncBinlog boolean |
SyncBinlog indicates whether the binary log should be synchronized to the disk after every event. It trades off performance for consistency. See: https://mariadb.com/kb/en/replication-and-binary-log-system-variables/#sync_binlog. |
probesEnabled boolean |
ProbesEnabled indicates to use replication specific liveness and readiness probes. This probes check that the primary can receive queries and that the replica has the replication thread running. |
enabled boolean |
Enabled is a flag to enable Replication. |
ReplicationSpec is the Replication desired state specification.
Appears in:
| Field | Description |
|---|---|
primary PrimaryReplication |
Primary is the replication configuration for the primary node. |
replica ReplicaReplication |
ReplicaReplication is the replication configuration for the replica nodes. |
syncBinlog boolean |
SyncBinlog indicates whether the binary log should be synchronized to the disk after every event. It trades off performance for consistency. See: https://mariadb.com/kb/en/replication-and-binary-log-system-variables/#sync_binlog. |
probesEnabled boolean |
ProbesEnabled indicates to use replication specific liveness and readiness probes. This probes check that the primary can receive queries and that the replica has the replication thread running. |
Underlying type: string
Appears in:
Restore is the Schema for the restores API. It is used to define restore jobs and its restoration source.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
Restore |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec RestoreSpec |
RestoreSource defines a source for restoring a MariaDB.
Appears in:
| Field | Description |
|---|---|
backupRef LocalObjectReference |
BackupRef is a reference to a Backup object. It has priority over S3 and Volume. |
s3 S3 |
S3 defines the configuration to restore backups from a S3 compatible storage. It has priority over Volume. |
volume VolumeSource |
Volume is a Kubernetes Volume object that contains a backup. |
targetRecoveryTime Time |
TargetRecoveryTime is a RFC3339 (1970-01-01T00:00:00Z) date and time that defines the point in time recovery objective. It is used to determine the closest restoration source in time. |
RestoreSpec defines the desired state of restore
Appears in:
| Field | Description |
|---|---|
backupRef LocalObjectReference |
BackupRef is a reference to a Backup object. It has priority over S3 and Volume. |
s3 S3 |
S3 defines the configuration to restore backups from a S3 compatible storage. It has priority over Volume. |
volume VolumeSource |
Volume is a Kubernetes Volume object that contains a backup. |
targetRecoveryTime Time |
TargetRecoveryTime is a RFC3339 (1970-01-01T00:00:00Z) date and time that defines the point in time recovery objective. It is used to determine the closest restoration source in time. |
mariaDbRef MariaDBRef |
MariaDBRef is a reference to a MariaDB object. |
args string array |
Args to be used in the Restore container. |
logLevel string |
LogLevel to be used n the Backup Job. It defaults to 'info'. |
backoffLimit integer |
BackoffLimit defines the maximum number of attempts to successfully perform a Backup. |
restartPolicy RestartPolicy |
RestartPolicy to be added to the Backup Job. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
affinity Affinity |
Affinity to be used in the Restore Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the Restore Pod. |
tolerations Toleration array |
Tolerations to be used in the Restore Pod. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
Appears in:
| Field | Description |
|---|---|
bucket string |
Bucket is the name Name of the bucket to store backups. |
endpoint string |
Endpoint is the S3 API endpoint without scheme. |
region string |
Region is the S3 region name to use. |
prefix string |
Prefix allows backups to be placed under a specific prefix in the bucket. |
accessKeyIdSecretKeyRef SecretKeySelector |
AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 access key id. |
secretAccessKeySecretKeyRef SecretKeySelector |
AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 secret key. |
sessionTokenSecretKeyRef SecretKeySelector |
SessionTokenSecretKeyRef is a reference to a Secret key containing the S3 session token. |
tls TLS |
TLS provides the configuration required to establish TLS connections with S3. |
SQLTemplate defines a template to customize SQL objects.
Appears in:
| Field | Description |
|---|---|
requeueInterval Duration |
RequeueInterval is used to perform requeue reconcilizations. |
retryInterval Duration |
RetryInterval is the interval used to perform retries. |
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:
| Field | Description |
|---|---|
cron string |
Cron is a cron expression that defines the schedule. |
suspend boolean |
Suspend defines whether the schedule is active or not. |
SecretTemplate defines a template to customize Secret objects.
Appears in:
| Field | Description |
|---|---|
labels object (keys:string, values:string) |
Labels to be added to the Secret object. |
annotations object (keys:string, values:string) |
Annotations to be added to the Secret object. |
key string |
Key to be used in the Secret. |
format string |
Format to be used in the Secret. |
usernameKey string |
UsernameKey to be used in the Secret. |
passwordKey string |
PasswordKey to be used in the Secret. |
hostKey string |
HostKey to be used in the Secret. |
portKey string |
PortKey to be used in the Secret. |
databaseKey string |
DatabaseKey to be used in the Secret. |
ServiceMonitor defines a prometheus ServiceMonitor object.
Appears in:
| Field | Description |
|---|---|
prometheusRelease string |
PrometheusRelease is the release label to add to the ServiceMonitor object. |
jobLabel string |
JobLabel to add to the ServiceMonitor object. |
interval string |
Interval for scraping metrics. |
scrapeTimeout string |
ScrapeTimeout defines the timeout for scraping metrics. |
Underlying type: string
ServiceRouter defines the type of service router.
Appears in:
ServiceTemplate defines a template to customize Service objects.
Appears in:
| Field | Description |
|---|---|
type ServiceType |
Type is the Service type. One of ClusterIP, NodePort or LoadBalancer. If not defined, it defaults to ClusterIP. |
labels object (keys:string, values:string) |
Labels to add to the Service metadata. |
annotations object (keys:string, values:string) |
Annotations to add to the Service metadata. |
loadBalancerIP string |
LoadBalancerIP Service field. |
loadBalancerSourceRanges string array |
LoadBalancerSourceRanges Service field. |
externalTrafficPolicy ServiceExternalTrafficPolicy |
ExternalTrafficPolicy Service field. |
sessionAffinity ServiceAffinity |
SessionAffinity Service field. |
allocateLoadBalancerNodePorts boolean |
AllocateLoadBalancerNodePorts Service field. |
SqlJob is the Schema for the sqljobs API. It is used to run sql scripts as jobs.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
SqlJob |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec SqlJobSpec |
SqlJobSpec defines the desired state of SqlJob
Appears in:
| Field | Description |
|---|---|
mariaDbRef MariaDBRef |
MariaDBRef is a reference to a MariaDB object. |
schedule Schedule |
Schedule defines when the SqlJob will be executed. |
username string |
Username to be impersonated when executing the SqlJob. |
passwordSecretKeyRef SecretKeySelector |
UserPasswordSecretKeyRef is a reference to the impersonated user's password to be used when executing the SqlJob. |
database string |
Username to be used when executing the SqlJob. |
dependsOn LocalObjectReference array |
DependsOn defines dependencies with other SqlJob objectecs. |
sql string |
Sql is the script to be executed by the SqlJob. |
sqlConfigMapKeyRef ConfigMapKeySelector |
SqlConfigMapKeyRef is a reference to a ConfigMap containing the Sql script. It is defaulted to a ConfigMap with the contents of the Sql field. |
backoffLimit integer |
BackoffLimit defines the maximum number of attempts to successfully execute a SqlJob. |
restartPolicy RestartPolicy |
RestartPolicy to be added to the SqlJob Pod. |
resources ResourceRequirements |
Resouces describes the compute resource requirements. |
affinity Affinity |
Affinity to be used in the SqlJob Pod. |
nodeSelector object (keys:string, values:string) |
NodeSelector to be used in the SqlJob Pod. |
tolerations Toleration array |
Tolerations to be used in the SqlJob Pod. |
securityContext SecurityContext |
SecurityContext holds security configuration that will be applied to a container. |
podSecurityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. |
SuspendTemplate indicates whether the current resource should be suspended or not. Feature flag --feature-maxscale-suspend is required in the controller to enable this.
Appears in:
| Field | Description |
|---|---|
suspend boolean |
Suspend indicates whether the current resource should be suspended or not. Feature flag --feature-maxscale-suspend is required in the controller to enable this. |
Appears in:
| Field | Description |
|---|---|
enabled boolean |
Enabled is a flag to enable TLS. |
caSecretKeyRef SecretKeySelector |
CASecretKeyRef is a reference to a Secret key containing a CA bundle in PEM format used to establish TLS connections with S3. |
User is the Schema for the users API. It is used to define grants as if you were running a 'CREATE USER' statement.
| Field | Description |
|---|---|
apiVersion string |
mariadb.mmontes.io/v1alpha1 |
kind string |
User |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec UserSpec |
UserSpec defines the desired state of User
Appears in:
| Field | Description |
|---|---|
requeueInterval Duration |
RequeueInterval is used to perform requeue reconcilizations. |
retryInterval Duration |
RetryInterval is the interval used to perform retries. |
mariaDbRef MariaDBRef |
MariaDBRef is a reference to a MariaDB object. |
passwordSecretKeyRef SecretKeySelector |
PasswordSecretKeyRef is a reference to the password to be used by the User. |
maxUserConnections integer |
MaxUserConnections defines the maximum number of connections that the User can establish. |
name string |
Name overrides the default name provided by metadata.name. |
host string |
Host related to the User. |
VolumeClaimTemplate defines a template to customize PVC objects.
Appears in:
| Field | Description |
|---|---|
accessModes PersistentVolumeAccessMode array |
accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
selector LabelSelector |
selector is a label query over volumes to consider for binding. |
resources ResourceRequirements |
resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
volumeName string |
volumeName is the binding reference to the PersistentVolume backing this claim. |
storageClassName string |
storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeMode PersistentVolumeMode |
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
dataSource TypedLocalObjectReference |
dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. |
dataSourceRef TypedObjectReference |
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. |
labels object (keys:string, values:string) |
Labels to be used in the PVC. |
annotations object (keys:string, values:string) |
Annotations to be used in the PVC. |
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: