JIRA Upgrade Fails due to osuser.xml configuration

Legacy Information

This article is applicable to 4.3 and earlier versions of Jira. osuser.xml is no longer used to connect to directories in later verisons.

Symptoms

JIRA fails to upgrade. The following error messages are reported in the JIRA log file:

Upgrade Error: JIRA is unable to migrate the User Directory configuration because the osuser.xml file does not contain a recognized configuration.
...

and accessing JIRA trough browser show the following message:

Cause

There are two causes of this issue due to JIRA limitations:

  1. JRASERVER-24161 - osuser.xml migration fails if multiple ldap repositories defined
  2. JRASERVER-29071 - Upgrade Failed due to Internal Directory is excluded from osuser.xml

Workaround

Workaround for JRASERVER-24161 - osuser.xml migration fails if multiple ldap repositories defined:

  1. Copy osuser.xml to the new 4.3.* instance by following Upgrade Instructions.
    1. This file is located in JIRA_INSTALL/atlassian-jira/WEB-INF/classes

  2. Edit osuser.xml. Remove additional repositories and make sure there is only one LDAP repository left.
    (info) Make sure that after the upgrade there still exists an administrative account that can log in (i.e., ensure there is a member of jira-administrators in the local directory or keep an LDAP directory containing a member of jira-administrators).
  3. Follow Connecting to an LDAP Directory to add the missing LDAP connections as a full LDAP directory. The system will pull all the users and groups into JIRA.

Workaround for JRASERVER-29071 - Upgrade Failed due to Internal Directory is excluded from osuser.xml

  1. Copy osuser.xml to the new 4.3.* instance by following Upgrade Instructions.
  2. Edit osuser.xml and add internal repositories into the problematic osuser.xml and re-run the upgrade process:
  <provider class="com.atlassian.jira.user.osuser.JiraOFBizCredentialsProvider">
        <property name="exclusive-access">true</property>
    </provider>
 
    <provider class="com.atlassian.jira.user.osuser.JiraOFBizProfileProvider">
        <property name="exclusive-access">true</property>
    </provider>
 
    <provider class="com.atlassian.jira.user.osuser.JiraOFBizAccessProvider">
        <property name="exclusive-access">true</property>
    </provider>
</opensymphony-user>

(info) Please see our Troubleshooting LDAP User Management documentation for further assistance with diagnosing LDAP problems.

Last modified on Jan 30, 2025

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.