Backup and Restore MAS Core

Overview

This role supports backing up and restoring MAS Core namespace resources; supports creating on-demand or scheduled backup jobs for taking full or incremental backups, and optionally creating Kubernetes jobs for running the backup/restore process.

Important

A backup can only be restored to an instance with the same MAS instance ID.

Role Variables - General

masbr_action

Set backup or restore to indicate the role to create a backup or restore job.

Required
Environment Variable: MAS_BR_ACTION
Default: None

mas_instance_id

Defines the MAS instance ID for the backup or restore action.

Required
Environment Variable: MAS_INSTANCE_ID
Default: None

masbr_confirm_cluster

Set true or false to indicate the role whether to confirm the currently connected cluster before running the backup or restore job.

Optional
Environment Variable: MASBR_CONFIRM_CLUSTER
Default: false

masbr_copy_timeout_sec

Set the transfer files timeout in seconds.

Optional
Environment Variable: MASBR_COPY_TIMEOUT_SEC
Default: 43200 (12 hours)

masbr_job_timezone

Set the time zone for creating scheduled backup job. If not set a value for this variable, this role will use UTC time zone when creating a CronJob for running scheduled backup job.

Optional
Environment Variable: MASBR_JOB_TIMEZONE
Default: None

masbr_storage_type

Set local or cloud to indicate this role to save the backup files to local file system or cloud object storage.

Required
Environment Variable: MASBR_STORAGE_TYPE
Default: None

masbr_storage_local_folder

Set local path to save the backup files.

Required only when MASBR_STORAGE_TYPE=local
Environment Variable: MASBR_STORAGE_LOCAL_FOLDER
Default: None

masbr_storage_cloud_rclone_file

Set the path of rclone.conf file.

Required only when MASBR_STORAGE_TYPE=cloud
Environment Variable: MASBR_STORAGE_CLOUD_RCLONE_FILE
Default: None

masbr_storage_cloud_rclone_name

Set the configuration name defined in rclone.conf file.

Required only when MASBR_STORAGE_TYPE=cloud
Environment Variable: MASBR_STORAGE_CLOUD_RCLONE_NAME
Default: None

masbr_storage_cloud_bucket

Set the object storage bucket name for saving the backup files

Required only when MASBR_STORAGE_TYPE=cloud
Environment Variable: MASBR_STORAGE_CLOUD_BUCKET
Default: None

masbr_slack_enabled

Set true or false to indicate whether this role will send Slack notification messages of the backup and restore progress.

Optional
Environment Variable: MASBR_SLACK_ENABLED
Default: false

masbr_slack_level

Set failure, info or verbose to indicate this role to send Slack notification messages in which backup and resore phases:

Slack level	Backup/Restore phases
failure	`Failed`, `PartiallyFailed`
info	`Completed`, `Failed`, `PartiallyFailed`
verbose	`InProgress`, `Completed`, `Failed`, `PartiallyFailed`

Optional
Environment Variable: MASBR_SLACK_LEVEL
Default: info

masbr_slack_token

The Slack integration token.

Required only when MASBR_SLACK_ENABLED=true
Environment Variable: MASBR_SLACK_TOKEN
Default: None

masbr_slack_channel

The Slack channel to send the notification messages to.

Required only when MASBR_SLACK_ENABLED=true
Environment Variable: MASBR_SLACK_CHANNEL
Default: None

masbr_slack_user

The sender of the Slack notification message.

Optional
Environment Variable: MASBR_SLACK_USER
Default: MASBR

Role Variables - Backup

masbr_backup_schedule

Set Cron expression to create a scheduled backup. If not set a value for this varialbe, this role will create an on-demand backup.

Optional
Environment Variable: MASBR_BACKUP_SCHEDULE
Default: None

Role Variables - Restore

masbr_restore_from_version

Set the backup version to use in the restore, this will be in the format of a YYYMMDDHHMMSS timestamp (e.g. 20240621021316)

Required only when MAS_BR_ACTION=restore
Environment Variable: MASBR_RESTORE_FROM_VERSION
Default: None

Example Playbook

Backup

Backup MAS Core namespace resources, note that this does not include backup of any data in MongoDb, see the backup action in themongodb role.

- hosts: localhost
  any_errors_fatal: true
  vars:
    masbr_action: backup
    mas_instance_id: main
    masbr_storage_type: local
    masbr_storage_local_folder: /tmp/masbr
  roles:
    - ibm.mas_devops.suite_backup_restore

Restore

Restore MAS Core namespace resources, note that this does not include backup of any data in MongoDb, see the restore action in the mongodb role.

- hosts: localhost
  any_errors_fatal: true
  vars:
    masbr_action: restore
    masbr_restore_from_version: 20240621021316
    mas_instance_id: main
    masbr_storage_type: local
    masbr_storage_local_folder: /tmp/masbr
  roles:
    - ibm.mas_devops.suite_backup_restore

License

EPL-2.0