Skip to main content
Skip table of contents

Database Enterprise to Community Migration Procedure

Due to ArangoDB Enterprise Edition 3.9.x license requirements, your organization may decide to migrate to the Community version. The following provides a procedure to conduct such a migration.

To obtain a list of ArangoDB Enterprise edition benfits, see https://www.arangodb.com/enterprise-server/ .

Migrate from Enterprise 3.8.x to Community 3.9.x

Linux

The following outlines the steps to move from ArangoDB Enterprise edition v 3.8.x to ArangoDB Community edition v 3.9.x. The particular steps and screenshots were conducted on an Ubuntu system. Make adustments for the flavor of Linux you are running.

Approximate Execution Time: 20 - 30 minutes

1. Verify you're using an Enterprise version (1 min)

In a Linux shell type,
arangosh -version

Or from the browser GUI, the login page identifies this.

2. Shut down the Centro Web App (1 min)

Prevent any addtional changes to the database by shutting down Centro. First start wth the web app.

  1. Notify your user base on downtime.

  2. Make sure there are no files being processed in the Centro Pipeline Manager.

  3. Bring up IIS Manager on your web server.

  4. Click Stop on the right side.

3. Stop the Centro Pipeline Host service (1 min)

Stop and disable the Centro Pipeline Host service to prevent it from restarting on its own.

  1. Bring up Services.

  2. Double click on Centro | Pipeline Host.

  3. Click Stop.

  4. Set the Startup type to Disabled.

  5. Click OK.

4. Stop the Centro Pipeline Manager service (1 min)

Stop and disable the Centro Pipeline Manager service to prevent it from restarting on its own.

  1. Again bring up Services.

  2. Double click on Centro | Pipeline Manager.

  3. Click Stop.

  4. Set the Startup type to Disabled.

  5. Click OK.

5. Back up the database (2 min)

Back up the database usnig arangodump. Arangodump exports each Collection table in the specified database and stores the data in a respective json file in a specified directory.

  1. On the command line, use the arangodump command.
    Usage:
    arangodump --server.database [database name] --include-system-collections --output.directory "[dir name]"

    Notes:
    * The default Centro database name is ActifyDB.
    * The directory the files are exported to does not have to exist beforehand.

    Add --overwrite true if you rerun the command and want to overwrite the existing files.

Example

CODE 
arangodump --server.database ActifyDB --include-system-collections --output-directory "dump" --overwrite true

At the time of this writing there are 75 collections dumped.

6. Store a copy (1 min)

In case of a catastrophic failure, save a copy of the back up folder/files on a separate system or drive.

Make sure the separate system is secure and conforms to your organizations security protocols.

7. Stop arangodb3 (1 min)

  1. On a command line type,
    systemctl stop arangodb3

  2. Check arangodb3 has stopped by typing,
    systemctrl status arangodb3

8. Save the arangod.conf file. (1 min)

  1. cd /etc/arangodb3/.

  2. Find and save off the arangod.conf file.

9. Uninstall Arangodb Enterprirse 3.8.x (2 min)

  1. Uninstall the Enterprise version by typing,
    sudo apt remove arangodb3

There may be remaining conf files left in /etc/arangodb3. You may choose to remove these as well.

The original installation files may also exist. You may choose to remove these by typing,
sudo apt autoremove arangodb3

10. Install Arangodb Community 3.9.x (2 min)

The following will install the latest release of Arangodb 3.9.x

  1. On a command line type the following,
    curl -OL https://download.arangodb.com/arangodb39/DEBIAN/Release.key

    sudo apt-key add - < Release.key

    echo 'deb https://download.arangodb.com/arangodb39/DEBIAN/ /' | sudo tee /etc/apt/sources.list.d/arangodb.list

    sudo apt-get install apt-transport-https

    sudo apt-get update

    sudo apt-get install arangodb3=3.9.2-1

  2. Respond to the questions such as entering the root password.

  3. Stop arangodb3 by typing,
    systemctl stop arangodb3

  4. Adjust configuration such as any endpoint adjustments for GUI. You can apply the arangod.conf file save from step #8.

  5. If you utilize an encrypted link (SSL) between the database and Centro make those adjustments.

  6. Restart arangodb3 by typing,
    systemctl start arangodb3

  7. Verify arangodb3 is running by typing,
    systemctl status arangodb3

11. Restore the database (1 min)

  1. On the command line, use the arangorsetore command.
    Usage:
    arangorestore --server.database [database name] --include-system-collections true --output.directory “[dir name]”

Example

CODE 
arangorestore --server.database ActifyDB --include-system-collections true --input-directory “dump”
12. Run the deploy script (1 min)

  1. Run the deploy script provided with the Centro installation files.
    *Run the deploy script whenever arangorestore is used.

13. Start the Centro Web App (1 min)

  1. Bring up IIS Manager on your web server.

  2. Click Start on the right side.

14. Start the Centro Pipeline Host service (1 min)

To start up the Centro Pipeline Host service.

  1. Bring up Services.

  2. Double click on Centro | Pipeline Host.

  3. Set the Startup type to Automatic.

  4. Click Apply.

  5. Click Start.

  6. Click OK.

15. Start the Centro Pipeline Manager service (1 min)

To start up the Centro Pipeline Manager service.

  1. Bring up Services.

  2. Double click on Centro | Pipeline Manager.

  3. Set the Startup type to Automatic.

  4. Click Apply.

  5. Click Start.

  6. Click OK.

16. Test for completion (5 min)

Verify your update and data restore worked by conducting the following simple tests.

  • Verify the database is a Community version and is 3.9.x.
    To do this login to the web GUI.

  • Login to Centro.
    Logging into Centro validates the database is accessible.

  • Read from database.
    Navgate to a Catalog part in Centro.

  • Write to the database.
    Conduct a Generate with upload on part. A success here indicates Centro can write to the database and pipelines are functioning.

  • Check security and accessiblity.
    If there are additional securty or penetraton checks on the ArangoDB web GUI or other “entry points” based on your organization’s security policy do so.

Windows

The following outlines the steps to move from ArangoDB Enterprise edition v 3.8.x to ArangoDB Community edition v 3.9.x. on a Wndows system.

Approximate Execution Time: 30 - 45 minutes

1. Verify you're using an Enterprise version (1 min)

On your Windows server that contains ArangoDB, in a command prompt, type

arangosh

Enter the root password.

Or from the browser GUI, the login page identifies this.

2. Or from the browser GUI, the login page identifies this.Shut down the Centro Web App (1 min)

Prevent any addtional changes to the database by shutting down Centro. First start wth the web app.

  1. Notify your user base on downtime.

  2. Make sure there are no files being processed in the Centro Pipeline Manager.

  3. Bring up IIS Manager on your web server.

  4. Click Stop on the right side.

3. Stop the Centro Pipeline Host service (1 min)

Stop and disable the Centro Pipeline Host service to prevent it from restarting on its own.

  1. Bring up Services.

  2. Double click on Centro | Pipeline Host.

  3. Click Stop.

  4. Set the Startup type to Disabled.

  5. Click OK.

4. Stop the Centro Pipeline Manager service (1 min)

Stop and disable the Centro Pipeline Manager service to prevent it from restarting on its own.

  1. Again bring up Services.

  2. Double click on Centro | Pipeline Manager.

  3. Click Stop.

  4. Set the Startup type to Disabled.

  5. Click OK.

5. Back up the database (1 min)

  1. Open a command prompt.

  2. Navigate to an approprate folder.

  3. On the command line, use the arangodump command.
    Usage:
    arangodump --server.database [database name] --include-system-collections--output.directory "[dir name]"

    Notes:
    * The default Centro database name is ActifyDB.
    * The directory the files are exported to does not have to exist beforehand.

    Add --overwrite true if you rerun the command and want to overwrite the existing files.

Example

CODE 
arangodump --server.database ActifyDB --include-system-collections --output-directory "dump" --overwrite true

At the time of this writing there are 75 collections dumped.

6. Store a copy (1 min)

In case of a catastrophic failure, save a copy of the back up folder/files on a separate system or drive.

Make sure the separate system is secure and conforms to your organizations security protocols.

7. Stop arangodb3 (1 min)

Stop the ArangoDB service.

  1. Again bring up Services.

  2. Double click on ArangoDB.

  3. Click Stop.

  4. Click OK.

8. Save the arangod.conf file. (1 min)

  1. Go to the c:\Progam Files\ArangoDB 3.8.x\etc folder.

  2. Find and save the arangod.conf file.

9. Uninstall Arangodb Enterprirse 3.8.x (2 min)

  1. Open Programs and Features.

  2. Select ArangoDB3e 3.8.7 in the list.

  3. Click Uninstall/Change.

  4. Follow the uninstall wizard.

  5. When asked do not delete ArangoDB user elements.

10. Install Arangodb Community 3.9.x (5 min)

  1. Download ArangoDB Community version 3.9.x for Windows from ArangoDB. Get the .exe installation for easy installation.
    (https://www.arangodb.com/download/ )

  2. Double-click on the ArangoDB installation and follow the wizard instructions.

  3. Once complete, stop the ArangoDB service in Services if it has started.

  4. Adjust configuration such as any endpoint adjustments for GUI. The arangod.conf file can be found and edited in the C:\Program Files\ArangoDB3 3.9.2\etc\arangodb3 folder (depending if you’ve used the default and depending on the exact version).
    You can apply the arangod.conf file save from step #8.

  5. If you utilize an encrypted link (SSL) between the database and Centro make those adjustments.

  6. Restart the ArangoDB service in Services,

11. Restore the database (Optional) (1 min)

On Windows, the database should still be intact.
*However, if you find that the database and the data is not there then restore the database through the following steps.

  1. Open a Command Prompt.

  2. Navigate to the folder above the folder where you dumped the database.

  3. From the ArangoDB Web GUI (localhost:8529), login as the root user.

  4. Select _System.

  5. Create an empty database with your database name
    (Centro defaults to “ActfyDB”).

  6. On the command line, use the arangorsetore command.
    Usage:
    arangorestore --server.database [database name] --include-system-collections true --output.directory “[dir name]”

Example

CODE 
arangorestore --server.database ActifyDB --include-system-collections true --input-directory “dump”

12. Run the Deploy Script (1 min)

  1. Run the deploy script provided with the Centro installation files.
    *Run the deploy script whenever arangorestore is used.

13. Start the Centro Web App (1 min)

  1. Bring up IIS Manager on your web server.

  2. Click Start on the right side.

14. Start the Centro Pipeline Host service (1 min)

To start up the Centro Pipeline Host service.

  1. Bring up Services.

  2. Double click on Centro | Pipeline Host.

  3. Set the Startup type to Automatic.

  4. Click Apply.

  5. Click Start.

  6. Click OK.

15. Start the Centro Pipeline Manager service (1 min)

To start up the Centro Pipeline Manager service.

  1. Bring up Services.

  2. Double click on Centro | Pipeline Manager.

  3. Set the Startup type to Automatic.

  4. Click Apply.

  5. Click Start.

  6. Click OK.

16. Test for completion (5 min)

Verify your update and data restore worked by conducting the following simple tests.

  • Verify the database is a Community version and is 3.9.x.
    To do this login to the web GUI.

  • Login to Centro.
    Logging into Centro validates the database is accessible.

  • Read from database.
    Navgate to a Catalog part in Centro.

  • Write to the database.
    Conduct a Generate with upload on part. A success here indicates Centro can write to the database and pipelines are functioning.

  • Check security and accessiblity.
    If there are additional securty or penetraton checks on the ArangoDB web GUI or other “entry points” based on your organization’s security policy do so.

Troubleshooting

The above procedure is fairly simple however these are some possible anticipated issues.

  • My Centro Pipeline services do not start nor can I get to the Centro login page.

    This typically means your Centro server cannot contact and log into the ArangoDB.
    Here are a few suggestions to help resolve

    • Make sure your Centro server can access the database.
      The easiest way to check on this is to try and vew the database through the Arango Web GUI.
      If you can’t reach it,

      • Try to ping the database server.

      • Check your firewall settings.

      • Check your endpoints in the arangod.conf file.

    • Verify your passwords are correct.

    • Verify the ArangoDB service is running.

    • Check firewall settings.

  • I didn’t download the same version of ArangoDB Community 3.9.x as shown in the screenshots. Is this ok?

    In general, this should be fine as long as it’s a newer version of ArangoDB 3.9.
    You may need to adjust a directory name from the steps listed above but otherwise the procedure should remain the same.

  • We don’t have our own IT department. Is this something that Actify can help us with?

    Call your Actify sales representative as they may be able to generate a service contract depending on timing and availability.

Official ArangoDB Downgrade Documentation

https://www.arangodb.com/docs/3.8/downgrading.html#supported-downgrade-procedures

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close