Upgrading to Grouper 2.4 from Grouper 2.3
Using the Grouper Upgrader can simplify your upgrade process. Here is a movie demonstrating the Grouper upgrader. The upgrader can upgrade an installed env of the API, UI, WS, client, PSP, etc. If you dont have a build script to manage multiple envs, you might want to use the upgrader.
Upgrade Steps
- Download the grouper installer
- Run the upgrader for each env (test, prod, ui, ws, etc)
Important Changes in Grouper 2.4 that impact the upgrade
GSH next generation: GSH now uses Groovy shell. If your scripts dont work, set this in grouper.properties. (Though also inform the Grouper developers via Jira or email in case a fix is needed since the legacy GSH will be removed in the future.)
gsh.useLegacy = true
vt-ldap was converted to Ldaptive
- Test your LDAP loader and subject sources to make sure they work correctly. Note that if you use LDAP for your subject source, your configuration must change. More details coming. Try the subject source diagnostics
Convert the ehcache xml file to properties
- If you have not customized Grouper caching (generally the case), just delete the ehcache xml and use the properties file shipped with Grouper.
- If you have customized Grouper caching
- Run the grouperInstaller to convert this file
- Copy the grouper.cache.properties to all envs (prod, test, ui, ws, etc)
Convert the sources.xml to subject.properties
- Run the grouperInstaller to convert this file
- Copy the subject.properties to all envs (prod, test, ui, ws, etc)
Note that the admin and lite UIs are removed
- If you know of applications which deep link to the admin or lite UIs, update those links
Custom member fields have been deprecated
- This was a very uncommon feature so most people should not be impacted. Previously, each individual group could have multiple membership lists. There would be the default list of members, but then you could also specify separate membership lists as well. Going forward, the best practice is to use separate groups for those custom lists instead. Custom lists are not supported in the New UI, but if you still use them, they will be available in the Admin UI until the Admin UI is removed in Grouper 2.5.
Schema updates
- In previous Grouper upgrades, it was very common for large schema updates that required downtime to make the adjustments. For the 2.3 to 2.4 upgrade, the only updates are 3 new indexes. The upgrader will automatically add these without requiring a downtime.
See Also