ExternalMariaDB
k8s.mariadb.com / v1alpha1
apiVersion: k8s.mariadb.com/v1alpha1
kind: ExternalMariaDB
metadata:
name: example
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
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
metadata
object
spec object required
ExternalMariaDBSpec defines the desired state of an External MariaDB
connection object
Connection defines a template to configure a Connection for the external MariaDB.
healthCheck object
HealthCheck to be used in the Connection.
interval
string
Interval used to perform health checks.
retryInterval
string
RetryInterval is the interval used to perform health check retries.
params
object
Params 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.
format:
int32
secretName
string
SecretName to be used in the Connection.
secretTemplate object
SecretTemplate to be used in the Connection.
databaseKey
string
DatabaseKey to be used in the Secret.
format
string
Format to be used in the Secret.
hostKey
string
HostKey to be used in the Secret.
key
string
Key to be used in the Secret.
metadata object
Metadata to be added to the Secret object.
annotations
object
Annotations to be added to children resources.
labels
object
Labels to be added to children resources.
passwordKey
string
PasswordKey to be used in the Secret.
portKey
string
PortKey to be used in the Secret.
usernameKey
string
UsernameKey to be used in the Secret.
serviceName
string
ServiceName to be used in the Connection.
host
string required
Hostname of the external MariaDB.
image
string
Image name to be used to perform operations on the external MariaDB, for example, for taking backups.
The supported format is `<image>:<tag>`. Only MariaDB official images are supported.
If not provided, the MariaDB image version be inferred by the operator in runtime. The default MariaDB image will be used in this case,
imagePullPolicy
string
ImagePullPolicy is the image pull policy. One of `Always`, `Never` or `IfNotPresent`. If not defined, it defaults to `IfNotPresent`.
enum:
Always, Never, IfNotPresentimagePullSecrets []object
ImagePullSecrets is the list of pull Secrets to be used to pull the image.
name
string
inheritMetadata object
InheritMetadata defines the metadata to be inherited by children resources.
annotations
object
Annotations to be added to children resources.
labels
object
Labels to be added to children resources.
passwordSecretKeyRef object
PasswordSecretKeyRef is a reference to the password to connect to the external MariaDB.
key
string required
name
string
port
integer
Port of the external MariaDB.
format:
int32tls object
TLS defines the PKI to be used with the external MariaDB.
clientCASecretRef object
ClientCASecretRef is a reference to a Secret containing the client certificate authority keypair. It is used to establish trust and issue client certificates.
One of:
- Secret containing both the 'ca.crt' and 'ca.key' keys. This allows you to bring your own CA to Kubernetes to issue certificates.
- Secret containing only the 'ca.crt' in order to establish trust. In this case, either clientCertSecretRef or clientCertIssuerRef fields must be provided.
If not provided, a self-signed CA will be provisioned to issue the client certificate.
name
string
clientCertIssuerRef object
ClientCertIssuerRef is a reference to a cert-manager issuer object used to issue the client certificate. cert-manager must be installed previously in the cluster.
It is mutually exclusive with clientCertSecretRef.
By default, the Secret field 'ca.crt' provisioned by cert-manager will be added to the trust chain. A custom trust bundle may be specified via clientCASecretRef.
group
string
Group of the issuer being referred to.
Defaults to 'cert-manager.io'.
kind
string
Kind of the issuer being referred to.
Defaults to 'Issuer'.
name
string required
Name of the issuer being referred to.
clientCertSecretRef object
ClientCertSecretRef is a reference to a TLS Secret containing the client certificate.
It is mutually exclusive with clientCertIssuerRef.
name
string
enabled
boolean
Enabled indicates whether TLS is enabled, determining if certificates should be issued and mounted to the MariaDB instance.
It is enabled by default.
galeraSSTEnabled
boolean
GaleraSSTEnabled determines whether Galera SST connections should use TLS.
It disabled by default.
mutual
boolean
Mutual specifies whether TLS must be mutual between server and client for external connections.
When set to false, the client certificate will not be sent during the TLS handshake.
It is enabled by default.
required
boolean
Required specifies whether TLS must be enforced for all connections.
User TLS requirements take precedence over this.
It disabled by default.
serverCASecretRef object
ServerCASecretRef is a reference to a Secret containing the server certificate authority keypair. It is used to establish trust and issue server certificates.
One of:
- Secret containing both the 'ca.crt' and 'ca.key' keys. This allows you to bring your own CA to Kubernetes to issue certificates.
- Secret containing only the 'ca.crt' in order to establish trust. In this case, either serverCertSecretRef or serverCertIssuerRef must be provided.
If not provided, a self-signed CA will be provisioned to issue the server certificate.
name
string
serverCertAdditionalNames
[]string
ServerCertAdditionalNames is a list of additional certificate common names
serverCertIssuerRef object
ServerCertIssuerRef is a reference to a cert-manager issuer object used to issue the server certificate. cert-manager must be installed previously in the cluster.
It is mutually exclusive with serverCertSecretRef.
By default, the Secret field 'ca.crt' provisioned by cert-manager will be added to the trust chain. A custom trust bundle may be specified via serverCASecretRef.
group
string
Group of the issuer being referred to.
Defaults to 'cert-manager.io'.
kind
string
Kind of the issuer being referred to.
Defaults to 'Issuer'.
name
string required
Name of the issuer being referred to.
serverCertSecretRef object
ServerCertSecretRef is a reference to a TLS Secret containing the server certificate.
It is mutually exclusive with serverCertIssuerRef.
name
string
username
string required
Username is the username to connect to the external MariaDB.
status object
ExternalMariaDBStatus defines the observed state of MariaDB
conditions []object
Conditions for the ExternalMariadb object.
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316
isGaleraEnabled
boolean
IsGaleraEnabled indicates that the external MariaDb has Galera enabled.
version
string
Version of the external MariaDB server.
No matches. Try .spec.connection for an exact path