Upgrade Notes

Upgrade Path

You can upgrade to v7.12.x from any v7.x release that is older than the version being upgraded to.

If you want to upgrade to v7.12.x from v5.x or v6.x we recommend you do the following:

1. Upgrade v5.x to the latest patch release of v6.0.
2. Upgrade v6.x to the latest patch release of v7.0.
3. Upgrade v7.x to the latest patch release of v7.12.

Java Version

Stroom v7.12 requires Java 25.

Ensure the Stroom and Stroom-Proxy hosts are running the latest patch release of Java v25.

Configuration File Changes

Common Configuration Changes

These changes are common to both Stroom and Stroom Proxy.

Changes to receive Branch

The property dataFeedIdentitiesDir has been renamed from dataFeedKeysDir, and its default value has changed to data_feed_identities.

    dataFeedIdentitiesDir: "data_feed_identities" # Default value changed from "data_feed_keys"

Stroom’s config.yml

Changes to autoContentCreation Branch

  autoContentCreation:

    # An optional group to add the group defined by groupTemplate to.
    # The value of this property is the name of a group. It can be the same 
    # as groupParentGroupName if required. 
    # It allows all the templated groups to belong to a common group for easier 
    # permission management.
    additionalGroupParentGroupName: "Data Feed Developer"  # New property

    # If set, when Stroom auto-creates a feed, it will create an additional user group with a 
    # name derived from this template. This is in addition to the user group defined by 'groupTemplate'.
    # If not set, only the latter user group will be created. Default value is 'grp-${accountid}-dev'. 
    # If this property is set in the YAML file, use single quotes to prevent the 
    # variables being expanded when the config file is loaded.
    additionalGroupTemplate: "grp-${accountid}-dev"        # Default value changed from "grp-${accountid}-sandbox"

    # An optional templated sub-path of 'destinationExplorerPathTemplate'. If set, copied dependencies (e.g.
    # XSLT filters, Test Converters, etc.) will be created in the sub-directory defined by this template. 
    # If not set, that content will be created in the directory 
    destinationExplorerSubPathTemplate: "dev"              # New property

    # An optional group to add the group defined by groupTemplate to.
    # The value of this property is the name of a group. 
    # It allows all the templated groups to belong to a common group for easier 
    # permission management.
    groupParentGroupName: "Data Feed Reader"               # New property

stroom.data.meta.dataFormats

An additional default value of JSON_LINES has been added for handling data in JSON Lines format, i.e. one complete JSON object per line. This is a useful format for JSON log events.

Stroom-Proxy’s config.yml

No Stroom-Proxy specific configuration changes have been made.

Database Migrations

When Stroom boots for the first time with a new version it will run any required database migrations to bring the database schema up to the correct version.

On boot, Stroom will ensure that the migrations are only run by a single node in the cluster. This will be the node that reaches that point in the boot process first. All other nodes will wait until that is complete before proceeding with the boot process.

It is recommended however to use a single node to execute the migration. To avoid Stroom starting up and beginning processing you can use the migrage command to just migrate the database and not fully boot Stroom. See migrage command for more details.

Migration Scripts

There are no database migrations in v7.12.