Migrate Cortex XSOAR objects to Elasticsearch from a distributed database environment.
You should migrate Cortex XSOAR objects to Elasticsearch if you plan to ingest a large amount of objects.
When you run the migration tool, the contents of the Cortex XSOAR database are read, and a corresponding object is created in Elasticsearch. The migration tool is run from the main database machine and from each database node.
In the BoltDB, data related to incidents and indicators is stored in partitions by month. To minimize downtime during the migration, we recommend you create a copy of the database, then migrate data that is older than three months from the copy, while continuing to work in your current environment. Once the initial migration is completed, you should then migrate the last three months.
All commands are run from the Cortex XSOAR server machine.
To migrate your data, use the migration tool. You cannot run more than one migration tool process at a time.
Always migrate older data before newer data. Migrating partitions out of order can cause duplicate incident ids.
By default, the migration tool skips over objects larger than 100 megabytes. After the migration process runs, you can view the skipped large objects and determine whether to migrate them. For more information, see Validate the Migration to Elasticsearch.
For the main database, copy the Cortex XSOAR database either by taking a snapshot OR manually create a copy of the
/var/lib/demisto/datadirectory and the
demisto.conffile. Then follow the same procedure for each node.
Download the migration tool by appending
downloadName=elasticsearch_migration_tool_6_x_xto the end of the download link that you received, when installing Cortex XSOAR. Replace
X_Xwith the version number.
Copy your database and migrate data from the copy database to Elasticsearch.
It is recommended to copy your data up to the last three months, without any downtime. If you do not want to do this, go to step 4.
Copy the Cortex XSOAR database by doing one of the following:
Take a snapshot of the database.
Manually create a copy of the
Edit the copy of the
demisto.conffile, by adding your Elasticsearch configuration.
Ensure that the same Elasticsearch object exists in the
demisto.confon the app server and the main database and hat
elasticsearchis the top-level object in the
demisto.configfile (within the main curly brackets).
Edit the copies of
demisto.conffor the main database and for each node to add your Elasticsearch configuration.
For the main database and for each node, using
sudopermissions, run the following command:
sudo ./elasticMigrator -config-path
For a full list of the flags, see Migration Tool Flags. For example, to exclude the last 3 partitions from the migration, add the
sudo ./elasticMigrator -config-path /usr/local/dev/copy_of_demisto.conf -db-path /usr/local/dev/lib_demisto_copy/data -only-old-partitions -partitions-back 3
When you run the migration tool, parameter values specified in the
demisto.conffile override values supplied for tool flags and default values. If no value exists in the
demisto.conffile, values supplied in the tool flags override default values, but do not write the values to the
Complete steps 1 to 3 in Validate the migration.
After the migration of the data is complete and validated, migrate your remaining data from the active database to Elasticsearch.
Create a backup copy of the
demisto.conffile for your active database.
Edit the original
demisto.conffile (not a copy) for the main database and for each node to add your Elasticsearch configuration. Ensure that the same Elasticsearch object exists in the
demisto.confon the app server and the main database.
For the main database and for each node, stop the Cortex XSOAR server.
sudo systemctl stop demisto
sudo service demisto stop
For the main database and for each node, run the
sudo ./elasticMigratorcommand with either demisto or sudo permissions. Use the
partitions-backflag to specify the remaining partitions.
sudo ./elasticMigrator -partitions-back 3migrates the last three partitions, which would include the current month and the previous two months, as well as the main partition.
Validate the migration (all steps).
Migration Tool Flags
A comma-separated list of accounts to migrate. If not specified, all accounts are migrated.
The path to the configuration file for the server. Default:
The path to the database directory. Default:
The number of indicators per batch to write to Elasticsearch indices. Default:
The index prefix used in Elasticsearch.
The API key to connect to Elasticsearch.
Required (unless a username and password are used)
The password to connect to Elasticsearch.
Required (unless API key is used)
The URL of your Elasticsearch environment. Default:
The username to connect to Elasticsearch.
Required (unless API key is used)
The path to the file with the IDs to ignore, per object.
The log level to display. Default:
The location of the log file. Default:
Log individual failed items, either in a single meta file, or file per item failure. Values:
By default, the Elasticsearch tool checks existing indices and migrates only the ones that are new. Using this flag, the Elasticsearch tool migrates all indices even if they currently exist. This is useful, for example, if there was an error or invalid data that was fixed. When used, the
Comma-separated list of objects not to migrate. When the
Comma-separated list of objects to migrate. When the
Comma-separated list of partitions to exclude.
Comma-separated list of partitions to migrate. If no partitions are specified, all partitions are migrated.
Show results of the previous migration.
Existing indicators are not modified during the migration. Values:
The maximum size, in megabytes, of objects that will be migrated to Elasticsearch. The default is 100 MB.
Retry the migration of large objects when rerunning the migration tool. With this flag, the entire bucket that contains the skipped large object is migrated again, which may include data that was previously migrated. If new data has been added in Elasticsearch since the earlier migration, this data will be overwritten.
When the partitions flag is used, the
Provides an option to migrate X number of partitions back. For example, migrating three partitions back migrates the current month and the previous two months. If set to 0 or not used, all partitions are migrated.
Can only be used with the
Prints the migration tool version.
Answers yes to all questions, unless there is an error.