Skip to main content
Version: 0.1.0

Use this page before you

  • tear down a dev, staging, or production cluster intentionally
  • change the deletion policy from the default retain behavior
  • remove PVC-backed data as part of a deliberate teardown
  • confirm whether snapshot backups still need manual cleanup afterward

Decision matrix

Choose the deletion policy

Choose the deletion policy.
PolicyUse it whenWhat gets deletedWatch for
DeletePVCsYou are tearing down an ephemeral or disposable environment and want the operator to remove PVC-backed data too.Compute resources, secrets, and PVCs are deleted.This is permanent data loss for the local cluster storage path.
DeleteAllYou want the most aggressive in-cluster cleanup the current implementation supports.Compute resources and PVCs are deleted, but external object-storage backups are still left behind.The API accepts the value, but external backup deletion is not implemented yet.

Understand what is retained

The default Retain behavior preserves the things you need if the deletion turns out not to be final:

  • PVC-backed data
  • the unseal key Secret
  • the root token Secret
  • any external backups already stored in object storage
Why the unseal key is retained

The unseal key material is what makes the retained PVC data usable later. If the operator let Kubernetes garbage-collect that Secret automatically, you could keep the encrypted data and still lose the practical ability to recover it.

Configure the teardown policy

Configure

Keep data and critical secrets after cluster deletion

yaml

spec:
deletionPolicy: Retain

Delete the cluster

Apply

Delete the OpenBaoCluster

bash

kubectl delete openbaocluster <name> -n <namespace>

If the cluster still serves production traffic, stop here and confirm your cutover, backup, and recovery assumptions before you continue.

Verify the cleanup result

Verify

Check for retained or remaining resources

bash

kubectl get pvc -n <namespace> -l openbao.org/cluster=<name>
kubectl get secret -n <namespace> -l openbao.org/cluster=<name>
kubectl get jobs -n <namespace> -l openbao.org/cluster=<name>

Under Retain, leftover PVCs and critical secrets are expected. Under DeletePVCs or DeleteAll, the PVC-backed path should be gone, but external backups still need their own manual cleanup decision.

Continue the teardown or recovery path

Published release documentation

You are reading docs for version 0.1.0. Use the version menu to switch to next or another archived release.

Was this page helpful?

Use Needs work to open a structured GitHub issue for this page. The Yes button only acknowledges the signal locally.