New to KubeVault? Please start here.
Deploy VaultServer with Google Cloud Spanner Backend
You can easily deploy and manage OpenBao in the Kubernetes cluster using KubeVault operator. In this tutorial, we are going to deploy Vault on the Kubernetes cluster using KubeVault operator, with Google Cloud Spanner as the storage backend.
To keep everything isolated, we are going to use a separate namespace called demo throughout this tutorial.
$ kubectl create ns demo
namespace/demo created
Deploy VaultServer with Google Cloud Spanner Backend
Create beforehand: The Spanner database, the
Vaulttable and, withhaEnabled, theVaultHAtable. Vault does not create them.
Prepare the Spanner Database
Use an existing Spanner database and the key of a service account that can use it, for example with the roles/spanner.databaseUser role. This example uses the database vault.
Vault does not create the database or its tables. Create the Vault table, and the VaultHA table that is used for leader election when haEnabled is true, with this schema,
CREATE TABLE Vault (
Key STRING(MAX) NOT NULL,
Value BYTES(MAX),
) PRIMARY KEY (Key);
CREATE TABLE VaultHA (
Key STRING(MAX) NOT NULL,
Value STRING(MAX),
Identity STRING(MAX),
Timestamp TIMESTAMP,
) PRIMARY KEY (Key);
Let’s create a service account that can use the database, and a key for it,
$ gcloud iam service-accounts create kubevault-storage
$ gcloud spanner databases add-iam-policy-binding vault --instance=<instance-name> \
--member="serviceAccount:kubevault-storage@<project-id>.iam.gserviceaccount.com" \
--role="roles/spanner.databaseUser"
$ gcloud iam service-accounts keys create sa.json \
--iam-account=kubevault-storage@<project-id>.iam.gserviceaccount.com
Create Credential Secret:
The credential secret holds the service account key in the key sa.json.
$ kubectl create secret generic spanner-cred -n demo --from-file=sa.json=./sa.json
secret/spanner-cred created
Deploy Vault using KubeVault
We’re going to use Kubernetes secret to store the unseal-keys & root-token. A sample VaultServer with Google Cloud Spanner backend manifest file may look like this:
apiVersion: kubevault.com/v1alpha2
kind: VaultServer
metadata:
name: vault
namespace: demo
spec:
version: sigilr-2.6.1.2
replicas: 2
allowedSecretEngines:
namespaces:
from: All
backend:
spanner:
database: "projects/<project-id>/instances/<instance-name>/databases/vault"
table: "Vault"
haEnabled: true
haTable: "VaultHA"
credentialSecretRef:
name: spanner-cred
unsealer:
secretShares: 5
secretThreshold: 3
mode:
kubernetesSecret:
secretName: vault-keys
terminationPolicy: WipeOut
Replace <project-id> and <instance-name> with your own values. The database field takes the full name of the database. With haEnabled: true, the VaultServer can run with more than one replica: one pod is the active node and the others are standby.
Now, let’s deploy the VaultServer:
$ kubectl apply -f vaultserver.yaml
vaultserver.kubevault.com/vault created
KubeVault operator will create a AppBinding CRD on VaultServer deployment, which contains the necessary information
to take backup of the Vault instances. It’ll have the same name & be created on the same namespace as the Vault.
Read more about AppBinding here.
$ kubectl get appbinding -n demo vault -oyaml
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
metadata:
name: vault
namespace: demo
spec:
appRef:
apiGroup: kubevault.com
kind: VaultServer
name: vault
namespace: demo
clientConfig:
service:
name: vault
port: 8200
scheme: http
parameters:
apiVersion: config.kubevault.com/v1alpha1
backend: spanner
backupTokenSecretRef:
name: vault-backup-token
deploymentMode: Local
kind: VaultServerConfiguration
kubernetes:
serviceAccountName: vault
tokenReviewerServiceAccountName: vault-k8s-token-reviewer
usePodServiceAccountForCSIDriver: true
path: kubernetes
stash:
addon:
backupTask:
name: vault-backup-1.10.3
params:
- name: keyPrefix
value: k8s.62e86b47-6e7c-4849-89fb-88062a22f451.demo.vault
restoreTask:
name: vault-restore-1.10.3
params:
- name: keyPrefix
value: k8s.62e86b47-6e7c-4849-89fb-88062a22f451.demo.vault
unsealer:
mode:
kubernetesSecret:
secretName: vault-keys
secretShares: 5
secretThreshold: 3
vaultRole: vault-policy-controller
type: VaultServer
version: sigilr-2.6.1.2
Now, let’s wait until all the vault pods come up & VaultServer phase becomes Ready.
$ kubectl get pods -n demo -l app.kubernetes.io/instance=vault
NAME READY STATUS RESTARTS AGE
vault-0 2/2 Running 0 2m8s
vault-1 2/2 Running 0 91s
$ kubectl get vaultserver -n demo
NAME REPLICAS VERSION STATUS AGE
vault 2 sigilr-2.6.1.2 Ready 2m50s
At this stage, we’ve successfully deployed Vault using KubeVault operator with Google Cloud Spanner as the storage backend.
Let’s write some data in a KV secret engine. Let’s export the necessary environment variables & port-forward from vault service
or exec into the vault pod in order to interact with it.
$ export VAULT_TOKEN=$(kubectl vault root-token get vaultserver vault -n demo --value-only)
$ export VAULT_ADDR='http://127.0.0.1:8200'
$ kubectl port-forward -n demo svc/vault 8200
Now check whether Vault server can be accessed (run this in another terminal):
$ vault status
Key Value
--- -----
Seal Type shamir
Initialized true
Sealed false
Total Shares 5
Threshold 3
Version 2.6.1
Storage Type spanner
Cluster Name vault-cluster-3f8a1c92
Cluster ID 56c3a681-f799-2310-9813-d67877d25450
HA Enabled true
HA Cluster https://vault.demo.svc:8201
HA Mode active
Active Since 2026-10-12T11:41:37.13040169Z
We can see the currently enabled list of secret engines.
$ vault secrets list
Path Type Accessor Description
---- ---- -------- -----------
cubbyhole/ cubbyhole cubbyhole_bb7c56f9 per-token private secret storage
identity/ identity identity_fa8431fa identity store
k8s.kubevault.com.kv.demo.vault-health/ kv kv_5129d194 n/a
sys/ system system_c7e0879a system endpoints used for control, policy and debugging
Let’s enable a KV type secret engine:
$ vault secrets enable kv
Success! Enabled the kv secrets engine at: kv/
Write some dummy data in the secret engine path:
$ vault kv put kv/name name=appscode
Success! Data written to: kv/name
Verify data written in KV secret engine:
$ vault kv get kv/name
==== Data ====
Key Value
--- -----
name appscode
Cleanup
To clean up the Kubernetes resources created by this tutorial, run:
$ kubectl delete vaultserver -n demo vault
$ kubectl delete secret -n demo spanner-cred
$ kubectl delete ns demo
With terminationPolicy: WipeOut, the operator removes the rows Vault stored in the tables when the VaultServer is deleted. The Spanner database, the tables and the service account are not deleted.
To see all the fields you can set under spec.backend.spanner, please check the Google Cloud Spanner storage backend concept.
For more details on how to interact with the vault server, please check the Vault Server guide.








