Backups

As of SD Elements 2024.2, the container deployment is the only deployment model offered for self managed instances of SD Elements. See the Container Migration Guide for information on migrating your VM instance to a Kubernetes and the Container Deployment section for documentation on installing and maintaining an SD Elements container deployment.

SD Elements provides a mechanism to create and restore backups on the same instance.

Create a server backup

Follow the steps below to create a backup of server customizations. The backup can be used for the purposes of server restoration.

Prerequisites:
  1. SSH credentials for sde_admin or sudo access.

  2. The backup you wish to create and restore will be performed on the same SD Elements instance (OVA file).

Steps:
  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run

    sudo sde backup create

A file is created in /docs/sde/backup/ by default, this value is configurable via the --output-dir flag. Its filename matches format sde-backup-SDE.Version-YYYY-MM-DD-HHMM.tar.gz where SDE.Version is a release name. For example,

sde-backup-4.12.22-2018-03-01-1201.tar.gz

The backup archive contains:

  • database encryption keys

  • core configurations in the YAML file

  • SAML certificates

  • Webserver SSL/TLS certificates

  • uploaded media files.

Further options are available, use sde backup help to view additional command arguments.

Restore a backup

Restore a server to an earlier state using a previously created backup.

Prerequisites:
  • SSH credentials for sde_admin or sudo access.

  • The backup you wish to create and restore will be performed on the same SD Elements instance (OVA file).

  • An existing backup archive whose version is identical to the active release of SD Elements.

Steps:
  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run

    sudo sde backup restore -i /file_path/backup_file.tar.gz

The files from the backup archive begin to restore, and a backup archive of your current database is created:

Schedule a backup

Perform regular application backups using the guidance below.

Prerequisites:
  1. SSH credentials for sde_admin or sudo access.

Steps:
  1. Schedule sde backup create to run as a cron job using details from section Supported system configuration

    • For example, perform a backup every 12 hours:

      cron::crontab::jobs:
       backup_sde:
         command: 'sde backup create'
         hour: '*/12'

results matching ""

    No results matching ""