Manage TLS Certificates for Confluent Platform Using Confluent for Kubernetes
This topic describes how to manage Transport Layer Security (TLS) certificates for Confluent Platform using Confluent for Kubernetes (CFK).
Requirements and considerations
Plan rotation before certificate expiry.
There should be an overlap window between new and old certificates during the renewal process.
Test the rotation process first in a lower-tier, non-production environment.
Rotate user-provided server certificates
In CFK, to rotate user-provided certificates that have been provided as Kubernetes secrets, you can update the contents of the Kubernetes secrets.
For example, to rotate the server certificates that you provided in .pem
files:
Update the
server.pemcertificate andserver-key.pemcertificate private key.Update the Kubernetes secret using the following command:
kubectl create secret generic component-tls \ --from-file=fullchain.pem=server.pem \ --from-file=cacerts.pem=ca.pem \ --from-file=privkey.pem=server-key.pem \ --save-config --dry-run=client -oyaml | \ kubectl apply -f -
CFK will watch for the Kubernetes secret changes, will notice that the content has changed, and will then perform a rolling restart of the component to configure the new server certificate.
Note that CFK only watches the secrets provided in the .pem format. This
feature is not supported for the secrets provided in the .jks format.
Rotate LDAP server certificates used by MDS
If you use LDAP or LDAPS for role-based access control (RBAC) with Metadata Service (MDS), the Kafka brokers trust the LDAP server certificate through the LDAP truststore. Use the guidance in this section to rotate the LDAP server certificate or its CA without breaking authentication to MDS.
For more information about configuring MDS with LDAP, see Configure authentication to access MDS.
Renew the LDAP server certificate under the same CA
If the broker truststore contains the issuing or root CA chain, renewing the LDAP server leaf certificate shouldn’t require a truststore change.
Trust the CA chain instead of pinning the LDAP leaf certificate.
If the truststore contains only the current LDAP server certificate, the brokers don’t trust a renewed certificate and MDS authentication fails. In that case, add the CA chain to the truststore secret and wait for the roll to finish before you renew the certificate. For more details, see Rotate the LDAP CA.
Rotate the LDAP CA
To rotate the CA that issues the LDAP server certificate, keep the old and new CAs trusted during the transition:
Update the LDAP truststore secret to contain both the current CA certificate and the new CA certificate.
Don’t change the LDAP server certificate yet.
Wait for CFK to roll the brokers and load the updated truststore. Keep the LDAP server on the old certificate while the roll runs.
Confirm the roll is healthy. Check that all broker pods restarted and are ready.
Switch the LDAP server to the certificate issued by the new CA.
The certificate’s subject alternative names must include the hostname in the LDAP address configured for MDS. MDS verifies the hostname, and a mismatch fails authentication on every broker.
In a later, separate change, remove the old CA certificate from the LDAP truststore secret and roll the brokers again.
Don’t combine this step with the previous steps.
Manage auto-generated certificates
To manage auto-generated certificates in Confluent for Kubernetes (CFK), use the following annotations in the Confluent Platform component CRs.
Force a renewal of auto-generated certificates:
kubectl annotate <Component CR type> <Component CR name> \ platform.confluent.io/force-managed-cert-renewal="true"
The annotation triggers a reconciliation on the Confluent Platform component. The process causes the certificates to be renewed, and the component to be rolled.
After the certificates are renewed, the annotation is reset to
false.Add additional custom SAN for auto-generated certificates. This will be added to SANs defined at the global level in
managedCerts.sansin the CFK Helm values (in values.yaml).kubectl annotate secret ca-pair-sslcerts \ platform.confluent.io/managed-cert-add-sans="<Comma separated list of SANs>"
For example, the following annotation will add the SANs,
kafka.operator,kafka.operator.local, to auto-generated certificates for Kafka:kubectl annotate secret ca-pair-sslcerts \ platform.confluent.io/managed-cert-add-sans="kafka.operator, kafka.operator.local"
After the annotation is set, use the
platform.confluent.io/force-managed-cert-renewal="true"annotation to force a renewal of certificates. If not forced, SANs will be updated during the next reconciliation.Specify the Kubernetes secret name for the CA certificates at the CR level. This will override the global config defined in
managedCerts.caCertificatein the CFK Helm values (in values.yaml). This can be used even ifmanagedCerts.enableis set tofalse.kubectl annotate <Component CR type> <Component CR name> \ platform.confluent.io/managed-cert-ca-pair-secret=<Secret name>
The secret should have
tls.crtandtls.keywith the CA certificate and key.Configure the optional settings for auto-generated certificates at the CR level:
kubectl annotate <Component CR type> <Component CR name> \ platform.confluent.io/managed-cert-duration-in-days=<Number of days>
kubectl annotate <Component CR type> <Component CR name> \ platform.confluent.io/managed-cert-renew-before-in-days=<Number of days>
For example:
kubectl annotate kafka kafka platform.confluent.io/managed-cert-duration-in-days=60 kubectl annotate kafka kafka platform.confluent.io/managed-cert-renew-before-in-days=30
After the annotations are set, use the
platform.confluent.io/force-managed-cert-renewal="true"to force a renewal of certificates.