Upgrade documentation

[Baron Fujimoto]

I've recently worked through an upgrade from 6.3 to 6.5. I tried to follow the procedure as advised in the CAS Upgrade Guides

<https://apereo.github.io/cas/development/planning/Upgrade-Guide.html>

Although I was eventually successful, I did hit a temporary stumbling block where the gradle tasks were initially failing with "error: release version 11 not supported". Apparently, for our RHEL 7 systems at least, we also now require java-11-openjdk-devel (and a restart of gradleDaemon if it's already running), which resolves this. This was not previously required, and I did not find this in the guides

I also found myself having to resolve logged warnings and errors after my initial upgrade attempts. These mainly stemmed from cas property names that changed between releases. I stepped through each of the changelogs though, and far as I can tell though, none of the property name changes or differences were mentioned. Did I miss them somewhere? What's the recommended best way to identify such property changes between releases?

Making things further more difficult, is that I can't seem to find general cas.properties documentation for 6.5. For previous versions, such as 6.3, they could usually be found collectively somewhere like <https://apereo.github.io/cas/6.3.x/configuration/Configuration-Properties.html>, but I can't find the equivalent for 6.5. The logged errors and warnings fell into three types: failed to bind properties, configuration keys that have been renamed, and configuration keys that are no longer supported. I eventually managed to find enough documentation to resolve all of them except for one involving:

cas.authn.ldap[0].providerclass = org.ldaptive.provider.unboundid.UnboundIDProvider

Although I was able to resolve the error by removing the specific property (I assume it was deprecated?), I still have not been able to find the documentation for the ldap properties in general, so I kind of feel like I just got lucky here. Where/how would I find them in the current documentation?

For that matter, what's the recommended best way to find this sort of documentation for CAS properties in general now?

--

Baron Fujimoto <ba...@hawaii.edu> ::: UH Information Technology Services
minutas cantorum, minutas balorum, minutas carboratum descendus pantorum

[Petr Fišer]

Hello,
As for the properties, this is what you are looking for (use the branch/tag you need). https://raw.githubusercontent.com/apereo/cas-overlay-template/master/etc/cas/config/cas.properties
When you start up CAS with some property it does not understand, it will tell you in the log, as you found out. I consider it very nice feature, even if it means that for making thing right, I have to iterate through the configs for a while.

Cheers,
Fiisch

--
- Website: https://apereo.github.io/cas
- Gitter Chatroom: https://gitter.im/apereo/cas
- List Guidelines: https://goo.gl/1VRrw7
- Contributions: https://goo.gl/mh7qDG
---
You received this message because you are subscribed to the Google Groups "CAS Community" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cas-user+u...@apereo.org.
To view this discussion on the web visit https://groups.google.com/a/apereo.org/d/msgid/cas-user/CAAjLUL1ehEZ7bEgtL9dPFVa3u--N5jj6x9pWBEbiqUQy%2B9n_VA%40mail.gmail.com.

[Baron Fujimoto]

Ah, thanks for the pointer to the sample cas.properties file in cas-overlay-template! I had searched the cas-6.5.2 source but didn't find it there, so that's very helpful.

I do appreciate that the problems with the properties are well logged since it does make it easier to identify them, but that alone doesn't tell you how to fix the problem. It seems reasonable to specifically identify such property changes in the change logs since these are specifically the types of changes that tend to break configs. Or at least have the upgrade guides be more specific about how to identify these property changes.

There also still remains the issue of the difficulty finding actual official documentation of these properties (e.g. ldap, from the original post).

[Baron Fujimoto]

For the sake of posterity, I leaned of the command "gradlew exportConfigMetadata" where,  "The exportConfigMetadata task can be quite useful as it produces a comprehensive catalog of all CAS settings that one could potentially use, along with documentation for each setting, default values, and more."

<https://fawnoos.com/2022/03/04/cas65-gettingstarted-overlay/#gradle-tasks>. 

FWIW, I'm still not sure where you would find equivalent info in the official CAS docs.