Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
75:mandatory_manual_upgrade_steps_for_version_75 [2020/05/11 10:14] – [Manual Upgrade Steps] cgl75:mandatory_manual_upgrade_steps_for_version_75 [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Mandatory Manual Upgrade Steps for Version 7.5 ====== ====== Mandatory Manual Upgrade Steps for Version 7.5 ======
  
-These actions need to be executed after upgrading to Stages 7.5 from previous Stages 7 versions.+These actions need to be executed before/after upgrading to Stages 7.5 from previous Stages 7 versions.
  
-===== Metamodel Configurations =====+===== General Recommendations Before Upgrading =====
  
-  * Custom implementation of Check Readiness validators may need to be adjusted and recompiled against this Stages version+To be safe in case of any crashes/problems during the update, **back up your database** (dump) befor the upgrade.\\ 
-  * TBD: Process Link+On Linux servers where Stages was started with "stages start" command, it shall be stopped with "stages stop" before the upgrade.
  
-The new Unified Configuration version 2.5 already contains those updates.+===== Manual Steps After Upgrading =====
  
-To update your Stages configuration to Unified Configuration V2.5, or to enhance your customized metamodel to use these new features, please contact your Stages Product Consultant or sales@methodpark.com. +  When using MySQL8 - the following settings are needed in /stages/conf/database.properties:
- +
-===== Manual Upgrade Steps ===== +
- +
-  The following settings are needed in database.properties for MySQL:+
       * The Connector/J driver must be used ([[https://dev.mysql.com/downloads/connector/j/|https://dev.mysql.com/downloads/connector/j/]]). The Connector/J driver is compatible with MySQL 5.6 and later. Replace the existing connector in the stages/lib directory and execute update.bat/update.sh after that.       * The Connector/J driver must be used ([[https://dev.mysql.com/downloads/connector/j/|https://dev.mysql.com/downloads/connector/j/]]). The Connector/J driver is compatible with MySQL 5.6 and later. Replace the existing connector in the stages/lib directory and execute update.bat/update.sh after that.
       * torque.database.default.adapter=DBMM       * torque.database.default.adapter=DBMM
Line 20: Line 16:
       * When using the Connector/J driver with MySQL 5.x, the "serverTimezone" parameter may be needed on some systems, too (e.g. serverTimezone=Europe/Berlin). Append it to the "torque.database.default.url".       * When using the Connector/J driver with MySQL 5.x, the "serverTimezone" parameter may be needed on some systems, too (e.g. serverTimezone=Europe/Berlin). Append it to the "torque.database.default.url".
       * The old driver (org.gjt.mm.mysql.Driver) can still be used with MySQL 5.x       * The old driver (org.gjt.mm.mysql.Driver) can still be used with MySQL 5.x
-  * Delete the contents of methodpark/stages/elasticsearch/data and restart Stages after that. \\ Note: On Windows "Stages Search" is a separate service that needs to be started before the Stages service. It may take some time until the search index is rebuilt and all search results can be found again.+  * Delete the contents of methodpark/stages/elasticsearch/data/nodes/and restart Stages after that. \\ Note: On Windows "Stages Search" is a separate service that needs to be started before the Stages service. It may take some time until the search index is rebuilt and all search results can be found again.
   * In order to update the diagram font configuration please perform the following steps (only necessary if another font than the standard SourceSansPro shall be used):   * In order to update the diagram font configuration please perform the following steps (only necessary if another font than the standard SourceSansPro shall be used):
       * Copy the font file, you want to use, to the conf/fonts folder       * Copy the font file, you want to use, to the conf/fonts folder
       * Add config property "diagram.font" with value="<FontFamilyName>:<FileName>" e.g. "Pacifico:Pacifico-Regular.ttf"       * Add config property "diagram.font" with value="<FontFamilyName>:<FileName>" e.g. "Pacifico:Pacifico-Regular.ttf"
       * Run update.bat/update.sh       * Run update.bat/update.sh
-  * The Resources definition in "conf/server.xml" has to be adjusted. Remove the following JarResources inside the <Resources …> tag in server.xml: <JarResources className="org.apache.catalina.webresources.DirResourceSet" base="${stages.datacache}/generated/lib" webAppMount="/WEB-INF/lib" /> +  * The Resources definition in "conf/server.xml" has to be adjusted. **__Remove__**  the following JarResources inside the <Resources …> tag in server.xml: \\ ''<JarResources className="org.apache.catalina.webresources.DirResourceSet" base="${stages.datacache}/generated/lib" webAppMount="/WEB-INF/lib" />'' \\ **Yes, we know**, this had to be added for version 7.4, now we found a better way to do this. 
-  * If an AJP connector is used it my need to be adapted. \\ For servers with more than one IP address add the address attribute to the connector to specify which address shall be used. \\ If the "secret" attribute is not used on the sonnector, set "secretRequired" attribute to "false". \\ See also: [[https://tomcat.apache.org/tomcat-8.5-doc/config/ajp.html|https://tomcat.apache.org/tomcat-8.5-doc/config/ajp.html]] \\  Example: \\  <font inherit/Courier New,Courier,monospace;;inherit;;inherit><Connector port="8009" protocol="AJP/1.3" **address="0.0.0.0"** redirectPort="8443" **secretRequired="false"** /></font>+  * If an AJP connector is used in conf/server.xml, it may need to be adapted. \\ For servers with more than one IP addressadd the address attribute to the connector to specify which address shall be used. \\ If the "secret" attribute is not used on the connector, set "secretRequired" attribute to "false". \\ See also: [[https://tomcat.apache.org/tomcat-8.5-doc/config/ajp.html|https://tomcat.apache.org/tomcat-8.5-doc/config/ajp.html]] \\  Example: \\ <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" secretRequired="false" address="0.0.0.0" />
  
-===== General Recommendations ===== 
  
-To be safe in case of any crashes/problems during the update, **back up your database**  (dump) and finally run the Stages update script: +===== Metamodel Configurations After Upgrading ===== 
-  * Stop the Stages service + 
-  * Execute the update script: +  * Custom implementation of Check Readiness validators may need to be adjusted and recompiled against this Stages version. 
-      * Windows: "…\stages\bin\update.bat" +  * No incompatibilities between 7.4 and 7.5 are known at this point, but all customizations of your metamodel need to be tested. 
-      * Linux: "…/stages/bin/update.sh" + 
-  * Restart the Stages service+The new Unified Configuration version 2.5 already contains those updates
 + 
 +To update your Stages configuration to Unified Configuration V2.5, or to enhance your customized metamodel to use these new features, please contact your Stages Product Consultant or sales@methodpark.com.