Note: As user-managed mongo persistence is outside of our support scope, this KB is solely here to help provide an introduction on how to migrate your persistence if necessary. Please see Alteryx support guidlines for additional notation on items in and out of scope of support.

Migrate between Embedded and User-Managed Mongo

Definitions:
 

• Embedded Mongo in the default Alteryx Server installation is the Community Edition of Mongo that Alteryx installs and configures automatically. 
• User-Managed Mongo is a Mongo instance installed and managed by the customer, either on-prem or through Atlas Cloud. 
• User-Managed Mongo is not directly supported by Alteryx, but we hope the outlines below will help you plan your migration between the environments.

Procedure

​​​Migrate User-Managed -> Embedded

1. Use mongodump to backup
2. Create a new Embedded database on Alteryx Server in a new folder
3. Once the Alteryx Service starts successfully and all processes are completed, shut down the Alteryx Service
4. Perform emongodump from the new folder (emongodump is an AlteryxService.exe command, see help)
5. From the emongodump folder, take the "admin" folder and the .bin files and place them into the same folder that you did the mongodump from the User-Managed instance
6. emongorestore the resulting folder to a new persistence folder
7. Attempt to start Alteryx Server on the newly restored embedded DB

Migrate Embedded -> On-Prem User-Managed

1. Open a command shell as an Administrator
2. In the shell, execute "AlteryxService stop" to stop the Server
3. Navigate to the Alteryx installation directory (\Program Files\Alteryx\bin by default)
4. In the shell, execute "AlteryxService.exe getemongopassword" to retrieve the MongoDB credentials
5. Copy off both passwords, note that the username for both the admin and non-admin user is "user"
6. Take a mongodump of the embedded persistence, and move the dump to the user-managed on-prem server to do a restore as a standalone
7. Ensure the new connection string for the user-managed persistence is configured to use the non-admin "user" to connect. Note that the string will vary for on-prem stand-alone vs. on-prem-replicaset
8. Convert the new stand-alone instance to a Replica Set, see external documentation : https://docs.mongodb.com/manual/tutorial/convert-standalone-to-replica-set/

Migrate Embedded -> Atlas User-Managed

1. Backup MongoDB
   1. AlteryxService emongodump=C:\Backup
2. Restore to Atlas
   1. mongorestore --uri "mongodb+srv://<admin name>:<password>@<cluster>" --dir=C:\Backup --nsExclude "admin.system.*"
3. Add the following to System Settings. Note: Enable Advanced Strings on User-Managed MongoDB
   1. Controller Database Persistence
      1. mongodb+srv://<admin name>:<password>@<cluster>/AlteryxService?retryWrites=true&w=majority
   2. Gallery Database Persistence
      1. mongodb+srv://<admin name>:<password>@<cluster>/AlteryxGallery?retryWrites=true&w=majority
      2. mongodb+srv://<admin name>:<password>@<cluster>/AlteryxGallery_Lucene?retryWrites=true&w=majority

Migrate On-Prem User-Managed -> Atlas User-Managed

See Mongo documentation - https://www.mongodb.com/cloud/atlas/migrate