2.4.0 Release notes - clarification requested

[Geoffsc]

Hi, we've recently upgraded from 2.3.0 to 2.4.0. We use external volumes in a single sfm-data directory on disk. In the future it'd be best for us if design changes like the data volume change were designed as "opt in" features controlled by new configuration settings to minimize impact.

We found the release notes for 2.4.0 very confusing. It's not clear for the data location settings that the left side of the : is the location on disk and the right side is the internal docker location. If this could be made more clear it'd be very helpful.

Also the example is confusing because it mentions a full path (/sfm-data/export) but only references the base path (/sfm-data): "For example, if export data is currently stored externally in /sfm-data/export, the .env should contain: DATA_VOLUME_EXPORT=/sfm-data:/sfm-export-data"

So if this could be better clarified as well it would be very helpful. Please let us know if we can clarify further and we appreciate the help!

[lwrubel]

Hi @Geoffsc, thank you for this feedback. I'm sorry the process has been confusing and will work on making the release notes clearer. I hear your point about making features optional.

The notes are correct about the mapping in 2.4. If you want to keep using a shared directory, then all of the mappings will looks like the example, assuming your current data is at /sfm-data on the filesystem: DATA_VOLUME_MQ=/sfm-data:/sfm-mq-data DATA_VOLUME_DB=/sfm-data:/sfm-db-data DATA_VOLUME_EXPORT=/sfm-data:/sfm-export-data DATA_VOLUME_CONTAINERS=/sfm-data:/sfm-containers-data DATA_VOLUME_COLLECTION_SET=/sfm-data:/sfm-collection-set-data

Inside the container, /sfm-export-data has a directory called exports and so that will map to your current /sfm-data/exports directory on the filesystem.

You will also want these settings below uncommented in your .env and pointing to your filesystem on the left side of the :

DATA_VOLUME_FORMER_COLLECTION_SET=/sfm-data/collection_set:/sfm-data/collection_set DATA_VOLUME_FORMER_EXPORT=/sfm-data/export:/sfm-data/export

Thank you again for identifying where we could make improvements. If you have any other trouble or questions, let us know.

[demiankatz]

Thanks, @lwrubel -- @Geoffsc and I did manage to figure it out in the end, but an explicit example in the notes about how to continue using a single shared directory might have saved us a little head-scratching (and I imagine may help others who haven't yet found the time to upgrade). If we can do anything more to help, please let us know, and thanks for your support!