Migrating IDA from v2.7.x to v21.0.0

Important: If you run IDA with WAS, please refer to Installing IDA Application to check your WAS version. IDA may encounter some problems if the WAS version is below 9.0.5.4!

1. Migrating IDA with a datasource connection

Important: Please back up your database before migration!

1.1 Edit [IDA_HOME]/conf/ida.properties under the conf folder.

This properties file contains three main sections. Please set the spring.datasource.driver-class-name, spring.datasource.url, spring.datasource.username, spring.datasource.password fields. If you want to encode your database password, please refer to Repacking IDA Application.

Important: Please comment out spring.datasource.jndi-name if you do not use a JNDI datasource.

JNDI Configuration

  • spring.datasource.jndi-name: JNDI NAME

Datasource Configuration

  • spring.datasource.driver-class-name: Driver Class Name
  • spring.datasource.url: Datasource URL
  • spring.datasource.username: User Name
  • spring.datasource.password: Password

Jasypt Configuration

  • jasypt.encryptor.password: Jasypt secret key for encrypting datasource passwords

1.2 Repackaging ida-web.war with configuration

The purpose of repackaging is to update your application-product.yaml in the war to ensure it loads the recent configuration. Once all the properties in the [IDA_HOME]/conf/ida.properties file have been updated, you can then re-package the [IDA_HOME]/build/ida-web.war file.

Before running the [IDA_HOME]/package.bat or [IDA_HOME]/package.sh, you will need to set the JAVA_HOME environment variable and ensure that [JAVA_HOME]/bin is included in the PATH variable. Once the environment variable is set, you can then execute the package shell command to repackage the ida-web.war.

1.3 Stop your running IDA Application

For example:

./server stop SERVER_NAME

1.4 Execute migrate-<DATABASE_TYPE>-v2.7.x-v21.0.0.sql

Note: Please execute call sysproc.admin_cmd('reorg table <TABLE_NAME>'); after altering a table in a DB2 database.

1.5 Add <httpSession cookieSameSite="None"/> to server.xml

1.6 Replace ida-web.war and restart your server.

Note: Please refer to the documentation references-migrating-and-updating-your-application.

1.7 Migrate the values from your old conf/ida.properties to the ‘Settings’ page. The table below lists all the fields that need to be migrated:

  • General Settings:

    Settings -> General conf/ida.properties
    General -> Trace Level loggerLevel
    General -> Enable LDAP Authentication ldap.enable
    General -> URL ldap.url
    General -> User Name ldap.username
    General -> Password ldap.password
    General -> Base DN ldap.basedn
    General -> User Filter ldap.user.filter
    General -> Default Role ldap.default.role
    General -> User Name Case Insensitive ldap.username.case-insensitive

  • Testing Settings:

    Settings -> Test conf/ida.properties
    Test -> Connection Timeout (seconds) engine-config.connection-timeout
    Test -> Wait Timeout (seconds) engine-config.wait-timeout
    Test -> Default Retry Times engine-config.default-retry-times
    Test -> Default Retry Interval (seconds) engine-config.default-retry-interval
    Test -> Data Path engine-config.data-dir
    Test -> Enable Test Case History enable_case_history
    Test -> Max Number of Test Case History max_case_history
    Test -> Threshold of New Test Case default_total_case

  • Checkstyle Settings:

    Settings -> Checkstyle conf/ida.properties
    Checkstyle -> Engine checkstyle.engine
    Checkstyle -> Decision Server Username resUser
    Checkstyle -> Decision Server Password resPassword
    Checkstyle -> Decision Server URL resUrl
    Checkstyle -> Decision Server Port resPort
    Checkstyle -> Rest URL restUrl

  • Pipeline Settings:

    Settings -> Pipeline conf/ida.properties
    Pipeline -> Installation Package Remote Dir engine-config.installation-package-remote-dir
    Pipeline -> Host smtp.host
    Pipeline -> Port smtp.port
    Pipeline -> Sender Email email.from
    Pipeline -> Deployment Timeout (seconds) deployment.timeout
    Pipeline -> Deployment Check Interval (seconds) deployment.interval
    Pipeline -> Interval for Trigger by New Snapshot (seconds) pipeline.snapshot.trigger.interval

1.8 Restart the IDA server

Restart the IDA server to make your changes effective.

2. Migrating IDA with a JNDI datasource connection

Important: Please back up your database before migration!

2.1 Please refer to section 1.1 to edit the [IDA_HOME]/conf/ida.properties file under the conf folder.

Note: Please comment out the spring.datasource.driver-class-name, spring.datasource.url, spring.datasource.username, spring.datasource.password, and jasypt.encryptor.password fields.

2.2 Please refer to 1.2 to repack the ida-web.war

Note: Please refer to the documentation references-migrating-and-updating-your-application.

2.3 Please refer to 1.3 to stop your running IDA Application

2.4 Please refer to the documentation Installing IDA Application to configure the server.xml file.

2.5 Please copy your database driver to the folder according to the library field configuration in server.xml.

2.6 Execute migrate-<DATABASE_TYPE>-v2.7.x-v21.0.0.sql

Note: Please execute call sysproc.admin_cmd('reorg table <TABLE_NAME>'); after altering a table in a DB2 database.

2.7 Replace ida-web.war and restart your Liberty server.

2.8 Add <httpSession cookieSameSite="None"/> to server.xml

2.9 Please refer to 1.7 to migrate the old values from conf/ida.properties to the ‘Settings’ page

2.10 Restart the IDA server to make your changes effective.

Categories:

Updated: