Migrate a Single Instance for High Availability
Instructions for migrating your Cortex XSOAR single instance deployment to a highly available installation of Cortex XSOAR. High availability.
To migrate a single instance from BoltDB to Elasticsearch with High Availability, there are two steps. First use the Cortex XSOAR migration tool to migrate the database. Then set up additional app servers to achieve high availability.
The migration tool migrates Cortex XSOAR objects to an Elasticsearch database. When you run the migration tool, the contents of the Cortex XSOAR database are read, and a corresponding object is created in Elasticsearch.
In the BoltDB, data related to incidents and indicators is stored by month in partitions. To minimize downtime during migration, we recommend creating a copy of the database and migrating data that is older than three months from the copied database. This enables you to continue to work in your current environment. When the initial migration completes, migrate the remaining months.
You cannot run more than one migration tool process at a time.
All commands are run from the Cortex XSOAR server machine.
If you are upgrading from Cortex XSOAR v6.0 to v6.2 and you have indicators and audits stored in Elasticsearch in Cortex XSOAR v6.0, upgrade from Cortex XSOAR v6.0 to v6.2 before the migration. Do NOT start the server. Then follow the migration instructions below.
Before you begin, ensure the following:
- You have an active instance of Cortex XSOAR v6.2.
- All app servers can communicate with Elasticsearch over port 9200.
- All app servers have network access to each other over port 443.
- Copy thedemisto.licfile from/usr/local/demistodirectory to the/var/lib/demistodirectory.
- Add the following entry in the demisto.conf file:license.file.path:"/var/lib/demisto"
- Follow migration instructions:
- If you used Elasticsearch to store indicators and audits in Cortex XSOAR v6.0 prior to upgrade, ensure the demisto.conf file is up-to-date with the ES object and then Migrate an Existing Elasticsearch Deployment.
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 indexes. 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:
By default, the Elasticsearch tool checks existing indexes and migrates only the ones that are new. Using this flag, the Elasticsearch tool migrates all indexes even if they currently exist. This is useful, for example, if there was an error or invalid data that was fixed. When used, the objects-to-migrate and objects-to-ignore flags are ignored. Values:
Comma-separated list of objects not to migrate. When the migrate-all flag is used, this flag is ignored.
Comma-separated list of objects to migrate. When the migrate-all flag is used, this flag is ignored.
Comma-separated list of partitions to migrate. If no partitions are specified, all partitions are migrated.
Comma-separated list of partitions to exclude.
Show results of the previous migration.
Existing indicators are not modified during the migration. Values:
Prints the migration tool version.
Answers yes to all questions, unless there is an error.
If you are implementing high availability and have not configured your load balancer to provide SSL, ensure that you have the same certificates for all the app servers and that the web certificate contains all the app server and load balancer URLs.
- When working in a high availability configuration, you must mount/var/lib/demisto/on a shared file system, to allow application servers to share files such as license, artifacts, and attachments. When migrating an existing file system to a shared file system, move the/var/lib/demistofolder without the/var/lib/demisto/tempsubdirectory to the shared directory.
- Thetempdirectory must be local and not shared. To change the location of thetempdirectory, edit thefolders.tempkey in thedemisto.conffile.
- Set the app server’s hostname by editing thedemisto.conffile:Under the Server object, set the value of theinClusterHostnameparameter to the desired hostname. The hostname should be the internal address used for communication with the other app servers.
- Install additional app servers.Verify that the clocks on the app servers are synchronized with an NTP server.
Recommended For You
Recommended videos not found.