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
KubeStash 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.
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
KubeStash MariaDB addon uses the mariadb-dump command by default for backups.
The below example shows how you can pass the --flush-logs to flush the MariaDB server log files before starting the dump.
apiVersion: core.kubestash.com/v1alpha1
kind: BackupConfiguration
metadata:
name: sample-mariadb-backup
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: sample-mariadb
backends:
- name: gcs-backend
storageRef:
namespace: demo
name: gcs-storage
retentionPolicy:
name: demo-retention
namespace: demo
sessions:
- name: frequent-backup
scheduler:
schedule: "*/5 * * * *"
jobTemplate:
backoffLimit: 1
repositories:
- name: gcs-mariadb-repo
backend: gcs-backend
directory: /mariadb
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
tasks:
- name: logical-backup
params:
args: --flush-logs
Passing a target database to the backup process
The below example shows how you can pass target database name during backup.
apiVersion: core.kubestash.com/v1alpha1
kind: BackupConfiguration
metadata:
name: sample-mariadb-backup
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: sample-mariadb
backends:
- name: gcs-backend
storageRef:
namespace: demo
name: gcs-storage
retentionPolicy:
name: demo-retention
namespace: demo
sessions:
- name: frequent-backup
scheduler:
schedule: "*/5 * * * *"
jobTemplate:
backoffLimit: 1
repositories:
- name: gcs-mariadb-repo
backend: gcs-backend
directory: /mariadb
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
tasks:
- name: logical-backup
params:
args: --databases testdb
WARNING: Make sure that your provided database has been created before taking backup.
Using multiple backends
You can configure multiple backends within a single backupConfiguration. To back up the same data to different backends, such as S3 and GCS, declare each backend in the .spe.backends section. Then, reference these backends in the .spec.sessions[*].repositories section.
apiVersion: core.kubestash.com/v1alpha1
kind: BackupConfiguration
metadata:
name: sample-mariadb-backup
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: sample-mariadb
backends:
- name: gcs-backend
storageRef:
namespace: demo
name: gcs-storage
retentionPolicy:
name: demo-retention
namespace: demo
- name: s3-backend
storageRef:
namespace: demo
name: s3-storage
retentionPolicy:
name: demo-retention
namespace: demo
sessions:
- name: frequent-backup
scheduler:
schedule: "*/5 * * * *"
jobTemplate:
backoffLimit: 1
repositories:
- name: gcs-mariadb-repo
backend: gcs-backend
directory: /mariadb
encryptionSecret:
name: encrypt-secret
namespace: demo
- name: s3-mariadb-repo
backend: s3-backend
directory: /mariadb-copy
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
tasks:
- name: logical-backup
Running backup job as a specific user
If your cluster requires running the backup job as a specific user, you can provide securityContext under addon.jobTemplate.spec.securityContext section. The below example shows how you can run the backup job as the root user.
apiVersion: core.kubestash.com/v1alpha1
kind: BackupConfiguration
metadata:
name: sample-mariadb-backup
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: sample-mariadb
backends:
- name: gcs-backend
storageRef:
namespace: demo
name: gcs-storage
retentionPolicy:
name: demo-retention
namespace: demo
sessions:
- name: frequent-backup
scheduler:
schedule: "*/5 * * * *"
jobTemplate:
backoffLimit: 1
repositories:
- name: gcs-mariadb-repo
backend: gcs-backend
directory: /mariadb
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
jobTemplate:
spec:
securityContext:
runAsUser: 0
runAsGroup: 0
tasks:
- name: logical-backup
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 addon.jobTemplate.spec section.
apiVersion: core.kubestash.com/v1alpha1
kind: BackupConfiguration
metadata:
name: sample-mariadb-backup
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: sample-mariadb
backends:
- name: gcs-backend
storageRef:
namespace: demo
name: gcs-storage
retentionPolicy:
name: demo-retention
namespace: demo
sessions:
- name: frequent-backup
scheduler:
schedule: "*/5 * * * *"
jobTemplate:
backoffLimit: 1
repositories:
- name: gcs-mariadb-repo
backend: gcs-backend
directory: /mariadb
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
jobTemplate:
spec:
resources:
requests:
cpu: "200m"
memory: "1Gi"
limits:
cpu: "200m"
memory: "1Gi"
tasks:
- name: logical-backup
You can configure additional runtime settings for backup jobs within the
addon.jobTemplate.specsections. For further details, please refer to the reference.
Customizing Restore Process
KubeStash uses mariadb-dump during the restore process. 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 arguments to the restore process through the args params under addon.tasks[*].params section.
This example will restore data from database testdb only.
apiVersion: core.kubestash.com/v1alpha1
kind: RestoreSession
metadata:
name: sample-mariadb-restore
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: restored-mariadb
dataSource:
repository: gcs-mariadb-repo
snapshot: latest
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
tasks:
- name: logical-backup-restore
params:
args: testdb
Restore specific snapshot
You can also restore a specific snapshot. At first, list the available snapshot as bellow,
$ kubectl get snapshots.storage.kubestash.com -n demo -l=kubestash.com/repo-name=gcs-mariadb-repo
NAME REPOSITORY SESSION SNAPSHOT-TIME DELETION-POLICY PHASE AGE
gcs-mariadb-repo-sample-mariadb-backup-frequent-backup-1725257849 gcs-mariadb-repo frequent-backup 2024-09-02T06:18:01Z Delete Succeeded 15m
gcs-mariadb-repo-sample-mariadb-backup-frequent-backup-1725258000 gcs-mariadb-repo frequent-backup 2024-09-02T06:20:00Z Delete Succeeded 13m
gcs-mariadb-repo-sample-mariadb-backup-frequent-backup-1725258300 gcs-mariadb-repo frequent-backup 2024-09-02T06:25:00Z Delete Succeeded 8m34s
gcs-mariadb-repo-sample-mariadb-backup-frequent-backup-1725258600 gcs-mariadb-repo frequent-backup 2024-09-02T06:30:00Z Delete Succeeded 3m34s
The below example shows how you can pass a specific snapshot name in .spec.dataSource section.
apiVersion: core.kubestash.com/v1alpha1
kind: RestoreSession
metadata:
name: sample-mariadb-restore
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: restored-mariadb
dataSource:
repository: gcs-mariadb-repo
snapshot: gcs-mariadb-repo-sample-mariadb-backup-frequent-backup-1725258000
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
tasks:
- name: logical-backup-restore
Running restore job as a specific user
Similar to the backup process under the addon.jobTemplate.spec. you can provide securityContext to run the restore job as a specific user.
apiVersion: core.kubestash.com/v1alpha1
kind: RestoreSession
metadata:
name: sample-mariadb-restore
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: restored-mariadb
dataSource:
repository: gcs-mariadb-repo
snapshot: latest
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
jobTemplate:
spec:
securityContext:
runAsUser: 0
runAsGroup: 0
tasks:
- name: logical-backup-restore
Specifying Memory/CPU limit/request for the restore job
Similar to the backup process, you can also provide resources field under the addon.jobTemplate.spec.resources section to limit the Memory/CPU for your restore job.
apiVersion: core.kubestash.com/v1alpha1
kind: RestoreSession
metadata:
name: sample-mariadb-restore
namespace: demo
spec:
target:
apiGroup: kubedb.com
kind: MariaDB
namespace: demo
name: restored-mariadb
dataSource:
repository: gcs-mariadb-repo
snapshot: latest
encryptionSecret:
name: encrypt-secret
namespace: demo
addon:
name: mariadb-addon
jobTemplate:
spec:
resources:
requests:
cpu: "200m"
memory: "1Gi"
limits:
cpu: "200m"
memory: "1Gi"
tasks:
- name: logical-backup-restore
You can configure additional runtime settings for restore jobs within the
addon.jobTemplate.specsections. For further details, please refer to the reference.