You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Customizing Backup and Restore Process
Stash provides rich customization supports for the backup and restore process to meet the requirements of various cluster configurations. This guide will show you some examples of these customizations.
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, taking backup of specific streams, etc.
Passing arguments to the backup process
Stash NATS addon uses NATS CLI for backup. You can pass arguments to the backup command of the NATS CLI through args param under task.params section.
The below example shows how you can pass the --check to check a stream for health prior to backup.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: sample-nats-backup
namespace: demo
spec:
schedule: "*/5 * * * *"
task:
name: nats-backup-2.6.1
params:
- name: args
value: --check
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
retentionPolicy:
name: keep-last-5
keepLast: 5
prune: true
Backup specific streams
Stash takes backup of all the streams by default. If you want to take backup of specific streams, you can pass a list of streams through streams param under task.params section.
The below example shows how you can pass the "str1,str2" to take backup of the streams str1 and str2.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: sample-nats-backup
namespace: demo
spec:
schedule: "*/5 * * * *"
task:
name: nats-backup-2.6.1
params:
- name: streams
value: "str1,str2"
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
retentionPolicy:
name: keep-last-5
keepLast: 5
prune: true
Running backup job as a specific user
If your cluster requires running the backup job as a specific user, you can provide securityContext under runtimeSettings.pod section. The below example shows how you can run the backup job as the root user.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: sample-nats-backup
namespace: demo
spec:
schedule: "*/5 * * * *"
task:
name: nats-backup-2.6.1
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
runtimeSettings:
pod:
securityContext:
runAsUser: 0
runAsGroup: 0
retentionPolicy:
name: keep-last-5
keepLast: 5
prune: true
Specifying Memory/CPU limit/request for the backup job
If you want to specify the Memory/CPU limit/request for your backup job, you can specify resources field under runtimeSettings.container section.
apiVersion: stash.appscode.com/v1beta1
kind: BackupConfiguration
metadata:
name: sample-nats-backup
namespace: demo
spec:
schedule: "*/5 * * * *"
task:
name: nats-backup-2.6.1
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
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: sample-nats-backup
namespace: demo
spec:
schedule: "*/5 * * * *"
task:
name: nats-backup-2.6.1
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nat
retentionPolicy:
name: sample-nats-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
In this section, we are going to show how you can overwrite existing streams, restore a specific snapshot, run restore job as a specific user, etc.
Passing arguments to the restore process
Stash NATS addon uses NATS CLI for restore. You can pass arguments to the restore command of NATS CLI through args param under task.params section.
The below example shows how you can pass the --no-progress to disable the progress using the terminal bar. It will then issue log lines instead.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-nats-restore
namespace: demo
spec:
task:
name:nats-backup-2.6.1
params:
- name: args
value: --no-progress
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
rules:
- snapshots: [latest]
Restore specific streams
Stash restores all the streams by default. If you want to restore specific streams, you can pass a list of streams through streams param under task.params section.
The below example shows how you can pass the "str1,str2" to restore the streams str1 and str2.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-nats-restore
namespace: demo
spec:
task:
name: nats-restore-2.6.1
params:
- name: streams
value: "str1,str2"
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
rules:
- snapshots: [latest]
Overwrite existing streams
Stash doesn’t overwrite any existing stream by default during the restore process. If you want to overwrite the existing streams, you can pass true to the overwrite params under task.params section.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-nats-restore
namespace: demo
spec:
task:
name:nats-backup-2.6.1
params:
- name: overwrite
value: "true"
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
rules:
- snapshots: [latest]
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 rules section.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-nats-restore
namespace: demo
spec:
task:
name: nats-backup-2.6.1
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
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 job as a specific user
You can provide securityContext under runtimeSettings.pod section to run the restore job as a specific user.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-nats-restore
namespace: demo
spec:
task:
name: nats-backup-2.6.1
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
runtimeSettings:
pod:
securityContext:
runAsUser: 0
runAsGroup: 0
rules:
- snapshots: [latest]
Specifying Memory/CPU limit/request for the restore job
Similar to the backup process, you can also provide resources field under the runtimeSettings.container section to limit the Memory/CPU for your restore job.
apiVersion: stash.appscode.com/v1beta1
kind: RestoreSession
metadata:
name: sample-nats-restore
namespace: demo
spec:
task:
name: nats-backup-2.6.1
repository:
name: gcs-repo
target:
ref:
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
name: sample-nats
runtimeSettings:
container:
resources:
requests:
cpu: "200m"
memory: "1Gi"
limits:
cpu: "200m"
memory: "1Gi"
rules:
- snapshots: [latest]