Restore Report

This page provides information about the report generated by a Restore.

How does Kannika Armory track the progress of a Restore?

Kannika Armory tracks the status of a Restore by continuously writing it to a Restore Report.

The report is a file that contains the status of the restore process. It is continuously updated as the restore process progresses, and tracks any errors that occur during the restore process.

Restore report persistence

At the moment the restore reports are written to a Kubernetes Persistent Volume . It will be possible to persist this to other storage systems, such as object storage or cloud storage, in the future.

The process writes the reports to the /kannika/reports/<report-name> directory, which is persisted across runs. The operator mounts a persistent volume onto the Restore to persist the /kannika/reports directory between runs, using a PersistentVolumeClaim.

The PersistentVolumeClaim is tracked by the io.kannika/report-pvc-name annotation on the Restore. Its value is generated from the parent’s Restore’s name. This label is used to ensure that the Restore has a unique PersistentVolumeClaim for its reports.

The PersistentVolumeClaim is created when the Restore is created, and is automatically deleted when the Restore is deleted.

Deleting the report

You can delete the report by deleting the PersistentVolumeClaim associated with the Restore.

$ kubectl delete pvc $(kubectl get restore <restore-name> -o jsonpath='{.metadata.annotations.io\.kannika/report-pvc-name}')

Note that Kubernetes adds the finalizer kubernetes.io/pvc-protection to the PersistentVolumeClaim, preventing it from being deleted it if it is still in use.

The operator will create a new PersistentVolumeClaim when the Restore is resumed.