Adding KMS support v1.4.1 (LTS)

Transparent Data Encryption (TDE) is a data-at-rest encryption standard required by most enterprise security policies and compliance frameworks. HM supports two approaches to protecting TDE keys: passphrase-based and KMS-backed.

Passphrase mode uses a passphrase you supply to encrypt each cluster's TDE key. It's quick to set up and suitable for development and testing, but isn't appropriate for production:

• The key custodian and the data custodian are the same principal, which doesn't satisfy PCI, HIPAA, or FedRAMP audit requirements.
• A lost passphrase makes data unrecoverable, and a leaked passphrase voids the encryption entirely.
• In disaster recovery scenarios, the passphrase is most likely to be unavailable, making it impossible to decrypt and restore your data.

KMS-backed providers (HashiCorp Vault, AWS KMS, Azure Key Vault, Google Cloud KMS) store the key outside the cluster, separately from the data. This separation satisfies audit requirements, enables automatic key rotation, and keeps the key accessible for disaster recovery. KMS is the only appropriate method for automated and production deployments.

The transparentDataEncryptionMethods field in the HybridControlPlane CR controls which key providers are available for your clusters. You can list multiple providers — each individual cluster then uses one of the enabled methods. The HM default configuration enables passphrase and hashicorp_vault:

  # - transparentDataEncryptionMethods: List of TDE Encryption Methods for the agent.
  #     Supported options: passphrase, aws_kms, azure_kms, gcp_kms, hashicorp_vault.
  #     Default values: passphrase, hashicorp_vault.
  transparentDataEncryptionMethods:
    - passphrase
    - hashicorp_vault

The supported options are:

• passphrase — built-in passphrase encryption. Development and testing only.
• hashicorp_vault — HashiCorp Vault. See HashiCorp Vault.
• aws_kms — Amazon Key Management Service. See AWS KMS.
• azure_kms — Azure Key Vault. See Azure KMS.
• gcp_kms — Google Cloud Key Management Service. See Google KMS.

You can edit this field during installation, or add a provider post-install by editing your HybridControlPlane manifest and reapplying it. See Updating configuration.

HashiCorp Vault

The Hybrid Manager configuration includes support for HashiCorp out of the box.

AWS KMS

To use Amazon's KMS, Amazon Key Management Service, add aws_kms to the list:

  # - transparentDataEncryptionMethods: List of TDE Encryption Methods for the agent.
  #     Supported options: passphrase, aws_kms, azure_kms, gcp_kms, hashicorp_vault.
  #     Default values: passphrase, hashicorp_vault.
  transparentDataEncryptionMethods:
    - passphrase
    - hashicorp_vault
    - aws_kms

Azure KMS

To use Azure's KMS, Azure Key Vault, add azure_kms to the list:

  # - transparentDataEncryptionMethods: List of TDE Encryption Methods for the agent.
  #     Supported options: passphrase, aws_kms, azure_kms, gcp_kms, hashicorp_vault.
  #     Default values: passphrase, hashicorp_vault.
  transparentDataEncryptionMethods:
    - passphrase
    - hashicorp_vault
    - azure_kms

Google KMS

If you want to use Google's KMS, Cloud Key Management Service, add gcp_kms to the list:

  # - transparentDataEncryptionMethods: List of TDE Encryption Methods for the agent.
  #     Supported options: passphrase, aws_kms, azure_kms, gcp_kms, hashicorp_vault.
  #     Default values: passphrase, hashicorp_vault.
  transparentDataEncryptionMethods:
    - passphrase
    - hashicorp_vault
    - gcp_kms

Next steps

• Configure HashiCorp Vault as the KMS for TDE
• Configure AWS Key Management Service as the KMS for TDE
• Configure Azure Key Vault as the KMS for TDE
• Configure Google Cloud Key Management Service as the KMS for TDE