mariadb-operator
0.37.1 is here! 🦭
We're excited to introduce TLS 🔐 support in this release, one of the major features of mariadb-operator
so far! ✨ Check out the TLS docs, our example catalog and the release notes below to start using it.
Warning
Be sure to follow the UPGRADE GUIDE to ensure a seamless transition from previous versions.
Issue certificates for MariaDB
and MaxScale
Issuing and configuring TLS certificates for your instances has never been easier, you just need to set tls.enabled=true
:
apiVersion: k8s.mariadb.com/v1alpha1
kind: MariaDB
metadata:
name: mariadb-galera
spec:
...
tls:
enabled: true
apiVersion: k8s.mariadb.com/v1alpha1
kind: MaxScale
metadata:
name: maxscale
spec:
...
mariaDbRef:
name: mariadb-galera
tls:
enabled: true
A self-signed Certificate Authority (CA) will be automatically generated to issue leaf certificates for your instances. The operator will also manage a CA bundle that your applications can use in order to establish trust.
TLS will be enabled by default in MariaDB
, but it will not enforced. You can enforce TLS connections by setting tls.required=true
to ensure that all connections are encrypted. In the case of MaxScale
, TLS will only be enabled if you explicitly set tls.enabled=true
or the referred MariaDB
(via mariaDbRef
) instance enforces TLS.
Native integration with cert-manager
cert-manager is the de facto standard for managing certificates in Kubernetes. This certificate controller simplifies the automatic provisioning, management, and renewal of certificates. It supports a variety of certificate backends (e.g. in-cluster, Hashicorp Vault), which are configured using Issuer
or ClusterIssuer
resources.
In your MariaDB
and MaxScale
resources, you can directly reference ClusterIssuer
or Issuer
objects to seamlessly issue certificates:
apiVersion: k8s.mariadb.com/v1alpha1
kind: MariaDB
metadata:
name: mariadb-galera
spec:
...
tls:
enabled: true
serverCertIssuerRef:
name: root-ca
kind: ClusterIssuer
clientCertIssuerRef:
name: root-ca
kind: ClusterIssuer
apiVersion: k8s.mariadb.com/v1alpha1
kind: MaxScale
metadata:
name: maxscale-galera
spec:
...
tls:
enabled: true
adminCertIssuerRef:
name: root-ca
kind: ClusterIssuer
listenerCertIssuerRef:
name: root-ca
kind: ClusterIssuer
Under the scenes, the operator will create cert-manager's Certificate
resources with all the required Subject Alternative Names (SANs) required by your instances. These certificates will be automatically managed by cert-manager and the CA bundle will be updated by the operator so you can establish trust with your instances.
The advantage of this approach is that you can use any of the cert-manager's certificate backends, such as the in-cluster CA or HashiCorp Vault, and potentially reuse the same Issuer
/ClusterIssuer
with multiple instances.
Certificate rotation
Whether the certificates are managed by the operator or by cert-manager, they will be automatically renewed before expiration. Additionally, the operator will update the CA bundle whenever the CAs are rotated, temporarily retaining the old CA in the bundle to ensure a seamless update process.
In both scenarios, the standard update strategies apply, allowing you to control how the Pods
are restarted during certificate rotation.
TLS requirements for Users
We have extended our User
SQL resource to include TLS-specific requirements for user connections over TLS. For example, if you want to enforce the use of a valid x509 certificate for a user to connect:
apiVersion: k8s.mariadb.com/v1alpha1
kind: User
metadata:
name: user
spec:
...
require:
x509: true
To restrict the subject of the user's certificate and/or require a specific issuer, you may set:
apiVersion: k8s.mariadb.com/v1alpha1
kind: User
metadata:
name: user
spec:
...
require:
issuer: "/CN=mariadb-galera-ca"
subject: "/CN=mariadb-galera-client"
If any of these TLS requirements are not satisfied, the user will be unable to connect to the instance.
Automatic updates when Galera options are changed
Whenever Galera options are changed, for example, adding providerOptions
:
apiVersion: k8s.mariadb.com/v1alpha1
kind: MariaDB
metadata:
name: mariadb-galera
spec:
...
galera:
enabled: true
+ providerOptions:
+ gcs.fc_limit: '64'
An update is now automatically triggered, and the Pods
are restarted according to the configured update strategy.
Community contributions
- Support startupProbe in MariaDB and MaxScale by @vixns
- Prevent deadlocks on Database reconcile while transactions are running by @vixns
- Update CronJob template on reconcile by @vixns
- Operator configuration via helm by @sakazuki and @indigo-saito
- Support EKS Service Accounts in S3 by @Skaronator
- Add support for configuring priorityClassName, topologySpreadConstraints, PDB in Helm Chart by @Skaronator
- Exclude dollar signs from generated passwords by @simonhammes
- Fix examples SqlJob secret reference by @driv
- FLUSH PRIVILEGES unnecessary for user/grant manipulation by @grooverdan
Huge thanks to our awesome contributors! 🙇
We value your feedback! If you encounter any issues or have suggestions, please open an issue on GitHub. Your input is crucial to improve mariadb-operator
🦭.
Join us on Slack: MariaDB Community Slack.
What's Changed
- Fix TLS defaults in embedded
MaxScale
by @mmontes11 in #1143
Full Changelog: 0.37.0...0.37.1