Velero

Overview

Backup and recovery

A backup and recovery tools provided for necessary building blocks will be described in this chapter.
For certain Building Blocks you will not necessarily need e.g Velero. The PXC operator for instance comes with its own backup tool.

If you also would like to back off your customized MKA Environment, as you highly customized all of your building blocks, you
can use Velero to backup e.g configmaps, secrets etc like any other objects in your Metakube Cluster.

Prerequisites on Velero

You need to provide a storage provider for this Building Block. Proceed with the following prerequisite description to use the velero Building Block out of the box.

Velero

Velero is a commonly used backup and restore tool to backup your Kubernetes resources. You can also use Velero to migrate date from on Metakube Cluster to another. Later is
a defacto way to easily replicate your existing cluster.

It can also be used for desaster recovery.

So in case you have no backup tool for your Building Block, you can use Velero to back
up your Building Block resource. In case you need a backup tool for your application, Velero can backup your application
data on a aws s3 bucket or Azure Blob Store. There are more providers to use together with your Velero building block.

The basic use case we recommend :

Backup your Persistent Volume. We will guide you with an example and how you could test this.

Adding the Building Block

If you have a running cluster use the mkactl command to create the initial default setup.

You have successfully provisioned a running Metkube Cluster and a repo and an access key for an s3 bucket.

mkactl block list-all

#choose Velero

mkactl add velero

The Velero building block is added to your repo. The pipeline will deploy up the Velero into your Cluster.

mkactl block list-all
existing building blocks:

 NAME                    LATEST      INSTALLED 
 velero                  0.2.0       0.2.0
 local-path-provisioner  1.18.0     
 redis-ha                1.22.0                
 kube-prometheus-stack   22.0.0                
 ingress-nginx           5.21.0                
 loki-promtail           3.23.2                
 openvpn                 3.17.0                
 external-dns            5.6.0                
 elasticsearch           2.26.0                
 cert-manager            4.25.2                
 memcached               1.22.0                
 tideways-daemon         1.18.1                
 pxc-operator            3.27.1        

Required configuration

You can stick to the configuration description on Velero Building Block.
Stick to the best practice section in this README.

Monitoring

The monitoring of this service can be enabled by the metrics.serviceMonitor.* settings mentioned in the section SysEleven Best Practices default values
of Velero Building Block README.md

Alerting can be setup by the prometheus rules extension.

Limitations

As the Velero Building Block is one of our curated Building Block you will not suffer from the following limitation.

  • keep an eye on the same version on k8s, Velero and Helm.
  • the bucket comes with the building block regional provisioning of the bucket is guaranteed.
  • no planing on different provider credential, you only have ours.

as we take care on the above-mentioned limitation you can focus on the backup strategy itself.

Scaling Setup

Scaling makes not that much sense for this Building Block and will not cover or reduce aspects on consistency.

Release-Notes

Please find more infos on release notes and new features Release notes Velero