Configure TLS

This guide explains how to use the TLS Configure interface to manage TLS settings for your database. You can update TLS certificates, rotate existing ones, or remove TLS entirely — all managed through a OpsRequest that is applied safely to your cluster.


1. Getting Started

To begin, select TLS Configure from the Operations section in the left sidebar.

You will land on the TLS Configure form, which is divided into the following sections:

  • TLS Operation — Choose the type of TLS action to perform.
  • Remove TLS — Toggle to strip TLS from the database entirely.
  • Rotate Certificates — Toggle to force certificate rotation.
  • Issuer Reference — Specify the cert-manager issuer to use.
  • Certificates — Define one or more certificates with custom subject and SAN details.
  • OpsRequest Options — Configure timeout and apply policy for the operation.

TLS Configure form showing all sections including TLS Operation, Issuer Reference, Certificates, and OpsRequest Options


2. Configuring the TLS Operation

2.1 - Select a TLS Operation

Under TLS Operation, choose the action you want to perform:

  • Update — Add or update TLS configuration on the database. Use this to enable TLS for the first time or to change existing certificate settings.
  • Rotate — Force a rotation of the current TLS certificates without changing the configuration.
  • Remove — Strip TLS from the database entirely.

The Remove TLS and Rotate Certificates toggles act as quick shortcuts for those specific operations without changing any other settings.

2.2 - Configure the Issuer Reference

Expand the Issuer Reference panel to specify which cert-manager issuer should sign the certificates.

  1. API Group: The cert-manager API group (e.g., Defaults to cert-manager.io).
  2. Kind: Select the type of issuer — typically ClusterIssuer for cluster-wide issuers or Issuer for namespace-scoped ones.
  3. Name: Enter the name of the issuer (e.g., ace-incluster).

TLS Configure form filled with Operation set to Update and Issuer Reference expanded showing ClusterIssuer ace-incluster

Note: The Issuer Reference is required when the Update operation is selected. Ensure the issuer exists in your cluster before proceeding.


3. Adding Certificates

The Certificates section allows you to define one or more certificates that will be managed by the TLS configuration. Click + Add new to add a certificate entry.

Certificates panel showing an empty certificate entry with all available fields

Each certificate entry contains the following fields:

FieldDescription
AliasThe role of the certificate. Required — select from the dropdown.
Secret NameThe Kubernetes secret where the certificate will be stored.
DurationThe validity period of the certificate (e.g., 8760h for one year).
Renew BeforeHow long before expiry the certificate should be renewed (e.g., 360h).
OrganizationsOne or more organization names for the certificate subject.
CountriesOne or more country codes for the certificate subject.
Organizational UnitsOrganizational unit names for the certificate subject.
ProvincesProvince or state names for the certificate subject.
DNS NamesSubject Alternative Names (SANs) as DNS hostnames.
IP AddressesSubject Alternative Names (SANs) as IP addresses.

Use the + Add new button next to each subject field to add multiple values. Use the Delete button at the bottom of an entry to remove a certificate.

3.1 - Selecting the Certificate Alias

The Alias dropdown identifies the role of the certificate within the database. The available options are:

  • server — The certificate used by the database server for incoming TLS connections.
  • client — The certificate used by clients connecting to the database.
  • metrics-exporter — The certificate used by the metrics exporter for secure scraping.

Certificates panel showing the Alias dropdown expanded with server, client, and metrics-exporter options, and sample Organizations and Countries fields filled in

Note: Fields marked with a red asterisk are required. The filed with + Add new button validates entries on input — leaving an added row empty will show an "Item cannot be empty" warning. Also You can add multiple instance of them.


4. Review and Submit

Once all sections are configured, click Preview to review the generated OpsRequest manifest before applying it if preview is enabled. Then:

  • The manifest is shown in YAML view by default. Use the JSON button to switch to JSON format if preferred.
  • Use the Copy button to copy the manifest to your clipboard.
  • Click Previous to go back and adjust your settings if needed.

Tip: You can directly edit the YAML or JSON on the Preview page before submitting. This is useful for making precise adjustments beyond what the form fields expose.

  1. Submit: Once satisfied, click Submit to apply the TLS configuration to your database.

Note: After submitting, a OpsRequest of type ReconfigureTLS will be created in your cluster.


Quick Reference

ActionHow to do it
Enable or update TLSSelect Update under TLS Operation → configure Issuer Reference → add Certificates → PreviewSubmit
Rotate existing certificatesSelect Rotate under TLS Operation (or toggle Rotate Certificates) → PreviewSubmit
Remove TLS from the databaseSelect Remove under TLS Operation (or toggle Remove TLS) → PreviewSubmit
Add a certificateCertificates+ Add new → fill in Alias, fields, and SANs
Remove a certificate entryClick Delete at the bottom of the certificate entry
Edit manifest before applyingUse the YAML / JSON toggle on the Preview page
Apply the TLS changeClick Submit on the Preview page