Back up your Splunk Data Stream Processor deployment

It is recommended that you periodically back up the Splunk Data Stream Processor (DSP) system configurations. Doing a back up of a healthy environment enables you to restore from a back up in the event of a disaster.

Prerequisites

You must have system administrator (root) permissions to run DSP installation or cluster management commands. If you do not have these permissions, you can use the sudo command.

Steps

1. Back up and save the named configuration values set in DSP.
1. From the working directory of a node, enter:

   dsp backup --output <name of backup TAR file>

If you do not use the --output flag, a standard date-based time will be used to name your backup TAR file.

2. Once your backup is complete, you will be prompted to create and confirm a password to encrypt your backup TAR file. Save this password with your backup TAR file name in a safe location for reference in the event of a restoration.

   Please create a password to encrypt the tarball with:
   Enter password: <password>
   Confirm password: <re entered password>

3. Save the encrypted TAR file to your desired location for storing backups.

You now have a TAR file copy of your system configurations.

Restore configurations from back up

Follow these steps to restore your DSP system configurations. This restores most cluster configurations and secrets, omitting obsolete configurations or printing out a warning for unexpected configurations. as well as connection secrets, Postgres contents (including pipeline definitions and the DSP license), lookup files, and plugins.

1. Restore the previous configuration values.
   1. From the working directory of a node, enter:

      dsp restore <TAR file name>

   2. When prompted, enter the TAR file's password to decrypt your backup and begin restoration in your cluster.
   3. Activate your pipelines.

See also

Related topics

Cluster configuration options

Back up, restore, and share pipelines using SPL2