Skip to content

Rate this page
Thanks for your feedback
Thank you! The feedback has been submitted.

Get free database assistance or contact our experts for personalized support.

Configure data-at-rest encryption with HashiCorp Vault

This document guides you through setting up data-at-rest encryption with pg_tde and HashiCorp Vault as the key provider. To learn more about data-at-rest encryption and how it works, see Data-at-rest encryption.

Assumptions

  1. This guide is provided as a best effort and builds upon procedures described in the official Vault documentation. Since Vault’s setup steps may change in future releases, this document may become outdated; we cannot guarantee ongoing accuracy or responsibility for such changes. For the most up-to-date and reliable information, please always refer to the official Vault documentation.
  2. In the following sections we deploy the Vault server in High Availability (HA) mode on Kubernetes via Helm with TLS enabled. The HA setup uses Raft storage backend and consists of 3 replicas for redundancy. Using Helm is not mandatory. Any supported Vault deployment (on-premises, in the cloud, or a managed Vault service) works as long as the Operator can reach it.
  3. This guide uses Vault Helm chart version 0.30.0. You may want to change it to the required version by setting the VAULT_HELM_VERSION variable.

Prerequisites

To configure data-at-rest encryption, you need the following:

  • kubectl- Kubernetes command-line interface
  • helm - Helm package manager
  • jq - JSON processor
  • The Operator and Percona Distribution for PostgreSQL installed.

Prepare your environment

  1. Create the namespaces for Vault and the database cluster. If you have installed the Operator and Percona Distribution for PostgreSQL, you don’t need to create a namespace for them.

    • For Vault server:
    kubectl create namespace vault
    
    • For Percona Distribution for PostgreSQL cluster:
    kubectl create namespace pg
    
  2. Export the namespaces and other variables as environment variables to simplify further configuration:

    export NAMESPACE="vault"
    export CLUSTER_NAMESPACE="pg"
    export VAULT_HELM_VERSION="0.30.0"
    export SERVICE="vault"
    export CSR_NAME="vault-csr"
    export SECRET_NAME_VAULT="vault-secret"
    export POLICY_NAME="tde-policy"
    export WORKDIR="/tmp/vault"
    
  3. Create a working directory for configuration files:

    mkdir -p $WORKDIR
    

Generate TLS certificates

To use TLS, you’ll need the following certificates:

  • A private key for the Vault server
  • A certificate for the Vault server signed by the Kubernetes CA
  • The Kubernetes CA certificate

These files store sensitive information. Make sure to keep them in a secure location.

Generate the private key

Generate a private key for the Vault server:

openssl genrsa -out ${WORKDIR}/vault.key 2048

Create the Certificate Signing Request (CSR)

A Certificate Signing Request (CSR) is a file that contains information about your server and the certificate you need. You create it using your private key, and then submit it to Kubernetes to get a certificate signed by the Kubernetes Certificate Authority (CA). The signed certificate proves your server’s identity and enables secure TLS connections.

  1. Create the Certificate Signing Request configuration file:

    Specify the certificate details that Kubernetes needs to sign your certificate:

    • Request settings ([req]): References the sections for certificate extensions and distinguished name. The distinguished name section is left empty as Kubernetes will populate it automatically.
    • Certificate extensions ([v3_req]): Defines how the certificate can be used. serverAuth allows the certificate for server authentication, while keyUsage specifies the cryptographic operations the certificate supports (non-repudiation, digital signature, and key encipherment).
    • Subject Alternative Names ([alt_names]): Lists all DNS names and IP addresses where your Vault service can be accessed. This includes the service name, fully qualified domain names (FQDNs) for different Kubernetes DNS contexts (namespace-scoped, cluster-scoped with .svc, and fully qualified with .svc.cluster.local), and the localhost IP address.
    cat > "${WORKDIR}/csr.conf" <<'EOF'
    [req]
    default_bits = 2048
    prompt = no
    encrypt_key = yes
    default_md = sha256
    distinguished_name = kubelet_serving
    req_extensions = v3_req
    [ kubelet_serving ]
    O = system:nodes
    CN = system:node:*.vault.svc.cluster.local
    [ v3_req ]
    basicConstraints = CA:FALSE
    keyUsage = nonRepudiation, digitalSignature, keyEncipherment, dataEncipherment
    extendedKeyUsage = serverAuth, clientAuth
    subjectAltName = @alt_names
    [alt_names]
    DNS.1 =*.vault-internal
    DNS.2 = *.vault-standby
    DNS.3 =*.vault-internal.vault.svc.cluster.local
    DNS.4 = *.vault-standby.vault.svc.cluster.local
    DNS.5 =*.vault
    DNS.6 = vault.vault.svc.cluster.local
    IP.1 = 127.0.0.1
    EOF
    
  2. Generate the CSR. The following command creates the Certificate Signing Request file using your private key and the configuration file.

    The -subj parameter specifies the distinguished name directly: the Common Name (CN) identifies your Vault service using the Kubernetes node naming convention (system:node:${SERVICE}.${NAMESPACE}.svc), and the Organization (O) field is set to system:nodes, which Kubernetes requires to recognize and sign the certificate. The command combines these subject fields with the certificate extensions defined in the configuration file to produce the complete CSR.

    openssl req -new -key $WORKDIR/vault.key \
      -subj "/CN=system:node:${SERVICE}.${NAMESPACE}.svc;/O=system:nodes" \
      -out $WORKDIR/server.csr -config $WORKDIR/csr.conf
    

Issue the certificate

To get your certificate signed by Kubernetes, you need to submit the CSR through the Kubernetes API. The CSR file you generated with OpenSSL must be wrapped in a Kubernetes CertificateSigningRequest resource.

  1. Create the CSR YAML file to send it to Kubernetes:

    This YAML file creates a Kubernetes CertificateSigningRequest object that contains your CSR. The file embeds the base64-encoded CSR content and specifies:

    • The signer name (kubernetes.io/kubelet-serving) that tells Kubernetes which CA should sign the certificate
    • The groups field (system:authenticated) that identifies who can approve this CSR
    • The certificate usages that define how the certificate can be used (digital signature, key encipherment, and server authentication)
    cat > $WORKDIR/csr.yaml <<EOF
    apiVersion: certificates.k8s.io/v1
    kind: CertificateSigningRequest
    metadata:
      name: ${CSR_NAME}
    spec:
      groups:
      - system:authenticated
      request: $(cat $WORKDIR/server.csr | base64 | tr -d '\n')
      signerName: kubernetes.io/kubelet-serving
      usages:
      - digital signature
      - key encipherment
      - server auth
    EOF
    
  2. Create the CertificateSigningRequest (CSR) object:

    kubectl create -f ${WORKDIR}/csr.yaml
    
  3. Approve the CSR in Kubernetes:

    kubectl certificate approve ${CSR_NAME}
    
  4. Confirm the certificate was issued:

    kubectl get csr ${CSR_NAME}
    
    Sample output
    NAME        AGE   SIGNERNAME                      REQUESTOR       REQUESTEDDURATION   CONDITION
    vault-csr   16s   kubernetes.io/kubelet-serving   minikube-user   <none>              Approved,Issued
    

Retrieve the certificates

After Kubernetes approves and signs your CSR, you need to retrieve the signed certificate and the Kubernetes CA certificate. These certificates are required to configure TLS for your Vault server.

  1. Retrieve the signed certificate from the CertificateSigningRequest object. The certificate is base64-encoded in Kubernetes, so you decode it and save it to a file.

    kubectl get csr ${CSR_NAME} -o jsonpath='{.status.certificate}' | base64 -d > $WORKDIR/vault.crt
    
  2. Retrieve Kubernetes CA certificate:

    This command retrieves the Kubernetes cluster’s Certificate Authority (CA) certificate from your kubeconfig file. The CA certificate is needed to verify that the signed certificate is valid and was issued by the Kubernetes CA. The command uses kubectl config view with flags to get the raw, flattened configuration and extract the CA certificate data, which is also base64-encoded.

    kubectl config view \
      --raw \
      --minify \
      --flatten \
      -o jsonpath='{.clusters[].cluster.certificate-authority-data}' \
      | base64 -d > ${WORKDIR}/vault.ca
    

Store certificates in Kubernetes secrets

Create a TLS secret in Kubernetes to store the certificates and key:

kubectl create secret generic ${SECRET_NAME_VAULT} \
  --namespace ${NAMESPACE} \
  --from-file=vault.key=$WORKDIR/vault.key \
  --from-file=vault.crt=$WORKDIR/vault.crt \
  --from-file=vault.ca=$WORKDIR/vault.ca

Install Vault with TLS

For this setup, we install Vault in Kubernetes using the Helm 3 package manager in High Availability (HA) mode with Raft storage backend and with TLS enabled.

  1. Add and update the Vault Helm repository:

    helm repo add hashicorp https://helm.releases.hashicorp.com
    helm repo update
    
  2. Install Vault with TLS enabled:

    helm upgrade --install ${SERVICE} hashicorp/vault \
      --disable-openapi-validation \
      --version ${VAULT_HELM_VERSION} \
      --namespace ${NAMESPACE} \
      --set "global.enabled=true" \
      --set "global.tlsDisable=false" \
      --set "global.platform=kubernetes" \
      --set server.extraEnvironmentVars.VAULT_CACERT=/vault/userconfig/${SECRET_NAME_VAULT}/vault.ca \
      --set "server.extraEnvironmentVars.VAULT_TLSCERT=/vault/userconfig/${SECRET_NAME_VAULT}/vault.crt" \
      --set "server.extraEnvironmentVars.VAULT_TLSKEY=/vault/userconfig/${SECRET_NAME_VAULT}/vault.key" \
      --set "server.volumes[0].name=userconfig-${SECRET_NAME_VAULT}" \
      --set "server.volumes[0].secret.secretName=${SECRET_NAME_VAULT}" \
      --set "server.volumes[0].secret.defaultMode=420" \
      --set "server.volumeMounts[0].mountPath=/vault/userconfig/${SECRET_NAME_VAULT}" \
      --set "server.volumeMounts[0].name=userconfig-${SECRET_NAME_VAULT}" \
      --set "server.volumeMounts[0].readOnly=true" \
      --set "server.ha.enabled=true" \
      --set "server.ha.replicas=3" \
      --set "server.ha.raft.enabled=true" \
      --set "server.ha.raft.setNodeId=true" \
      --set-string "server.ha.raft.config=cluster_name = \"vault-integrated-storage\"
    ui = true
    listener \"tcp\" {
      tls_disable = 0
      address = \"[::]:8200\"
      cluster_address = \"[::]:8201\"
      tls_cert_file = \"/vault/userconfig/${SECRET_NAME_VAULT}/vault.crt\"
      tls_key_file  = \"/vault/userconfig/${SECRET_NAME_VAULT}/vault.key\"
      tls_client_ca_file = \"/vault/userconfig/${SECRET_NAME_VAULT}/vault.ca\"
    }
    storage \"raft\" {
      path = \"/vault/data\"
    }
    disable_mlock = true
    service_registration \"kubernetes\" {}"
    

    This command does the following:

    • Installs HashiCorp Vault in High Availability (HA) mode with secure TLS enabled in your Kubernetes cluster.
    • Configures Vault pods to use certificates from a Kubernetes Secret via volume mounts for secure HTTPS communication between Vault and clients.
    • Sets up Raft as the backend storage with three replicas for fault tolerance, and configures the Vault TCP listener to enforce TLS with your specified certificate files.
    Sample output
    NAME: vault
    LAST DEPLOYED: Wed Aug 20 12:55:38 2025
    NAMESPACE: vault
    STATUS: deployed
    REVISION: 1
    NOTES:
    Thank you for installing HashiCorp Vault!
    
    Now that you have deployed Vault, you should look over the docs on using
    Vault with Kubernetes available here:
    
    https://developer.hashicorp.com/vault/docs
    
  3. Retrieve the Pod name where Vault is running:

    kubectl -n $NAMESPACE get pod -l app.kubernetes.io/name=${SERVICE} -o jsonpath='{range .items[*]}{.metadata.name}{"\n"}{end}'
    
    Sample output
    vault-0
    vault-1
    vault-2
    

Initialize and unseal Vault

  1. After Vault is installed, you need to initialize it. Run the following command to initialize the first pod:

    kubectl exec -it pod/vault-0 -n $NAMESPACE -- vault operator init -key-shares=1 -key-threshold=1 -format=json > ${WORKDIR}/vault-init
    

    The command does the following:

    • Connects to the Vault Pod
    • Initializes Vault server with TLS enabled
    • Creates 1 unseal key share which is required to unseal the server
    • Outputs the init response to a local file. The file includes unseal keys and root token.
  2. Vault is started in a sealed state. In this state Vault can access the storage but it cannot decrypt data. In order to use Vault, you need to unseal it.

    Retrieve the unseal key from the file:

    unsealKey=$(jq -r ".unseal_keys_b64[]" < ${WORKDIR}/vault-init)
    

    Now, unseal Vault. Run the following command:

    kubectl exec -it pod/vault-0 -n $NAMESPACE -- vault operator unseal "$unsealKey"
    
    Sample output
    Key                     Value
    ---                     -----
    Seal Type               shamir
    Initialized             true
    Sealed                  false
    Total Shares            1
    Threshold               1
    Version                 1.19.0
    Build Date              2025-03-04T12:36:40Z
    Storage Type            raft
    Cluster Name            vault-integrated-storage
    Cluster ID              ed275c91-e227-681b-5aaa-f7a9fc19e37e
    Removed From Cluster    false
    HA Enabled              true
    HA Cluster              <https://vault-0.vault-internal:8201>
    HA Mode                 active
    Active Since            2025-12-15T13:36:42.542059059Z
    Raft Committed Index    37
    Raft Applied Index      37
    
  3. Add the remaining Pods to the Vault cluster. If you have another secret name, replace the vault-secret with your value in the following for loop:

    for POD in vault-1 vault-2; do
      kubectl -n "$NAMESPACE" exec $POD -- sh -c '
        vault operator raft join -address=https://${HOSTNAME}.vault-internal:8200 \
          -leader-ca-cert="$(cat /vault/userconfig/vault-secret/vault.ca)" \
          -leader-client-cert="$(cat /vault/userconfig/vault-secret/vault.crt)" \
          -leader-client-key="$(cat /vault/userconfig/vault-secret/vault.key)" \
          https://vault-0.vault-internal:8200;
      '
    done
    

    The command connects to each Vault Pod (vault-1 and vault-2) and issues the vault operator raft join command, which: * Joins the Pods to the Vault Raft cluster, enabling HA mode. * Uses the necessary TLS certificates to securely connect to the cluster leader (vault-0). * Ensures all nodes participate in the Raft consensus and share storage responsibilities.

    Sample output
    Key       Value
    ---       -----
    Joined    true
    
  4. Unseal the remaining Pods. Use this for loop:

    for POD in vault-1 vault-2; do
        kubectl -n "$NAMESPACE" exec $POD -- sh -c "
            vault operator unseal \"$unsealKey\"
        "
    done
    
    Expected output
    Key                     Value
    ---                     -----
    Seal Type               shamir
    Initialized             true
    Sealed                  false
    Total Shares            1
    Threshold               1
    Unseal Progress         1/1
    Unseal Nonce            n/a
    Version                 1.19.0
    Build Date              2025-03-04T12:36:40Z
    Storage Type            raft
    Removed From Cluster    false
    HA Enabled              true
    

Configure Vault

At this step you need to configure Vault and enable secrets engine within it. To do so you must first authenticate in Vault.

When you started Vault, it generates and starts with a root token that provides full access to Vault. Use this token to authenticate.

Run the following command on a leader node. The remaining ones will synchronize from the leader.

  1. Extract the Vault root token from the file where you saved the init response output:

    cat ${WORKDIR}/vault-init | jq -r ".root_token"
    
    Sample output
    hvs.*************Jg9r
    
  2. Connect to Vault Pod:

    kubectl exec -it vault-0 -n $NAMESPACE -- /bin/sh
    
  3. Authenticate in Vault with this token:

    vault login hvs.*************Jg9r
    
  4. Enable the secrets engine at the mount path. The following command enables KV secrets engine v2 at the tde mount-path:

    vault secrets enable --version=2 -path=tde kv
    
    Sample output
    Success! Enabled the kv secrets engine at: tde/
    
  5. (Optional) You can also enable audit. This is not mandatory, but useful:

    vault audit enable file file_path=/vault/vault-audit.log
    
    Expected output
    Success! Enabled the file audit device at: file/
    

Create a non-root token

Using the root token for authentication is not recommended, as it poses significant security risks. Instead, you should create a dedicated, non-root token for the Operator to use when accessing Vault. The permissions for this token are controlled by an access policy. Before you create a token you must first create the access policy.

  1. Create a policy for accessing the kv engine path and define the required permissions in the capabilities parameter:

    kubectl -n "$NAMESPACE" exec vault-0 -- sh -c '
    vault policy write '"$POLICY_NAME"' - << "EOF"
    path "tde/data/*" {
      capabilities = ["read", "create", "update", "list"]
    }
    path "tde/metadata/*" {
      capabilities = ["read", "list"]
    }
    path "sys/internal/ui/mounts/*" {
      capabilities = ["read"]
    }
    path "sys/mounts/*" {
      capabilities = ["read"]
    }
    EOF
    '
    
  2. Now create a token with a policy.

    kubectl -n "${NAMESPACE}" exec pod/vault-0 -- vault token create -policy="${POLICY_NAME}" -format=json > "${WORKDIR}/vault-token.json"
    
    4. Export the non-root token as an environment variable:

    export NEW_TOKEN=$(jq -r '.auth.client_token' "${WORKDIR}/vault-token.json")
    
  3. Verify the token:

    echo "New Vault Token: $NEW_TOKEN"
    
    Sample output
    hvs.CAESINO******************************************T2Y
    

Create a Secret for Vault

To enable Vault for the Operator, create a Secret object for it using the Vault token and the path to TLS certificates. Note that you must create the Secret in the namespace where the Operator and the database cluster is running.

For the following command specify the token and the path to the ca.cert file (this is vault.ca in our example):

kubectl create secret generic cluster1-vault --from-literal=token=$NEW_TOKEN --from-file=ca.crt=${WORKDIR}/vault.ca -n $CLUSTER_NAMESPACE

Check that the Secret is created:

kubectl get secret -n $CLUSTER_NAMESPACE

Configure pg_tde in the Custom Resource manifest

Now, enable the pg_tde extension for your cluster and configure Vault as the key provider. For this you need the following information:

  • A Vault server name and port. If Vault is deployed in a separate namespace, use the fully qualified name in the format <service-name>.<namespace>.svc.cluster.local.
  • The Secret name with the Vault token
  • The Secret name with the CA certificate. In our example, the Vault token and the CA certificate are in the same Secret that you created earlier
  • The secrets mount path

Note

Applying the changes for a running cluster will trigger rolling restart of the database Pods.

  1. Edit the deploy/cr.yaml file and specify the following:

    • extensions.pg_tde - set to true
    • Add Vault-specific options to the extensions.pg_tde.vault section.

    The example configuration looks like this:

    spec:
      ....
      extensions:
        pg_tde: 
          enabled: true
          vault:
            host: https://vault.vault.svc.cluster.local:8200
            mountPath: tde
            tokenSecret:
              name: cluster1-vault
              key: token
            caSecret:
              name: cluster1-vault
              key: ca.crt
    
  2. Apply the configuration:

    kubectl apply -f deploy/cr.yaml -n $CLUSTER_NAMESPACE
    
  3. Check the pg_tde status:

    bash kubectl get pg cluster1 -n $CLUSTER_NAMESPACE

    Expected output

    {.yaml .no-copy} status: conditions: ..... - lastTransitionTime: "2026-03-04T13:29:51Z" message: pg_tde is enabled in PerconaPGCluster observedGeneration: 1 reason: Enabled status: "True" type: PGTDEEnabled

Verify the encryption

Check that the encryption is enabled. To do that, create a table in PostgreSQL using the tde_heap access method. To learn more, refer to the Table Access Methods and pg_tde documentation.

  1. Find the primary Pod in your cluster and export it as an environment variable:

    export PRIMARY_POD=$(kubectl get pods -n "$CLUSTER_NAMESPACE" \
     -l postgres-operator.crunchydata.com/role=primary \
     -o jsonpath='{.items[0].metadata.name}')
    
  2. Verify the Pod:

    echo $PRIMARY_POD
    
    Sample output
    cluster1-instance1-btdf-0
    
  3. Execute into the primary PostgreSQL Pod as the postgres user and establish the psql session.

    kubectl -n $CLUSTER_NAMESPACE exec -it $PRIMARY_POD -- psql
    
    Sample output
    psql (17.7 - Percona Server for PostgreSQL 17.7.1)
    Type "help" for help.
    
    postgres=#
    
  4. Inside the Pod, create a table:

    CREATE TABLE secure_data (
    id INTEGER GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
    name TEXT,
    amount NUMERIC(10,2),
    created_at DATE
    ) USING tde_heap;
    
  5. Insert some sample data:

    INSERT INTO secure_data (name, amount, created_at) VALUES
    ('Alice', 1234.56, '2025-08-01'),
    ('Bob', 7890.12, '2025-08-10'),
    ('Charlie', 345.67, '2025-08-19');
    
  6. Verify if the table is encrypted:

    SELECT pg_tde_is_encrypted(
     'secure_data'
    );
    
    Expected output
     pg_tde_is_encrypted
    ---------------------
     t
    (1 row)
    

Troubleshooting

If you encounter issues during the setup, use the following troubleshooting tips:

  1. Certificate Signing Request (CSR) issues: If you have problems with the CSR, manually delete it and recreate it:

    kubectl delete csr vault-csr || true
    

    Then recreate and re-approve it in Kubernetes following the steps in the Issue the certificate section.

  2. Vault policy issues: Check the mount points and permissions. Ensure that:

    • The mount path in your policy matches the path where you enabled the secrets engine
    • The policy has the required capabilities (create, read, update, list) for the paths your application needs
    • You have included the sys/internal/ui/mounts/ and sys/mounts/* paths
  3. Mount point conflicts: If you encounter issues with a mount point in Vault, you cannot reuse it. You need to:

    • Provide a new mount path when enabling the secrets engine
    • Update your access policy to include the new mount path
    • Update the mountPath value in your Custom Resource configuration to match the new mount path
  4. Verify that you reference the correct secret name in your Custom Resource.

Clean up

After you finish the setup and ensure everything works as expected, you can clean up the temporary files:

rm -rf $WORKDIR

Disabling pg_tde (Transparent Data Encryption) is generally not recommended, as it removes an important layer of security that protects your data at rest. However, if you must disable encryption, you can follow the steps in the Disable encryption tutorial.


Last update: March 16, 2026
Created: March 16, 2026