This topic provides an overview of how to back up and restore Kubernetes workloads deployed to TKGI clusters using Velero and Restic.
About Tanzu Kubernetes Workload Backup and Restore
Tanzu Kubernetes workload backup and restore is done using Velero and Restic software.
Velero is an open-source product that provides full backup and recovery of Kubernetes workloads. Restic is used as a companion tool with Velero to provide platform independent volume snapshots. For more information about Restic, see Restic Integration in the Velero documentation.
Together, Velero and Restic support backup and recovery for all types of Kubernetes workloads deployed to Tanzu clusters.
Application Types
An application deployed to Kubernetes can be stateless or stateful. Velero with Restic can back up and restore both types, but the procedure may differ slightly. The examples in Scenarios for Backing Up and Restoring TKGI Workloads demonstrate the differences and process for each type.
In addition, an application may have a service attached or ingress enabled. See Services and Ingress for a summary of the available techniques for ensuring full restoration of functionality.
Services and Ingress
If a service is attached, the IP address may need to be static for backup and restore to work as expected.
Velero backup and restore is agnostic of NSX-T objects. To restore applications with same IP address, there are two mechanism available with TKGI:
- Create a Kubernetes load balancer service with a static IP address by specifying the
loadBalancerIPin the YAML file. - Deploy a Kubernetes cluster with a static IP address for pod ingress by defining network profile.
Storage Types
Tanzu Kubernetes clusters support two persistence providers: VMware Cloud Provider (vCP) and the Container Storage Interface (CSI).
vCP is VMware’s Kubernetes storage plugin that allows cluster nodes on vSphere to interact with vCenter to support Kubernetes Persistent Volume objects. CSI is open-source software that enables Kubernetes implementations to provide a standard interface for storage systems, without having to create drivers for each system.
The provider is defined in the storage class. Velero with Restic backup and restore is slightly different depending on the type of persistence provider.
The VMware Cloud Provider (vCP) StorageClass provisioner only works with TKGI:
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: demo-sts-sc
provisioner: kubernetes.io/vsphere-volume
parameters:
diskformat: thin
The Container Storage Interface (CSI) StorageClass provisioner works with TKGI, TKGM, and TKGS.
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: guestbook-sc-csi
annotations:
storageclass.kubernetes.io/is-default-class: "true"
provisioner: csi.vsphere.vmware.com
parameters:
datastoreurl: "ds:///vmfs/volumes/vsan:52d8eb4842dbf493-41523be9cd4ff7b7/"
Tanzu Kubernetes Workload Backup and Restore Requirements
This section lists the requirements for using Velero and Restic for Kubernetes workload backup and recovery.
Cluster Configuration
To back up and recover TKGI Kubernetes workloads using Velero and Restic, TKGI installs a Velero and a Restic Pod on each target Kubernetes cluster.
To configure your target clusters for Velero and Restic backup and recovery, complete the steps in Modify the Host Path in Installing Velero and Restic.
Object Store
You need to provide an object store for Velero backups. Velero supports a number of object store providers. For more information, see Providers in the Velero documentation. Minio is an S3-compatible object store that is easy to install and use. This documentation uses the Minio server installed on a Linux VM as the backup destination for the example scenarios.
Velero CLI
To perform Velero backup and recovery, you install the Velero CLI on a client VM. This can be the TKGI client VM or an administrator laptop.
Velero Version
Refer to the Release Notes for the supported Velero version.
Air-Gapped Environment
When you run the Velero CLI to install Velero on the Kubernetes cluster, Velero and Restic pods are deployed to the cluster. To install the prods, the instructions assume that the cluster environment has internet access, including the client where the Velero CLI is installed as well as the Kubernetes cluster. In case the environment has no internet access, you use can use a private container registry to install Velero pods onto the target cluster. See Air-gapped deployments.
Get Started Using Velero and Restic
To get started with Velero and Restic:
- Review the scenarios in Scenarios for Backing Up and Restoring TKGI Workloads.
- Complete the steps in Installing Velero and Restic.
