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
- Back up and save the named configuration values set in DSP.
- From the working directory of a node, enter:
./list-configs
- Copy and save the output to your desired location for storing backups.
- From the working directory of a node, enter:
- (Optional) Back up and save any custom secrets stored in DSP.
- From the working directory of a node, enter the following command to get a list of secret keys. This command only returns custom secrets. Secrets with default values are not returned.
./list-secrets
- Copy and save the output to your desired location for storing backups.
- From the working directory of a node, enter the following command to get the values associated with the secret keys.
./get-secret <secret-key>
- Copy and save the output to your desired location for storing backups.
- From the working directory of a node, enter the following command to get a list of secret keys. This command only returns custom secrets. Secrets with default values are not returned.
You now have a copy of your system configurations.
Restore configurations from back up
Follow these steps to restore your DSP system configurations.
- Restore the previous configuration values.
-
From the working directory of a node, enter:
./set-config <PROPERTY_NAME> <VALUE>
- Repeat the previous step until all of the original configuration values have been set.
- Deploy the changes.
./deploy
-
From the working directory of a node, enter:
- Restore any custom secrets.
-
From the working directory of a node, enter:
./set-secret <SECRET_NAME> <VALUE>
- Repeat the previous step until all of the original custom secrets have been set.
- Deploy the changes.
./deploy
-
From the working directory of a node, enter:
See also
Resizing a cluster by adding or removing nodes | About the Splunk App for DSP |
This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0, 1.2.1-patch02, 1.2.1, 1.2.2-patch02, 1.2.4, 1.2.5, 1.3.0, 1.3.1
Feedback submitted, thanks!