Batch Backup Overview
Sometimes, a single component may not meet the requirement for your application. For example, in order to deploy a WordPress, you will need a Deployment for the WordPress and another Deployment for database to store it’s contents. Now, you may want to backup both of the deployment and database under a single configuration as they are parts of a single application.
Stash 0.9.0+ supports taking backup multiple co-related components using a single configuration known as BackupBatch. This guide will give you an overview how batch backup works in Stash.
How Backup Process Works
The following diagram shows how Stash takes backup of multiple co-related components in a single application. Open the image in a new tab to see the enlarged version.
The backup process consists of the following steps:
-
At first, a user creates a backend Secret. This secret holds the credentials to access the backend where the backed up data will be stored.
-
Then, she creates a
Repositorycrd which represents the original repository in the backend. -
Then, she creates a
BackupBatchcrd which specifies multiple targets(workload, volume, and database). It also specifies theRepositoryobject that holds the backend information where the backed up data will be stored. -
Stash operator watches for
BackupBatchobjects. -
When it finds a
BackupBatchobject, it checks if there is any workload as a target. If there any, it injects a sidecar namedstashinto the workloads. -
It also creates a
CronJobto trigger backups periodically. -
The
CronJobtriggers backup on each scheduled slot by creating aBackupSessioncrd. -
The BackupSession controller (inside sidecar for sidecar model or inside the operator itself for job model) watches for
BackupSessioncrd. -
When it finds a
BackupSessionit starts the backup process immediately(for job model a job is created for taking backup) for the individual targets. -
The individual targets complete their backup process independently and update their respective fields in
BackupSessionstatus.
Next Steps
- See a step by step guide to backup application with multiple co-related components here.