You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Customizing the Backup and Restore Process
This guide will show you how you can customize backup and restore processes in Stash according to your needs.
Note: YAML files used in this tutorial are stored here.
Customizing Backup Process
In this section, we are going to show you how to customize the backup process. Here, we are going to show some examples of providing arguments to the backup process, running the backup process as a specific user, etc.
Passing arguments to the backup process
Stash uses restic during the backup process. You can pass optional arguments to the restic backup process via spec.target.args field of BackupConfiguration.
Here is an example of passing --ignore-inode and --tag=t1,t2 arguments to a Deployment backup process of Stash.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: deployment-backup
namespace: demo
spec:
repository:
name: gcs-repo
schedule: "*/5 * * * *"
target:
ref:
apiVersion: apps/v1
kind: Deployment
name: sample-deployment
volumeMounts:
- name: source-data
mountPath: /source/data
paths:
- /source/data
args: ["--ignore-inode", "--tag=t1,t2"]
retentionPolicy:
name: "keep-last-5"
keepLast: 5
prune: true
WARNING: Make sure that you have the specific workload created before taking backup. In this case, Deployment
sample-deploymentshould exist before the backup sidecar starts.
Running backup Container as a specific user
If your cluster requires running the backup job as a specific user, you can provide securityContext under runtimeSettings.container section. The below example shows how you can run the backup sidecar for a Deployment as the root user.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: deployment-backup
namespace: demo
spec:
repository:
name: gcs-repo
schedule: "*/5 * * * *"
target:
ref:
apiVersion: apps/v1
kind: Deployment
name: sample-deployment
volumeMounts:
- name: source-data
mountPath: /source/data
paths:
- /source/data
runtimeSettings:
container:
securityContext:
runAsUser: 0
runAsGroup: 0
retentionPolicy:
name: 'keep-last-5'
keepLast: 5
prune: true
Specifying Memory/CPU limit/request for the backup
If you want to specify the Memory/CPU limit/request for your backup process, you can specify resources field under runtimeSettings.container section.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: deployment-backup
namespace: demo
spec:
repository:
name: gcs-repo
schedule: "*/5 * * * *"
target:
ref:
apiVersion: apps/v1
kind: Deployment
name: sample-deployment
volumeMounts:
- name: source-data
mountPath: /source/data
paths:
- /source/data
runtimeSettings:
container:
resources:
requests:
cpu: "200m"
memory: "1Gi"
limits:
cpu: "200m"
memory: "1Gi"
retentionPolicy:
name: keep-last-5
keepLast: 5
prune: true
Using multiple retention policies
You can also specify multiple retention policies for your backed-up data. For example, you may want to keep few daily snapshots, few weekly snapshots, and few monthly snapshots, etc. You just need to pass the desired number with the respective key under the retentionPolicy section.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: deployment-backup
namespace: demo
spec:
repository:
name: gcs-repo
schedule: "*/5 * * * *"
target:
ref:
apiVersion: apps/v1
kind: Deployment
name: stash-demo
volumeMounts:
- name: source-data
mountPath: /source/data
paths:
- /source/data
retentionPolicy:
name: sample-deployment-retention
keepLast: 5
keepDaily: 10
keepWeekly: 20
keepMonthly: 50
keepYearly: 100
prune: true
To know more about the available options for retention policies, please visit here.
Customizing Restore Process
Stash uses restic during the restore process also. In this section, we are going to show how you can pass arguments to the restore process, restore a specific snapshot, run restore job as a specific user, etc.
Passing arguments to the restore process
Similar to the backup process, you can pass optional arguments to the restic via spec.target.args in the restore process.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: deployment-restore
namespace: demo
spec:
repository:
name: gcs-repo
target:
ref:
apiVersion: apps/v1
kind: Deployment
name: sample-deployment
volumeMounts:
- name: source-data
mountPath: /source/data
rules:
- paths:
- /source/data/s
args: ["--tag=t1,t2"]
Restore specific snapshot
You can also restore a specific snapshot. At first, list the available snapshots as below,
❯ kubectl get snapshots -n demo
NAME ID REPOSITORY HOSTNAME CREATED AT
gcs-repo-4bc21d6f 4bc21d6f gcs-repo host-0 2022-01-12T14:54:27Z
gcs-repo-f0ac7cbd f0ac7cbd gcs-repo host-0 2022-01-12T14:56:26Z
gcs-repo-9210ebb6 9210ebb6 gcs-repo host-0 2022-01-12T14:58:27Z
gcs-repo-0aff8890 0aff8890 gcs-repo host-0 2022-01-12T15:00:28Z
You can also filter the snapshots as shown in the guide here.
You can use the respective ID of the snapshot to restore a specific snapshot.
The below example shows how you can pass a specific snapshot ID through the snapshots field of spec.target.rules section.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: deployment-restore
namespace: demo
spec:
repository:
name: gcs-repo
target: # target indicates where the recovered data will be stored
ref:
apiVersion: apps/v1
kind: Deployment
name: stash-recovered
volumeMounts:
- name: source-data
mountPath: /source/data
rules:
- snapshots: [4bc21d6f]
Please, do not specify multiple snapshots here. Each snapshot represents a complete backup of your database. Multiple snapshots are only usable during file/directory restore.
Running restore init-container as a specific user
You can provide securityContext under runtimeSettings.container section to run the restore init-container as a specific user during workload restore.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-deployment
namespace: demo
spec:
repository:
name: gcs-repo
target: # target indicates where the recovered data will be stored
ref:
apiVersion: apps/v1
kind: Deployment
name: stash-recovered
volumeMounts:
- name: source-data
mountPath: /source/data
runtimeSettings:
container:
securityContext:
runAsUser: 0
runAsGroup: 0
rules:
- snapshots: [latest]
Specifying Memory/CPU limit/request for the restore process
Similar to the backup process, you can also provide resources field under the runtimeSettings.container section to limit the Memory/CPU for your restore process.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-deployment
namespace: demo
spec:
repository:
name: gcs-repo
target: # target indicates where the recovered data will be stored
ref:
apiVersion: apps/v1
kind: Deployment
name: stash-recovered
volumeMounts:
- name: source-data
mountPath: /source/data
runtimeSettings:
container:
resources:
requests:
cpu: "200m"
memory: "1Gi"
limits:
cpu: "200m"
memory: "1Gi"
rules:
- snapshots: [latest]