search string side menu

BRIX On-Premises > Administering BRIX Enterprise / Back up and recover databases

Back up and recover databases

Elma365-Backupper is a utility that allows for backup of BRIX application data.

 

Backup of BRIX should include:

  • PostgreSQL. The database stores the main system data: users, application items, application settings, workspaces, processes, pages, widgets, tasks, events, and other configuration settings.
  • MongoDB. This database contains unstructured system settings, chat data, and activity streams.
  • S3 Object Storage. The object storage holds uploaded and created files in BRIX of any type and size, such as documents, photographs, audio, and video files.

Начало внимание

When creating a backup copy, the BRIX services are stopped, and the application itself becomes unavailable.

Конец внимание

The process of database backup and recovery consists of four steps:

  1. Install elma365-Backupper.
  2. Configure elma365-Backupper.
  3. Database backup.
  4. Database recovery.

Step 1: Install elma365-Backupper

  1. Install the packages:

sudo apt install -y apt-transport-https ca-certificates curl

  1. Import the keys:

sudo curl -fsSL https://repo.elma365.tech/deb/elma365-keyring.gpg | gpg --dearmor > /etc/apt/trusted.gpg.d/elma365-keyring.gpg

  1. Add the BRIX repository:

echo "deb [arch=amd64] https://repo.elma365.tech/deb $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/elma365.list
sudo apt update

  1. Install elma365-Backupper:

sudo apt install elma365-backupper

Installation for Red Hat-like operating systems

  1. Add the BRIX repository:

cat <<EOF | sudo tee /etc/yum.repos.d/elma365.repo
[elma365_repo]
name=ELMA365 Repository
baseurl=https://repo.elma365.tech/rpm/ol/releases/9.2/x86_64
gpgcheck=1
gpgkey=https://repo.elma365.tech/rpm/elma365-keyring.gpg
EOF

 
Please note that an rpm package is available only for Red Hat Enterprise Linux 9.

  1. Install Elma365-Backupper:

dnf install elma365-backupper

Step 2: Configure elma365-Backupper

  1. Open configuration file /opt/elma365/backupper/etc/config:

nano /opt/elma365/backupper/etc/config

  1. In the opened window, fill out the parameters:
  • KUBECONFIG is the path to the kubeconfig file, used for selecting the Kubernetes cluster and connecting to the Kubernetes API server. If not specified, $HOME/.kube/config is used by default.
  • BACKUP_DST is the directory where the backup will be saved. Available options are:
    • filesystem is backup is saved to the local file system at the path specified in BACKUP_PATH.
    • s3 is backup is saved to an S3 storage, using settings specified in parameters S3_BUCKET_NAME, S3_HOST, S3_PORT, S3_ROOT_USER, S3_ROOT_PASSWORD, S3_SSL_ENABLED.
  • K8S_NS_DBS is the namespace where the BRIX application is installed.
  • K8S_NS_APP is the namespace where the built-in databases are installed, set up in the Kubernetes cluster. For more information, see Prepare embedded databases.

Ensure ports 7000, 7001, 7002 are available for port forwarding to access databases in the Kubernetes cluster. If necessary, ports can be overridden in S3_SRC_PORT, PG_SRC_PORT, MONGO_SRC_PORT.

  • BACKUP_LIFE is the period in days for storing backup copies. Copies older than this value will be deleted during the next backup.
  • TMP_DIR is the directory for storing temporary backups. There should be enough space for one backup. The backup is assembled in this directory before being moved to the storage location specified in BACKUP_DST.

Example of a configured file

 
# KUBECONFIG parameter —  The path to the kubeconfig file, used for connecting to the Kubernetes cluster.
KUBECONFIG=""
# parameter BACKUP_DST — The directory where the backup will be saved.
# Available options are: s3, filesystem
# s3 — The backup will be saved to an S3 storage
# filesystem — he backup will be saved to the local file system at the path specified in the BACKUP_PATH parameter.
BACKUP_DST=filesystem
 
# The namespace where the BRIX application is installed
K8S_NS_APP=elma365
# The namespace where the built-in databases are installed
K8S_NS_DBS=elma365-dbs
 
# The period in days for which the backup is stored
BACKUP_LIFE=7
 
# The directory for storing temporary backup copies
TMP_DIR="/opt/elma365/backupper/tmp"
# The directory where backup copies will be stored
BACKUP_PATH="/opt/elma365/backupper/backup/"
 
# Parameters for configuring sonnection to the S3 Storage for the backups to be stored
# S3_BUCKET_NAME — The name of the bucket where backup copies will be stored. Reserved (unavailable) bucket names have the format (mask) "s3elma365*"
# S3_HOST — URL of the S3 storage
# S3_PORT — Port for connecting to the S3 storage
# S3_ROOT_USER — The name of the user with read or write rights to the bucket specified in S3_BUCKET_NAME
# S3_ROOT_PASSWORD — Password for the user S3_ROOT_USER
# S3_SSL_ENABLED — Whether encryption is used when connecting to the external S3 storage (true/false)
S3_BUCKET_NAME=""
S3_HOST=""
S3_PORT=""
S3_ROOT_USER=""
S3_ROOT_PASSWORD=""
S3_SSL_ENABLED=true
 
# Port forwarding parameters for accessing databases in the Kubernetes cluster:
# ВLocal ports specified in the following parameters will be forwarded to the Kubernetes cluster:
# S3_SRC_PORT — Port for connecting to the S3 storage
# PG_SRC_PORT —  Port for connecting to PostgreSQL
# MONGO_SRC_PORT —  Port for connecting to MongoDB
S3_SRC_PORT=7000
PG_SRC_PORT=7001
MONGO_SRC_PORT=7002

Step 3: Database backup

Perform a backup of the BRIX application databases:

elma365-backupper backup <<db-type>>

Where <<db-type>> is the name of the database for which you want to perform the backup. The possible values for the argument are:

  • mongo for MongoDB.
  • postgres for PostgreSQL.
  • s3 for S3 storage.
  • all for all databases (MongoDB, PostgreSQL, S3).

Additional backup command keys

  • --storage. This key is used for backing up databases to a local directory. When using this key, the parameters set in the configuration file are adjusted as follows: BACKUP_DST=filesystem and BACKUP_PATH="path specified in the argument".

Example of the command:

 
elma365-backupper backup <<db-type>> --storage /opt/elma365/backupper/backup/

  • -c --config. This key allows overriding the path to the elma365-Backupper configuration file. The default path is: /opt/elma365/backupper/etc/config.

Example of the command:

 
elma365-backupper backup <<db-type>> --config /opt/elma365/backupper/etc/config

Step 4: Database recovery

You can restore databases from the latest or a specific version of the backup.

Начало внимание

Before restoring data from a backup, clear the databases and S3 storage or use the --cleanup-databases key.

Конец внимание

For more details on how to prepare databases for restoration, refer to the following articles: PostgreSQL and MongoDB.

Restoration from the latest backup

Execute the command:

elma365-backupper restore <<db-type>>

Where <<db-type>> is the name of the database for which you need to retrieve the list of backups. The argument values can be:

  • mongo for MongoDB.
  • postgres for PostgreSQL.
  • s3 for S3 storage.
  • all for all databases (MongoDB, PostgreSQL, S3).

With this command, you can restore databases to the latest backup found in the storage. 

Restoration from a specific backup

  1. Get the list of backups from the storage:

elma365-backupper backup-list <<db-type>>

Where <<db-type>>  is the name of the database for which you need to retrieve the list of backups. The argument values can be:

  • mongo for MongoDB.
  • postgres for PostgreSQL.
  • s3 for S3 storage.
  • all for all databases (MongoDB, PostgreSQL, S3).

Additional keys for the backup-list command

  • --storage: searching for database backups in a local directory.

Example of the command:

 
elma365-backupper backup <<db-type>> --storage /opt/elma365/backupper/backup/

  • -c --config: overriding the path to the elma365-Backupper configuration file, the default path is: /opt/elma365/backupper/etc/config.

Example of the command:

 
elma365-backupper backup <<db-type>> --config /opt/elma365/backupper/etc/config

Depending on the backup storage method indicated in the BACKUP_DST parameter, the backup-list command will return:

  • For s3: names of directories with dumps in S3 storage.
  • For filesystem: absolute paths to directories with dumps in the file system.
  1. Execute database restoration from a specific backup:

elma365-backupper restore <<db-type>> --backup-path /path/to/backup

The backup for database restoration is taken from the storage specified in the BACKUP_DST parameter:

  • If S3 storage is indicated:

elma365-backupper restore <<db-type>> --backup-path ELMA365_YYYY.MM.DD-HH.MI.SS

  • If a local directory is indicated:

elma365-backupper restore <<db-type>> --backup-path /opt/elma365/backupper/backup/ELMA365_YYYY.MM.DD-HH.MI.SS/

Additional keys for the restore command

  • --cleanup-databases: a flag for automatic database clearing before restoring from a backup.

Example of the command:

 
elma365-backupper restore <<db-type>> --backup-path /path/to/backup --cleanup-databases

  • -c --config: overriding the path to the elma365-Backupper configuration file, the default path is: /opt/elma365/backupper/etc/config.

Example of the command:

 
elma365-backupper restore <<db-type>> --backup-path /path/to/backup --config /opt/elma365/backupper/etc/config
install-external-secrets-operator.html backup-and-recovery-with-wal-g-and-rclone.html