Upgrade Steps
Use the following instructions to upgrade from a previous Code Insight release to Code Insight 2025 R3. Each step includes the Code Insight server on which step is performed. The servers are identified as such:
-
Core—Code Insight Core Server
-
Scan—Code Insight Scan Server
-
Database—Database server used by Code Insight
If a step applies to both the Core Server and Scan Server and both servers are installed on the same instance, you need to perform the step once on the instance.
| Step | Server | Summary | Description | Required / Optional |
|---|---|---|---|---|
| 1 | Core/Scan | Download & install Code Insight 2025 R3 | Download the \.zip archive of the Code Insight 2025 R3 release from the Product and License Center in the Revenera Community portal. Unzip the archive into the vNew directory, parallel to the vCurrent directory. For example, if your vCurrent directory is D:/codeInsight/2022R1, your vNew directory will be D:/codeInsight/2025R3. | Required |
| 2 | Core/Scan | Shut down Tomcat | Shut down Tomcat to stop your vCurrent instance by executing shutdown\.bat or shutdown\.sh in vCurrent/tomcat/bin/. | Required |
| 3 | Database | Back up database | Back up your vCurrent database schema. | Required |
| 4 | Database | Migrate database | If migrating from 2018 R3 or later, skip this step since the database schema will be migrated automatically when you first start up the application after the upgrade. If migrating from 2018 R2 or earlier, you must manually migrate the vCurrent database schema. To do so, apply the database migration script(s) located in vNew/dbScripts/install/<database_type>/ in consecutive order from earliest to latest up to 2018R3 script. For example, if upgrading from Code Insight 2017 R1 to Code Insight 2025 R3, you should run all the migration scripts, starting with migrateTo2017R1SP1\.sql and ending with migrateTo2018R3\.sql . (However, if you are migrating from 2018 R2 to 2025 R3, run only the migrateTo2018R3\.sql script.) Then, once you upgrade to 2025 R3, the database schema is automatically migrated when you first start the application. For the privileges required to migrate the database, see Database Upgrade. | Required (for Code Insight 2018 R2 or earlier versions only) |
| 5 | Copy specific files from the vCurrent home directory to the vNew directory as directed in Steps 5a-5k. | |||
| 5a | Core/Scan | License key | Copy vCurrent /codeinsight\.key to vNew/. If you have a new license key provided by Revenera, copy the new license key file to vNew/ instead. | Required |
| 5b | Core/Scan | Database connector | Copy the appropriate database connector to vNew/tomcat/ lib/: MySQL 5.7—vCurrent/tomcat/lib/mysql-connector-java-5.`*`-bin.jar MySQL 8.0—vCurrent/tomcat/lib/mysql-connector-java-8.0.`*`.jar SQL Server—vCurrent/tomcat/lib/sql`*`.jar | Required |
| 5c | Core/Scan | Server and database properties | Copy the following property files to vNew/config/core/: vCurrent /config/core/internal\.properties vCurrent /config/code/core\.db\.properties If you are using a new license key file, change the encrypted password in the core.db.properties file to its “plaintext” form and save the file. | Required |
| 5d | Core/Scan | Project data indexes | Copy the vCurrent/proj_indexes/ folder to vNew/. If you are migrating from a version prior to Code Insight 2018 R1, skip this step as the index format has changed. Instead, rescan the projects to re-create the indexes. | Required |
| 5e | Core | Data library indexes | Copy the vCurrent/pdl_indexes/ folder to vNew/. | Required |
| 5f | Core/Scan | JRE | If you want the upgraded Code Insight (vNew) to use the same JRE used by your current Code Insight (vCurrent), copy the vCurrent/jre/ folder to vNew. If you want the upgraded Code Insight to use a different JRE version, see Switching the JRE for Code Insight. If your system Oracle JRE version is earlier than 8u192, consider upgrading to a version 8u192 or later supported by Code Insight. For more information about supported Oracle JRE versions, see Java Runtime Edition (JRE) Requirement. Whether Code Insight is using the embedded JRE or another supported JRE, note the JRE location on your system. You will need to supply this information in Step 6 when configuring the JAVA_HOME and JRE_HOME variables in the catalina.* file. | Required |
| 5g | Core | Reports | If you want to retain the Code Insight reports you have generated, copy the reports folder from vCurrent to vNew. | Optional |
| 5h | Core | Custom reports | If you have created custom reports and want to retain them, copy the custom_report_scripts folder from vCurrent to vNew. | Optional |
| 5i | Core | Project-data exports file | (When upgrading from 2023 R4 or later) If you have performed project data exports through the Code Insight user interface and want to retain the files containing the most recently exported data for projects, copy the exports folder from vCurrent to vNew. If you do not copy the folder, the status message “No project data has been exported” is displayed for all projects on their Summary tab, even for those projects on which a project data export was previously run. | Optional |
| 5j | Core/Scan | Custom properties | If you manually configured advanced auto discovery settings in the codeaware\.properties file and want to retain the settings, copy vCurrent /config/codeaware\.properties to vNew/config/. If you do not have the file in your vCurrent instance or do not need to retain the settings, skip this step. The majority of the settings previously configurable using the codeaware.properties file are now available in the Web user interface. | Optional |
| 5k | Core/Scan | jet3st properties | Copy vCurrent /config/core/jets3t\.properties to vNew/config/. if you have made any changes to this file as part of configuring a proxy server. | Optional |
| 5l | Scan | Rule files | Obtain the following rule files (used in scans) from Revenera and place them in the vNew/config/.codeaware/updates directory. Contact Revenera Support for help in obtaining the files. fnca-data-update.tar.gz manifest.txt Perform this step only if Code Insight is running in an offline (“air-gapped”) environment. | Required (for offline environments only) |
| 6 | Core/Scan | Configure Tomcat | Edit the vNew /tomcat/bin/catalina\.\* file as follows: Set JAVA_HOME to the absolute path of your JRE. This is either the system JRE path or the embedded JRE path if you followed step 5f (vCurrent/jre/). Set CATALINA_OPTS to the same value as set in vCurrent/tomcat/bin/catalina.* (for example, CATALINA_OPTS= -Xms12288m -Xmx12288m). Set \-DcodeinsightInstallPath=< vNew> (for example, -DcodeinsightInstallPath="D:/codeInsight/2021R4"). For proxy and SSL configuration, additional edits to the catalina.* file are necessary. See the next steps. | Required |
| 7 | Core/Scan | Configure your proxy | If your current Code Insight instance is running over a proxy, copy the following values from the vCurrent /tomcat/bin/catalina\.\* to vNew /tomcat/bin/catalina\. *: \-Dhttps\.proxyHost=<PROXY\_HOST> \-Dhttps\.proxyPort=<PROXY\_PORT> \-Dhttps\.proxyUser=<USERID> \-Dhttps\.proxyPassword=<PASSWORD> \-Djdk\.http\.auth\.tunneling\.disabledSchemes= To configure a proxy for the first time, see Enabling Secure HTTP Over SSL in the “Installing Code Insight” chapter. | Optional |
| 8 | Core/Scan | Configure SSL | If your current Code Insight instance is running over SSL, perform these steps: Copy the following file from vCurrent to vNew: vCurrent/tomcat/conf/server\.xml If the codeinsight.jks file is present in vCurrent, copy it to vNew. If its location is other than under vCurrent/tomcat (and subsequently vNew/tomcat), ensure that server.xml reflects the correct keystore path. In the vNew/tomcat/bin/catalina.* file, set the following property: -Dcodeinsight.ssl= true To configure SSL for the first time, see Enabling Secure HTTP Over SSL in the “Installing Code Insight” chapter. | Optional |
| 9 | Core | Configure SSO | If your current Code Insight instance is running over SSO, copy the following files and folders from vCurrent to vNew: vCurrent /config/core/core\.sso\.common\.properties vCurrent /core/security/ vCurrent /config/core/env\.properties vCurrent /config/core/security/SPMetadata\.xml vCurrent /config/core/security/IDPMetadata\.xml To configure SSO for the first time, see Configuring Code Insight to Use Single Sign-On in the “Configuring Code Insight” chapter. | Optional |
| 10 | Core/Scan | Configure service | If your current Code Insight instance is running as a service, use the following procedures to migrate the service according to your platform requirements: On Windows: Copy vCurrent\tomcat\bin\service.bat to vNew\tomcat\bin\. In <span class="Strong">vNew</span> \\tomcat\\bin\\service\.bat , update these properties: set JRE\_HOME= vNew \\jre \-DcodeinsightInstallPath= vNew setx CODEINSIGHT\_ROOT "vNew" In the <span class="Strong">vCurrent</span> \\tomcat\\bin folder, run the following at a command prompt: service\.bat remove In <span class="Strong">vNew</span> \\tomcat\\bin folder, run the following at a command prompt: service\.bat install On Linux (RHEL or CentOS): Update the following properties in the CodeInsight\.service file under the /etc/systemd/system directory: WorkingDirectory= vNew ExecStart=/usr/bin/su \-\-login <loginUserId> \-c vNew /tomcat/bin/startup\.sh (where <loginUserId> is the user ID running the Code Insight service) If the startup.sh file does not have EXECUTE permission, ensure that the Code Insight user that you specify to run the service has EXECUTE permission on this file. | Optional |
| 10 (cont’d) | On Ubuntu: Update the following properties in the CodeInsight\.service file under the /etc/systemd/system directory: WorkingDirectory= vNew ExecStart= *vNew* tomcat/bin/startup\.sh If the startup.sh file does not have EXECUTE permission, ensure that the Code Insight user that you specify to run the service has EXECUTE permission on this file. | |||
| 11 | Core/Scan | Remove specific webapps files from Tomcat | Delete the following files. For an instance running the Core Server only: vNew /tomcat/webapps/ codeinsightScanner (folder) vNew /tomcat/webapps/codeaware\.war For an instance running the Scan Server only: vNew /tomcat/webapps/ codeinsight (folder) For an instance running both the Core Server and a Scan Server: Do not delete any files. | Required |
| 12 | Core/Scan | Start Tomcat | To start Tomcat in the vNew instance, execute startup\.bat or startup\.sh in vNew/tomcat/bin/. The database schema is automatically migrated when you start Tomcat. | Required |
| 13 | Core | Launch Code Insight | Open a web browser and navigate to http://<SERVER\_HOST\_NAME>:<PORT>/codeinsight/ (for example, http://localhost:8888/codeinsight/ . | Required |
| 14 | Core | Run Electronic Update | Go to Administration > Electronic Updates to run the update to obtain the latest compliance library and automated discovery rules data. | Required |
| 16 | Scan | Rescan | To benefit from the latest automated detection rules, updates to the data library, and other Code Insight enhancements, rescan the existing projects. Alternatively, you can create and scan the same codebase in a new project. | Optional |