Skip to content

Commit

Permalink
Added hint to re-save data sources and password configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
n3ils authored and davide-zerbetto committed Nov 25, 2022
1 parent 44caa71 commit cd7829f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions installation-guide/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The upgrade of the following Knowage components is generally needed:

- the applications that reside within ``TOMCAT_HOME/webapps`` folder: all ``knowage*.war`` files (knowage.war, knowagebirtreportengine.war, knowagecockpitengine.war, ...)

- the Knowage metadata database, where information about analyses, datasets, etc ... is stored.
- the Knowage metadata database, where information about analyses, datasets, etc... is stored.

The latter component must be upgraded in case you are moving from a different major or minor version (for example: from 6.4.x to 7.2.y, or from 7.1.x to 7.2.y), but there is no need in case you are upgrading to a new patch release of the same major/minor family (for example: from 7.2.0 to 7.2.6, or from 7.2.6 to 7.2.13).

Expand Down Expand Up @@ -71,7 +71,7 @@ At this point, in some cases you need to deal with some configuration files, in

- context files ``TOMCAT_HOME/webapps/knowage*/META-INF/context.xml``: they contain links to resources such as datasource connections and environment variables; in case you modified them in order to add a new datasource, you need to restore the changes and check if links to environment variables defined in ``TOMCAT_HOME/conf/server.xml`` are all there. In case you defined contexts with relevant files inside ``TOMCAT_HOME/conf/Catalina/localhost`` and you are upgrading from a version prior to 7.2.0, then you need to add the link to the ``password_encryption_secret`` variable, since that was introduced by 7.2.0 version;

- Hibernate files: they contain the metadata database Hibernate dialect (the ``hibernate.dialect`` property): since versione 7.2.0, Knowage is able to autodetect the dialect by itself but, in case you customized it to a value other than ``org.hibernate.dialect.MySQLDialect`` or ``org.hibernate.dialect.PostgreSQLDialect`` or ``org.hibernate.dialect.Oracle9Dialect``, you have to restore your change: this is the list of Hibernate files to be checked:
- Hibernate files: they contain the metadata database Hibernate dialect (the ``hibernate.dialect`` property): since version 7.2.0, Knowage is able to autodetect the dialect by itself but, in case you customized it to a value other than ``org.hibernate.dialect.MySQLDialect`` or ``org.hibernate.dialect.PostgreSQLDialect`` or ``org.hibernate.dialect.Oracle9Dialect``, you have to restore your change: this is the list of Hibernate files to be checked:

.. code-block:: bash
Expand All @@ -83,7 +83,7 @@ At this point, in some cases you need to deal with some configuration files, in
TOMCAT_HOME/webapps/knowagemeta/WEB-INF/classes/hibernate.cfg.xml
TOMCAT_HOME/webapps/knowagesvgviewerengine/WEB-INF/classes/hibernate.cfg.xml
- Quartz configuration file for metadata database dialect and for cluster configuration (in case of any cluster): again, since versione 7.2.0, Knowage is able to autodetect the dialect by itself but, in case you customized the ``org.quartz.jobStore.driverDelegateClass`` property inside ``TOMCAT_HOME/webapps/knowage/WEB-INF/classes/quartz.properties`` to a value other than ``org.quartz.impl.jdbcjobstore.StdJDBCDelegate`` or ``org.quartz.impl.jdbcjobstore.PostgreSQLDelegate`` or ``org.quartz.impl.jdbcjobstore.oracle.OracleDelegate``, you have to restore your change. Regarding cluster configuration, by default it is not enabled on released packages therefore you need to restore it in case you have a clustered installation: add these lines in ``TOMCAT_HOME/webapps/knowage/WEB-INF/classes/quartz.properties`` (or restore them from the backup copy):
- Quartz configuration file for metadata database dialect and for cluster configuration (in case of any cluster): again, since version 7.2.0, Knowage is able to autodetect the dialect by itself but, in case you customized the ``org.quartz.jobStore.driverDelegateClass`` property inside ``TOMCAT_HOME/webapps/knowage/WEB-INF/classes/quartz.properties`` to a value other than ``org.quartz.impl.jdbcjobstore.StdJDBCDelegate`` or ``org.quartz.impl.jdbcjobstore.PostgreSQLDelegate`` or ``org.quartz.impl.jdbcjobstore.oracle.OracleDelegate``, you have to restore your change. Regarding cluster configuration, by default it is not enabled on released packages therefore you need to restore it in case you have a clustered installation: add these lines in ``TOMCAT_HOME/webapps/knowage/WEB-INF/classes/quartz.properties`` (or restore them from the backup copy):

.. code-block:: jproperties
Expand All @@ -94,8 +94,14 @@ At this point, in some cases you need to deal with some configuration files, in
.. important::
Since Knowage 7.2.0, the security level was highly increased. For this reason, users are requested to log in and change their password as a first step after upgrading. In addition, the JDBC data source password and all other passwords will be encrypted. We suggest you to save all existing JDBC datasources again and then, through the configuration management interface, we recommend saving the configurations again with the following label:

- MAIL.PROFILES.keyStore.password
- MAIL.PROFILES.kpi_alarm.password
- MAIL.PROFILES.scheduler.password
- MAIL.PROFILES.user.password
- MAIL.PROFILES.trustedStore.password

Since Knowage 7.2.0, the security level was highly increased. For this reason, users are requested to log in and change their password as a first step after upgrading.

To admin users: it is recommended to check which users didn't change the password and tell them to do it as soon as possible. Run the following query on the Knowage metadata database to extract the list of users who are still using the previous password encryption mechanism:

Expand Down

0 comments on commit cd7829f

Please sign in to comment.