New to KubeVault? Please start here.

Storage Backends

A VaultServer keeps the data that Vault encrypts and stores in the storage backend set under spec.backend. Exactly one backend can be configured. The guides in this section deploy a VaultServer with each of the supported backends, in the same way as the Raft and PostgreSQL guides: prepare the storage, create the credentials, deploy the VaultServer, then write a secret to see that it works.

To learn what each field of a backend does, read the storage concepts.

Supported Storage Backends

BackendHigh availabilityWhat you need
AerospikeNoAn Aerospike server with an existing namespace
Alibaba Cloud OSSNoAn OSS bucket and an access key pair
Amazon DynamoDBYes (haEnabled)AWS credentials (the table is created by Vault)
Amazon S3NoAn S3 bucket and an access key pair
Azure Blob StorageNoAn Azure storage account and its access key
CassandraNoCassandra with a keyspace and a table (KubeDB Cassandra)
CockroachDBYes (haEnabled)A CockroachDB cluster and a user
ConsulYesA Consul server
CouchDBNoA CouchDB server with a database
etcdYes (haEnabled)An etcd v3 cluster (KubeDB Etcd)
FilesystemNoA PersistentVolumeClaim (created from volumeClaimTemplate)
Google Cloud SpannerYes (haEnabled)A Spanner database with the Vault tables and a service account key
Google Cloud StorageYes (haEnabled)A GCS bucket and a service account key
In-MemoryNoNothing. Data is lost on restart
Microsoft SQL ServerNoA SQL Server (KubeDB MSSQLServer)
MySQLYes (haEnabled)A MySQL server (KubeDB MySQL)
OCI Object StorageYes (haEnabled)Two OCI buckets and an API signing key
OpenStack SwiftNoA Swift container and OpenStack credentials
PostgreSQLYes (haEnabled)A PostgreSQL server (KubeDB Postgres)
RaftYesA StorageClass for the integrated storage volumes
ZooKeeperYesA ZooKeeper ensemble (KubeDB ZooKeeper)

Things to Know

  • Namespace and names. Every guide uses the demo namespace and a VaultServer named vault. Follow the Cleanup section of a guide before you start another one in the same namespace.
  • High availability. Backends without high availability have no leader election, so run them with a single replica. Backends marked haEnabled run in HA mode only when that field is set. Raft, Consul and ZooKeeper are always HA-capable.
  • Credentials. Credentials are read from a Secret in the namespace of the VaultServer, referenced by credentialSecretRef. For the databases that KubeDB manages, databaseRef points to the AppBinding of the database instead, and the operator takes the address, the credentials and the TLS settings from it.
  • Cleanup order. With terminationPolicy: WipeOut, the operator connects to the storage backend to delete the data Vault stored there. Always delete the VaultServer before the storage backend it uses.