USER MANUALS


Pre-Upgrade Tasks for the New Installation

This section lists the tasks you have to complete in the new installations of the Denodo Platform 9 and the Solution Manager 9, before importing the settings and metadata from the previous version.

If you do not use a module, skip its pre-upgrade tasks.

Common to All Modules

The tasks common to all modules have to be done in the installation of the Solution Manager and in the installation of the Denodo Platform.

Copy the Encryption Key

Important

This post-installation task is extremely important. Do not start any of the components of the Denodo Platform before doing this. If you do not do this, this installation may be left in an inoperable state.

If you already did an installation of Denodo Platform version 9 and/or Solution Manager version 9, copy these two files from one of the existing installations to this new installation:

  • <DENODO_HOME>/conf/denodo-key.keystore

  • <DENODO_HOME>/conf/denodo-keystore.json

See more about this in the page Replicate the Encryption Key Across All the Installations of the Installation Guide.

Install the Latest Update

Install the latest update of the Denodo Platform and the Solution Manager 9 (if there is one). The section Installing Updates and Hotfixes explains how to do it.

Enable SSL

Enable SSL on all the components. You can obtain a new private key or reuse the existing one.

To reuse the existing one:

  1. Copy the file with the private key from the installation of the Denodo Platform 8.0. To locate this file, open the file <DENODO_HOME_8_0>/conf/vdp/VDBConfiguration.properties} and search the property com.denodo.security.ssl.keyStore. Copy the file of this property to the new installation.

  2. Export the public key of this private key and import it into <DENODO_HOME_9_0>/jre/lib/security/cacerts.

    Do not copy the cacerts file from the previous version to the new one. That is because you will not have the most recent certificates of the public Certification Authorities (CA), which will prevent Denodo from connecting to some third-party HTTPS services.

  1. Enable SSL on all the components. We suggest you use the new Denodo SSL/TLS Configurator Script. This script automatically modifies all the configuration properties of all the components of the installation of the Denodo Platform and Solution Manager. However, you can still do it manually as in version 8.0.

Configure Windows Services

If you installed the new version on Windows and all/some components run as Windows services, configure these services appropriately. The section Configure Windows Services of the Installation Guide explains how to do so.

Kerberos: Copy Krb5 File

You have to do thse steps if:

  1. You enabled Kerberos authentication in any of the modules:

  2. Or, if in Virtual DataPort you have a data source that connects with Kerberos authentication.

Steps to do:

  1. In your installation of Denodo 8.0, check if, in the directory <DENODO_HOME_8_0>/jre/lib/security, there is a file named krb5.conf.

  2. If you have this file, copy it to the installation of Denodo 9, to the directory <DENODO_HOME_9_0>/jre/conf/security.

    Note

    If you are upgrading from Denodo 7.0 or an earlier version, the default location of the krb5 file within the Java Runtime Environment (JRE) is now different. That is because Denodo 9 uses Java 17 and Denodo 7.0 and earlier versions of Denodo, use older versions of Java, which look for this file on a different directory.

  3. Do the same for the Solution Manager (i.e. <SOLUTION_MANAGER_HOME_7_0>/jre/lib/security/).

Note

Do not enable Kerberos authentication in your new installation of Denodo 9 now. During the upgrade process, you will export the metadata and settings of Virtual DataPort of 8.0, 7.0 or 6.0. This will include the Kerberos configuration and the Kerberos keytab itself. Later, you will import all this into version 9.

Virtual DataPort

Virtual DataPort: Enable the External Database

If you configured Virtual DataPort 8.0 to use an external database, note that you need to use a different catalog/schema for the new version.

The section Storing the Metadata on an External Database of the Virtual DataPort Administration Guide explains how to do this.

Virtual DataPort: JDBC Data Sources that Use the Bulk Data Load API

Jump to the next subsection if:

  1. Your current version of Denodo is 8.0

  2. Or, if you installed the new version on the same computer as the version 7.0 or 6.0.

Open each JDBC data source and in the Read & Write tab, check if the check box Use Bulk Data Load is selected and if the field Work path points to a file. In this case and if you installed the Denodo Platform 9 on a different computer than 8.0, install the client libraries of this database on the new computer.

If you have a data source with bulk load enabled that connects to one of these databases, consider that in Denodo 8.0, you can configure them so you do not need to download the Hadoop distribution.

  • Hive 2.0

  • Impala

  • PrestoDB/Trino

  • Spark

Virtual DataPort: Enable the Cache Engine

If in the current Virtual DataPort you enabled the cache engine, do it in version 9 as well.

The previous section Virtual DataPort: Select a Catalog/Schema for the Cache Engine explains the advantages and drawbacks of using the same catalog/schema for the cache engine of version 8.0 and 9, or a different one.

After enabling the cache engine, compare the VQL of the data source vdpcachedatasource (database admin) of the version 8.0 and 9 to check they are equivalent.

Cache Configuration of Databases

You have to do the same for the Denodo databases that have their own cache configuration.

  1. In the version 8.0, execute this query to obtain the list of databases that have their own cache configuration:

    WITH global_cache_configuration AS (
             SELECT database_datasource_name,
                    datasource_name
             FROM get_cache_configuration()
             WHERE database_name IS NULL
         )
    SELECT DISTINCT cache_configuration.database_name AS database_that_uses_its_own_cache_configuration,
                    cache_configuration.database_datasource_name,
                    cache_configuration.datasource_name
    FROM get_cache_configuration() cache_configuration,
         global_cache_configuration
    WHERE (cache_configuration.database_name IS NOT NULL)
          AND (
              cache_configuration.database_datasource_name <> global_cache_configuration.database_datasource_name
              OR cache_configuration.datasource_name <> global_cache_configuration.datasource_name
          );
    

    The first column of the result are the databases that have their own cache configuration. If this query does not return any row, it means that all the databases use the global cache configuration.

  2. For each row, do these steps in the version 9.0:

    1. Create a database with the name of the column database_that_uses_its_own_cache_configuration.

    2. In this database, enable the cache configuration as in the version 8.0. Note that, as you did for the global cache configuration, you may also need to choose a different catalog/schema.

Cache Configuration that use the “Generic” Adapter

If the cache engine is configured to use the “Generic” adapter, copy the files cacheConfig-generic.xml and cacheConfig-generic-unicode.xml of the directory <DENODO_HOME_8_0>/conf/vdp to the directory <DENODO_HOME_9_0>/conf/vdp.

Virtual DataPort: Install Third-Party Connectors

In the next step of the upgrade process, when you export the metadata of Virtual DataPort, the resulting file will include the JDBC drivers that your JDBC data sources use. However, you still have to manually install other connectors.

If in Denodo 8.0 you have any of the following elements, install their connector in the new version:

Note

If you are upgrading from Denodo 7.0 or earlier, the installation process of these connectors has changed. Instead of copying the files to the installation, use Design Studio to install these connectors.

This query returns the different types of data sources you created. You can run this in your Denodo 8.0 server to know if you have to install the connectors above.

SELECT DISTINCT subtype
FROM get_elements()
WHERE input_type = 'Datasources'

Virtual DataPort: Other Third-Party Jar Files

Go to the folder of your existing Denodo installation <DENODO_HOME_8.0>/extensions/thirdparty/lib and check the files you have:

  • If you are upgrading from Denodo 8.0, this folder is empty on a default installation. If there are files, it means they were put during the operation of the installation.

  • If you are upgrading from Denodo 7.0, this folder includes these files:

    • denodo-vdp-jdbcdriver.jar

    • derbyclient.jar

    • jtds.jar

    • ojdbc14.jar

    • postgresql.jar

If you have more files, it means that there are or there were extensions of Virtual DataPort that require these files. Follow these steps to import these files in Denodo 9:

  1. Copy the additional files - not the ones listed above - to your computer.

  2. Log in to Design Studio version 9 with an administrator account.

  3. Click the menu File > Extensions management. In the tab Extensions, click Import.

  4. In Resource type, select jar and click Add. Note that the files listed in this “explorer” are the files of your computer, not the computer in which Virtual DataPort runs. Select the files with extension “jar” that you just copied from Denodo 7.0.

  5. Click Ok and then, click Ok again to upload these files to Virtual DataPort.

  6. If some of the files you copied from the previous version have the extension “.dll” or “.so”, click Import again but this time, in Resource type, select library.

To see what you have imported in the dialog Extensions management, select General in the box Type.

Note

Do not import in to Denodo 9 the files of the connector you just installed in the previous version (in Virtual DataPort: Install Third-Party Connectors).

Virtual DataPort: Version Control System

If you use the Version Control System (VCS) support, enable it now. When you configure it, use the repository you created for Denodo 9, do not use the repository you already have for 8.0.

Virtual DataPort: Delete Unused Objects

In the version 8.0, before exporting the metadata, consider removing objects that are not in use anymore. E.g. data sources without views, views and databases that were created for testing, etc.

Virtual DataPort: Delete Aracne and Google Search Data Sources

Ignore this if you are upgrading from Denodo 8.0.

The Aracne and Google Search data sources were deprecated in the version 7.0 and removed with the release of 8.0. If you have any, you can either delete them now, before exporting the metadata of Virtual DataPort, or delete them later, from the VQL file you generate from your current Denodo installation.

To obtain the list of data sources of these types, execute this query:

SELECT * FROM get_elements()
WHERE input_type = 'DataSources' AND (subtype = 'gs' or subtype = 'arn');

It is easier to do it now, from the administration tool rather than modifying the VQL file later. That way, if you delete a data source, its base views and their derived views will be automatically deleted as well.

Virtual DataPort - Denodo Monitor: Configure to Store the Information in a Database

If you use the Denodo Monitor of your Denodo Platform installations and you configured it to store the logs on a database, create another catalog/schema for the logs of Denodo 9; do not use the same catalog/schema you use for the logs of Denodo 8.0. This is necessary because the data model is different in version 9 than in 8.0.

Note

We recommend using the monitoring feature of Solution Manager instead of running a Denodo Monitor on each Denodo Platform installation because it is easier to manage. If you want to try this, skip this section.

To check if you are using this feature, in your installation of Denodo 8.0, open the file <DENODO_HOME_8_0>/tools/monitor/denodo-monitor/ConfigurationParameters.properties. If the value of the property vdpqueries.jdbcagent.enable is true and the property is uncommented (i.e. it does not have a # at the beginning), you are using this feature.

The page Configuring the Denodo Monitor explains how to configure this in detail. But essentially, you only have to do this:

  1. Create a catalog/schema using the SQL scripts of the path <DENODO_HOME_9_0>/tools/monitor/denodo-monitor/sql/. This directory has a SQL script for several vendors (DB2, MySQL, Oracle, PostgreSQL and SQL Server).

  2. Copy the files inside the directory <DENODO_HOME_8_0>/tools/monitor/denodo-monitor/lib/ to <DENODO_HOME_9_0>/tools/monitor/denodo-monitor/lib/.

Data Catalog: Enable the External Database

If you configured the Data Catalog 8.0 to use an external database, do this:

  1. Copy the JDBC driver of the external database to the new installation. That is, copy the content of <DENODO_HOME_8_0>/lib/data-catalog-extensions to the directory <DENODO_HOME_9_0>/lib/data-catalog-extensions.

  2. Enable this feature. Note that you need to use a different catalog/schema for the new version.

    The section Use an External Database for the Data Catalog of the Data Catalog Administration Guide explains how to do this.

Scheduler: Enable the External Database

If you configured Scheduler 8.0 to use an external database, note that you need to use a different catalog/schema for the new version.

The section Use an External Database for Scheduler of the Scheduler Administration Guide explains how to do this.

Solution Manager

Solution Manager: Enable the External Database

If you configured Solution Manager 8.0 to use an external database, do this:

  1. Copy the JDBC driver of this database to the new installation. That is, from <DENODO_HOME_8_0>/lib/solution-manager-extensions to <DENODO_HOME_9_0>/lib/solution-manager-extensions.

  2. Enable this feature. Note that you need to use a different catalog/schema for the new version.

Solution Manager: High Availability

If you had set-up a secondary node of License Manager, do the same for the new version.

Solution Manager: Enable Git Support

If you use the Git support of the Solution Manager, enable it in the new version. Remember to point to the new repository or the new branch.

Solution Manager: Configure Monitoring JDBC Appenders

If in Solution Manager 8.0, you configured the monitoring feature of Solution Manager to use JDBC appenders, and you want to do it in version 9 as well, do this:

  1. Create another catalog/schema for the logs of version 9; do not use the same catalog/schema you use for the logs of 8.0. This is necessary because the data model is different in version 9 than in 8.0.

  2. Copy the JDBC driver of the database. That is, copy the files of the directory <SOLUTION_MANAGER_HOME_8_0>/resources/solution-manager-monitor/denodo-monitor/lib to <SOLUTION_MANAGER_HOME_9_0>/resources/solution-manager-monitor/denodo-monitor/lib.

  3. Copy the files inside the directory <SOLUTION_MANAGER_HOME_8_0>/lib/solution-manager-extensions to <SOLUTION_MANAGER_HOME_9_0>/lib/solution-manager-extensions. This is necessary to allow the Solution Manager to automatically manage the monitor metadata.

Add feedback