Release Notes for Grouper 2.4
Grouper v2.4.0 includes 276 fixes and improvements over v2.3.0. See the full list.
New Features in Grouper 2.4.0
Most features in Grouper 2.4.0 are also in 2.3.0 patches. The upgrade from 2.3.0 to 2.4.0 is a minor upgrade.
Migrate all screens in Admin and Lite UI to the "New UI" and remove the admin and lite UI. Note, you can add the legacy UI if needed | |
| Deprovisioning | Deprovision access from someone to loses an affiliation or changes jobs |
| Attestation | Groups and folders can be marked to require periodic membership review. Reminders will be emailed to group owners |
| Grouper deployment guide | Version 1 of the Grouper deployment guide is an introduction to Grouper and best practices for using it |
| Add new messaging strategies for ActiveMQ, AMQP (e.g. RabbitMQ), AWS | |
| Grouper loader in UI | User interface to show loader configuration, diagnostics, logs, wizard editor |
| Subject API diagnostics | User interface to analyze, diagnose, and recommend improvements for subject source configuration |
| Real time SQL loader | Allow a change log table (SQL triggers) or messages to trigger loader updates for a partial population or single user |
| Instrumentation | Improve and standardize Grouper logging to provide centralized metrics at an institution and the ability to upload stats to a central Internet2 server |
| Packaging | Docker containers that hold Grouper components for each deployment |
| GSH next generation | Improve gsh by adding readline like capabilities (line editing, tab completions, history, etc) |
| Inbound messages | Allow Grouper to read a message queue and act on messages (e.g. membership changes etc) |
| vt-ldap to Ldaptive | Upgrade from vt-ldap to Ldaptive |
| properties config | Convert sources.xml and ehcache.xml to be cascaded properties files |
| Update 3rd party libraries | Update 3rd party libraries to the latest version that is feasible |
v2.4.0 patches
Grouper patching instructions (how to install patches with the Grouper installer)
note: if a java file is included in a patch, then all associated classfiles are there too
| Date | Patch | Description | Files affected |
|---|---|---|---|
| API patches | |||
2018/09/06 | GRP-1888: Fix default configuration for ldap validator | classes/edu/internet2/middleware/grouper/ldap/ldaptive/LdaptiveSessionImpl.java | |
2018/09/13 | GRP-1890: Real time ldap loader with LDAP_GROUPS_FROM_ATTRIBUTES | classes/edu/internet2/middleware/grouper/app/loader/db/GrouperLoaderResultset.java | |
2018/09/17 | GRP-1901: Real time loader SQL jobs - allow separate database for incremental table | classes/edu/internet2/middleware/grouper/app/loader/GrouperLoaderIncrementalJob.java | |
2018/10/09 | GRP-1803: gsh script incorrectly assumes GROUPER_CP=${GROUPER_HOME}/conf NOTE! In order to patch files in bin/ directory, requires latest grouperInstaller.jar (2018-10-31 or later) NOTE! If patching UI and WS, disregard errors "Problem applying patch since this patch old file" and allow to force update the bin files. Or, can set grouperInstaller.autorun.forceInstallPatch if using custom properties | classes/groovysh.profile | |
2018/10/15 | GRP-1826: Disable/Enable Loader job | classes/edu/internet2/middleware/grouper/j2ee/status/DiagnosticLoaderJobTest.java | |
2018/11/02 | GRP-1943: add debugging information in UI search | classes/edu/internet2/middleware/grouper/misc/GrouperObjectFinder.java | |
2018/11/05 | GRP-1941: LDAP loader - parsing complex attribute values GRP-1877: LDAP_GROUPS_FROM_ATTRIBUTES should utilize extra attributes to construct display name | classes/grouper-loader.base.properties | |
2018/11/09 | GRP-1856: Instrumentation file location should be configurable | classes/edu/internet2/middleware/grouper/instrumentation/InstrumentationThread.java | |
2018/11/09 | GRP-1895: ldaptive default ThreadLocalTLSSocketFactory mixes hostnames with multiple server configs | lib/grouper/ldaptive-1.1.0.jar | |
2018/11/13 | lib/grouper/dom4j-2.1.0.jar | ||
2018/11/24 | classes/edu/internet2/middleware/grouper/StemFinder.java | ||
2018/12/07 | classes/edu/internet2/middleware/grouper/app/loader/GrouperLoader.java | ||
| UI patches | |||
2018/09/06 | GRP-1881: Change away from MyServices widget and then can't get it back indexColumnMenu.jsp | files/WEB-INF/grouperUi2/index/indexColumnMenu.jsp | |
2018/11/02 | grouper_v2_4_0_ui_patch_2 (not released) | GRP-1880: Develop New Template Wizard | classes/edu/internet2/middleware/grouper/grouperUi/beans/ui/GrouperNewServiceTemplateLogic.java |
2018/10/12 | files/WEB-INF/grouperUi2/index/miscellaneous.jsp | ||
2018/11/05 | GRP-1941: LDAP loader - parsing complex attribute values GRP-1877: LDAP_GROUPS_FROM_ATTRIBUTES should utilize extra attributes to construct display name | files/WEB-INF/grouperUi2/group/grouperLoaderEditGroupTab.jsp | |
2018/11/15 | files/WEB-INF/grouperUi2/admin/adminDaemonJobs.jsp | ||
2018/12/07 | classes/edu/internet2/middleware/grouper/grouperUi/serviceLogic/UiV2Admin.java | ||
| WS patches | |||
2018/09/10 | GRP-1892: grouper-ws.base.properties / ws.client.user.group.name no longer commented | classes/grouper-ws.base.properties | |
| PSPNG patches | |||
2018/09/15 | classes/edu/internet2/middleware/grouper/pspng/FullSyncProvisionerFactory.java | ||
2018/11/26 | [Test patch] grouper_v2_4_0_pspng_patch_1 | GRP-1908: Fixes problem with debug-logging private information | classes/edu/internet2/middleware/grouper/pspng/LdapSystem.java |
For more information about upcoming plans, see the Grouper Product Roadmap .
Many other fixes and improvements were also made to all components of the Grouper Toolkit: Grouper API, Administrative & Lite UIs, Grouper Web Services, Grouper Client, Grouper Shell, Grouper Loader, PSP, and the Subject API.
- Grouper upgrade demo server from v2.3 to v2.4
- Install the Grouper v2.4 container with maturity level 0
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
- Make sure you are using Java8/Tomcat8.5
- 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
Convert the ehcache xml file to properties
This is taken care of by the upgrader above. If not, then you can do this manually
- 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 → upgradeTask to convert this file
- Copy the grouper.cache.properties to all envs (prod, test, ui, ws, etc)
Convert the sources.xml to subject.properties
This is taken care of by the upgrader above. If not, then you can do this manually
- Run the grouperInstaller → admin → upgradeTask to convert this file
- Copy the subject.properties to all envs (prod, test, ui, ws, etc)
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. For more details, visit the vt-ldap to ldaptive migration for LDAP access page. Also, try the subject source diagnostics to confirm your configuration.
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.
- If you have a reason to continue using these old UIs, there is an option to manually redeploy them. (Though let us know if there is a missing feature or issue in the New UI.)
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 if you choose to manually redeploy it.
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 new indexes and a new table. The upgrader will automatically add these without requiring a downtime.
Check logs
- Login to your UI, do some WS calls, and check your logs for errors
Internationalization
- if you use internationalization, change grouper.properties
from: grouper.text.bundle.1.fileNamePrefix = grouperText/grouper.text.fr.fr
to: grouper.text.bundle.1.fileNamePrefix = grouperText/grouper.textNg.fr.fr
See Also
See Also
Blog on Grouper Deprovisioning with Grouper 2.4 (September 2018)