Skip to content

API

Afi Kubernetes Backup exposes an API based on https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/.

The API group for Afi Kubernetes Backup is k8sbackup.afi.ai. The following sections list object kinds in this API group and give details on each of them.

Here is the list of object kinds currently supported by Afi Kubernetes Backup:

  • archive - represent a backup archive where backup data is stored. The service creates a separate backup archive for each protection. A namespace might have several archives for each of its active protections (for each backup policy assigned to this namespace) as well as several archives without active protection (related to backup policies removed from the namespace).
  • backuppolicy - represent a backup policy. A backup policy can be assigned to a namespace for run backups and describes the backup settings.
  • protection - represent a protection created when a backup policy is assigned to a namespace (such namespace is 'protected' with this backup policy). Once an initial backup for a protection is performed, it creates a backup archive with backup data corresponding to this protection.
  • repository - represent a location where archives with backup data are stored. At the moment backup archives can be stored only in the same Kubernetes cluster, but Afi R\&D team is working on supporting backup to the Afi cloud and to a customer-provided bucket.
  • runbackup - represent backup tasks launched manually from inside the cluster. Backup tasks launched periodically by a backup policy or manually from the Afi portal are not listed in runbackups.
  • runrestores - represent restore tasks launched manually from inside the cluster. Restore tasks launched manually from the Afi portal are not listed in runrestores.