New to KubeVault? Please start here.
Deploy VaultServer with Microsoft SQL Server 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 Microsoft SQL Server 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 Microsoft SQL Server Backend
Create beforehand: Nothing. Vault creates the database and the table on its own.
Deploy SQL Server
This tutorial uses KubeDB to run SQL Server. The KubeDB operator must be installed in your cluster.
Let’s deploy a sample MSSQLServer database. Setting ACCEPT_EULA to Y means that you accept the end-user license agreement of Microsoft SQL Server.
apiVersion: kubedb.com/v1alpha2
kind: MSSQLServer
metadata:
name: mssql
namespace: demo
spec:
version: "2022-cu12"
replicas: 1
storageType: Durable
podTemplate:
spec:
containers:
- name: mssql
env:
- name: ACCEPT_EULA
value: "Y"
- name: MSSQL_PID
value: Evaluation
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 2Gi
deletionPolicy: WipeOut
$ kubectl apply -f mssql.yaml
mssqlserver.kubedb.com/mssql created
$ kubectl wait -n demo --for=condition=Ready mssqlserver/mssql --timeout=5m
mssqlserver.kubedb.com/mssql condition met
KubeDB creates an AppBinding named mssql for the database, which holds its address and the mssql-auth secret with the username and password. Vault creates the database (openbao) and the table on its own, if they do not exist.
Deploy Vault using KubeVault
We’re going to use Kubernetes secret to store the unseal-keys & root-token. A sample VaultServer with MSSQL 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: 1
allowedSecretEngines:
namespaces:
from: All
backend:
mssql:
databaseRef:
name: mssql
namespace: demo
database: "openbao"
table: "openbao"
schema: "dbo"
appName: "openbao"
connectionTimeout: "30"
unsealer:
secretShares: 5
secretThreshold: 3
mode:
kubernetesSecret:
secretName: vault-keys
terminationPolicy: WipeOut
The databaseRef points to the AppBinding that KubeDB created for the database. The operator takes the SQL Server address and the credentials from it, so we don’t need to set them here. The MSSQL storage backend does not support high availability, so the VaultServer runs with a single replica. For TLS to SQL Server, see the encrypt and tlsSecretRef fields in the MSSQL storage backend concept.
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: mssql
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.6344c70b-61d7-4e02-a736-f850498d6b20.demo.vault
restoreTask:
name: vault-restore-1.10.3
params:
- name: keyPrefix
value: k8s.6344c70b-61d7-4e02-a736-f850498d6b20.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 3m11s
$ kubectl get vaultserver -n demo
NAME REPLICAS VERSION STATUS AGE
vault 1 sigilr-2.6.1.2 Ready 3m45s
At this stage, we’ve successfully deployed Vault using KubeVault operator with MSSQL 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-sigilr.2
Storage Type mssql
Cluster Name vault-cluster-7211c161
Cluster ID a5b837de-622c-38e1-06ce-3be099659e38
HA Enabled false
We can see the currently enabled list of secret engines.
$ vault secrets list
Path Type Accessor Description
---- ---- -------- -----------
cubbyhole/ cubbyhole cubbyhole_fc4182ef per-token private secret storage
identity/ identity identity_871b9a95 identity store
k8s.6344c70b-61d7-4e02-a736-f850498d6b20.kv.demo.vault-health/ kv kv_8ae49eac n/a
sys/ system system_49fba3f8 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 mssqlserver -n demo mssql
$ kubectl delete ns demo
Delete the VaultServer before the MSSQLServer database. With terminationPolicy: WipeOut, the operator connects to SQL Server to remove the data Vault stored there, so the database has to be reachable until the VaultServer is gone.
To see all the fields you can set under spec.backend.mssql, please check the MSSQL storage backend concept.
For more details on how to interact with the vault server, please check the Vault Server guide.








