Skip to main content
Version: 5.1

Creating Backups

Notation:

  • OS_HOME – OpenSearch home directory, typically /app/opensearch/

  • OSD_HOME – OpenSearch Dashboards home directory, typically /app/opensearch-dashboards/

  • LOGSTASH_HOME – Logstash home directory, typically /app/logstash/

  • SBM_HOME – Smart Beat Manager home directory, typically /app/SAFBeatManager/

  • SB_HOME – Smart Beat home directory, typically /app/SAFBeat/

Components and Files for Backup​

Please note!

To obtain the required certificates, the entire config directory is copied, which contains all critical files, including the admin certificate and its private key.

1. SA Master Node and SA Data Storage

Note!

The admin certificate and its private key should be stored on a separate server (e.g., under the control of a system administrator with access granted only upon request). These files provide full access to the entire cluster. During Search Anywhere Framework installation, the private key and admin certificate are generated on the first node, typically the SA Data Storage node.

Files:

  • ca-cert.pem

  • node-cert.pem

  • node-key.pem

  • opensearch.yml

Location: ${OS_HOME}/config

Backup commands:

mkdir -p /app/backup/opensearch_$(date +%Y%m%d)/
cp -r ${OS_HOME}/config /app/backup/opensearch_$(date +%Y%m%d)/

2. SA Web

Files:

  • ca-cert.pem

  • node-cert.pem

  • node-key.pem

  • opensearch_dashboards.yml

Location: ${OSD_HOME}/config

Backup commands:

mkdir -p /app/backup/opensearch-dashboards_$(date +%Y%m%d)/
cp -r ${OSD_HOME}/config /app/backup/opensearch-dashboards_$(date +%Y%m%d)/

3. SA Data Collector

Files:

  • ca-cert.pem

  • node-cert.pem

  • node-key.pem

Location: ${LOGSTASH_HOME}/config

Backup commands:

mkdir -p /app/backup/logstash_$(date +%Y%m%d)/
cp -r ${LOGSTASH_HOME}/config /app/backup/logstash_$(date +%Y%m%d)/

4. SAF Beat Manager

Files:

  • ca-cert.pem

  • cert.pem

  • cert.key

Location: ${SBM_HOME}/etc/ssl

Backup commands:

mkdir -p /app/backup/certs_$(date +%Y%m%d)/sbm
cp ${SBM_HOME}/etc/ssl/{ca-cert.pem,cert.pem,key.pem} /app/backup/certs_$(date +%Y%m%d)/sbm/

SAF Beat​

Files:

  • ca-cert.pem

  • cert.pem

  • cert.key

Location: ${SB_HOME}/cert

Backup commands:

mkdir -p /app/backup/certs_$(date +%Y%m%d)/sb
cp ${SB_HOME}/cert/{ca-cert.pem,cert.pem,key.pem} /app/backup/certs_$(date +%Y%m%d)/sb/