Backing Up and Restoring Tanzu Kubernetes Grid Integrated Edition

Note: As of v1.8, Enterprise PKS has been renamed to VMware Tanzu Kubernetes Grid Integrated Edition. Some screenshots in this documentation do not yet reflect the change.

Page last updated:

This section describes how to back up and restore the VMware Tanzu Kubernetes Grid Integrated Edition control plane and Tanzu Kubernetes Grid Integrated Edition clusters. Tanzu Kubernetes Grid Integrated Edition uses the BOSH Backup and Restore (BBR) framework to back up and restore the TKGI control plane and clusters. For more information, see BOSH Backup and Restore.

BBR orchestrates triggering the backup or restore process on the BOSH deployment, and transfers the backup artifacts to and from the BOSH deployment.

BBR can back up the following components:

  • BOSH Director
  • Tanzu Kubernetes Grid Integrated Edition control plane API VM and its ETCD database
  • Tanzu Kubernetes Grid Integrated Edition control plane database VM (MySQL)
  • Tanzu Kubernetes Grid Integrated Edition cluster data, from the clusters’ ETCD databases

BBR cannot back up the following components:

  • Harbor tile
  • Persistent volumes attached to nodes
  • Network resources. For example, load balancers to the cluster.

For more information about installing and using BBR, see the following topics:

For information about troubleshooting BBR, see BBR Logging.

If you are using vSphere to run Tanzu Kubernetes Grid Integrated Edition, also see:


Please send any feedback you have to pks-feedback@pivotal.io.