DocumentationAEM Pattern Detection

UMI umi

Last update: Wed May 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

Upgrade Misconfiguration Issue

Background background

UMI Identifies modifications to certain OSGi configurations that cause issues when upgrading, including a failed upgrade or reduced functionality.

The following configurations are checked for modification:

  • org.apache.jackrabbit.oak.security.user.RandomAuthorizableNodeName
  • org.apache.jackrabbit.oak.security.internal.SecurityProviderRegistration.requiredServicePids
  • org.apache.sling.engine.impl.auth.SlingAuthenticator
  • org.apache.sling.scripting.java.impl.JavaScriptEngineFactory
  • com.day.cq.commons.impl.ExternalizerImpl
  • org.apache.sling.commons.log.LogManager.factory.config : Identify whether the org.apache.sling.commons.log.file property of the custom loggers is pointing to something other than logs/error.log file.

Possible implications and risks implications-and-risks

  • Changing or removing configurations may cause the following issues:

    • Upgrade may get stuck (for example org.apache.jackrabbit.oak.security.user.RandomAuthorizableNodeName was missing but present in org.apache.jackrabbit.oak.security.internal.SecurityProviderRegistration.requiredServicePids).
    • Authorization issues may come after upgrade (org.apache.sling.engine.impl.auth.SlingAuthenticator).
    • Certain functionality may not work as expected. For example changing org.apache.sling.scripting.java.impl.JavaScriptEngineFactory may result in some JSP files not being compiled, which ultimately results in loss of functionality.
    • The values of the Externalizer config com.day.cq.commons.impl.ExternalizerImpl are set with cloud manager environment variables in AEM as a Cloud Service.
    • AEM as a Cloud Services does not support custom log files. Logs written to custom-named logs are not accessible from AEM as a Cloud Service.

Possible solutions solutions

  • Do not change or remove the four configurations mentioned above.
    • If there is the following violation:
      “Required properties for the OSGi configuration xyz-configuration are missing: ‘[property-1,property-2…]’.”
      Confirm if these deletions are legitimate or not because these OSGI configurations are OOTB and might have never been modified/saved from the OSGi Config Manager.
  • If configurations have been changed, they should be restored to their expected values. These values are indicated in the UMI messages.
  • For com.day.cq.commons.impl.ExternalizerImpl, see documentation for setting Externalizer config using cloud manager environment variables in AEM as a Cloud Service.
  • For org.apache.sling.commons.log.LogManager.factory.config, Change the OSGI configuration to send the customized logger to the logs/error.log file. See documentation for repointing to the logs/error.log file.
  • Contact the AEM Support Team for clarifications or to have concerns addressed.
recommendation-more-help
c50d24a5-718e-4110-a484-b335e8a63206