logoBack to home screen

Updating ADx

ADx update is essentially a fresh installation from the provided package. You can, however, re-use certain components from the previous installation to speed up the process. Follow this tutorial if you already have ADx and you want to install a newer version.

Prerequisites

Before updating, it is always recommended to create a full backup of all the business data (databases, file systems). If an update fails, it might be necessary to restore the system database, in addition to restoring the previous ADx installation.

Before You Install

  1. Shut down the current ADx installation (if running).

    • Execute ./catalina stop from /runtime/host/bin if ADx was started from the command line with ./catalina run.
    • Execute /etc/init.d/service_name stop if ADx was started as a Linux service.
  2. As a pre-emptive measure, back up the current ADx installation.

  3. Unzip your new archive into your current installation root (that is, the directory containing adx-deployment-package). adx-deployment-package is now updated. You should have the following directories and files in the root folder (use ll to list them):

    • additional-libraries/ - created during first installation, hosts database drivers
    • adx-deployment-package/ - your new ADx package
    • elastic/ - elastic search data generated by previously used ADx instance. Will be overwritten when you run the new package
    • installation-settings.yaml - installation settings created during the first installation. Update this file if the new release intruduces configuration changes.
    • license/ - created during first installation, hosts the license file.
    • logs/ - log files from the previous ADx instance. Will be overwritten when you run the new package.
    • repository-resources/ - resource data from the previous ADx instance. Will be overwritten when you run the new package.
    • temp/ - temporary data from the previous ADx instance, will be overwritten when you run the new package.
  4. If the Release Notes of your new package mention any configuration changes, adapt the installation file accordingly. If your database or file system configuration has changed, we recommend to install ADx from scratch instead of re-using the components.

    To create new installation file based on the latest template, run cp adx-deployment-package/example-installation-settings.yaml installation-settings.yaml. If you do that, you need to re-enter configuration data into the new file.

  5. You are now ready to install the update. Please keep in mind that if you install in the same directory as the previous installation, all temporary data (logs, elastic search data, temporary files) will be overridden when you launch the new runtime. Please continue from here as explained in Installation.

Installation

Congratulations, you are now ready to install ADx!

  1. Go to the directory where you unzipped the package. Open adx-deployment-package.

  2. Open the terminal and run ./install.sh. If your installation settings file is not in the default location, adapt the paths and/or names accordingly (for example /install.sh --settings /path/to/installation-settings.yaml --environment /path/to/environment.sh.

    If the installation failed, quote the full version of the package (including the -p suffix if it's in your package name) to the support team.

  3. ADx should now be installed in the directory specified in the configuration file. To start it, enter /runtime/host/bin in the installation directory, then execute ./catalina.sh run. Alternatively, you can start the server as a Linux service.

After start-up, ADx will be available in your browser under the host and port you configured (for example http://localhost:8080). Enjoy using ADx!

Post-update Steps

Having installed ADx, do the following to verify that the functionality works as expected:

  1. Log in to ADx.

  2. Open the landing page, then click Explore under ADx Admin Access (available under Service Domains). Administrator Area opens.

  3. Synchronize all inactive repositories (click Synchronize in the bottom menu).

  4. Activate inactive repositories (click Activate in the bottom menu). This action brings all repository services online and enabless ADx Repository Explorer.

  5. Run a deep health check on the repository (click Health in the bottom menu, then Deep Check). The resulting report should be all green. If the report is OK, you can now start using ADx!

What's next?

Having installed and deployed ADx, you can start using the provided functionality. After you log in, you can find all of your repositories (and their APIs) in the landing page, under Operations. Click Explore to open a repository. See the following resources for more information:

You can always run a number of health checks to make sure everything is running smoothly. For more information, see Running Conversion and Platform Health Checks. If you want to run checks on legacy endpoints, see Running Deep Health Checks on Legacy Endpoints.