Skip to main content
Skip table of contents

ArangoDB Upgrade

The following outlines the steps to upgrade from your current ArangoDB to a newer version.

We would always strongly recommend backing up your VM/Server prior to following these steps. These steps should take approximately 20-50 minutes to complete.


Please note these screenshots are for illustration purposes only.

1.Check ArangoDB version installed by opening Command Prompt

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

arangosh

Enter the root password and then check the version (highlighted in yellow below)

image-20240117-133710.png

Or from the browser log into ArangoDB and check the version bottom left of the user interface.

image-20240117-133538.png

2. Shut down the Centro Web App in the IIS

This is to 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 Pipeline Host service

Stop and disable the 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 Pipeline Manager service

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. Open a command prompt.

  2. Navigate to an approprate folder that holds Arangodump.exe (i.e C:\Program Files\ArangoDB3e 3.x.x/usr/bin). If there are more versions under “C:\Program Files\”, it will be the latest version, this can be double checked by logging into your ArangoDB Website)

  3. On the command line, use the arangodump command.
    Usage:
    arangodump --server.database [database name] --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.
    * A valid ArangoDB root password is needed for this step.

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

Example

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

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

6. Store a copy

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

Stop the ArangoDB service.

  1. Again bring up Services.

  2. Double click on ArangoDB.

  3. Click Stop.

  4. Click OK.

8. Save backup of the Arangod.conf file

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

  2. Save the arangod.conf file to another directory/hard drive that can be used as a backup in case the original is lost or corrupted.

9.A Method A (ArangDB Upgrade)

This is the recommended approach. Install the consecutive versions of ArangoDB until you are on the latest Actify Supported version for your version of CAD Publisher (ArangoDB Compatibility Chart).

If your version of CAD Publisher supports up to ArangoDB 3.10.x you can use the example below:

Example:

  • Upgrading from ArangoDB 3.6.8 to ArangoDB 3.7.18

  • Then upgrading from ArangoDB 3.7.18 to ArangoDB 3.8.9

  • Then upgrading from ArangoDB 3.8.9 to ArangoDB 3.9.9

  • And then finally ArangoDB 3.9.9 to ArangoDB 3.10.12

  • Note - Upgrading that skips major versions, such as 3.6.x to 3.10.x is not officially supported. The officially supported upgrade path is the example given above.

In the above example, you would need the following:

  • ArangoDB3-3.7.18_win64.exe

  • ArangoDB3-3.8.9_win64.exe

  • ArangoDB3-3.9.9_win64.exe

  • ArangoDB3-3.10.12_win64.exe

We would strongly recommend checking with Actify’s Technical Support Team for the appropriate versions to use for this method by reaching out to them at centrosupport@actify.com or https://support.actify.com.

  • Once the ArangoDB version is updated, do the following steps to update the ActifyDB:

    • Unzip the Centro.zip

    • Open the unzipped folder and Extract the the C7-deploy-8.x.0woxxxx.xxxx.zip file. Which will show you the content shown below:

      (Note - This image is for illustrative purposes only)

      screenshot1-20240222-110001.JPG
    • In the Power Shell (Or Command Prompt while running it as Admin), navigate to the deploy folder you have just unzipped.

      screenshot2-20240222-105911.JPG

    • Run the Setup.bat file via PowerShell or CMD as Admin (NOTE - Do not double click or try to right click and run as admin, this will not work, it must be executed within Command prompt or Powershell.

    • Follow the instructions below:

      Opens image in full screenOpen

    • Press Enter for “What Database Name should be used? (Do not change it)

    • Press Enter for “What username should be used for the generated database user account?” (Do not change it)

    • Type n for “If the generated user already exists, would you like to generate a new password?” and press Enter.

    • You will not see any error messages, meaning the ActifyDB upgrade has been successfull.

9.B Method B (ArangDB Upgrade)

This is the original method that was used to upgrade your ArangoDB to the latest version. It is not officially recommended to use this approach anymore, the officially supported approach recommended by ArangoDB is to install consecutive versions of ArangoDB as per 9.A instructions.

First, Uninstall Arangodb

  1. Open Programs and Features.

  2. Select ArangoDB3e 3.x.x in the list.

  3. Click Uninstall/Change.

4. Follow the uninstall wizard.

5. When asked do not delete ArangoDB user elements. Leave it unticked.

10. Install Arangodb Community Edition

  1. Download ArangoDB Community version 3.x.x for Windows. (Actify can provide you the download links)

  2. Double-click on the ArangoDB installation and follow the wizard instructions. (Note - Do not change the ticked/unticked boxes shown below, leave as default)

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.

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

  2. Restart the ArangoDB service in Services,

11. Restore the database

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] --output.directory “[dir name]”

Example

CODE
arangorestore --server.database ActifyDB --input-directory “dump”

12. Start the Centro Web App

  1. Bring up IIS Manager on your web server.

  2. Click Start on the right side.

13. Start the Pipeline Host service

To start up the 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.

14. Start the Pipeline Manager service

To start up the 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.

15. Test for completion

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.

  • If you are NOT updating your CAD Publisher software. Proceed back to Step 3 and 4 to change the startup types for those services back to “Automatic” for the Pipeline Host and Pipeline Manager, as shown below.

  • Login to the CAD Publisher website to ensure it still loads with no errors. Logging into CAD Publisher validates the database is still accessible after the upgrades.

  • ArangoDB upgrade procedure has now been completed!

16. Next, Upgrading the CAD Publisher Software

JavaScript errors detected

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

If this problem persists, please contact our support.