Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-15572

Document sunserviceID index needs to be created under certain case

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 5.5.1, 6.0.0.7, 6.5.2
    • Fix Version/s: 6.5.2, 5.5.2
    • Component/s: documentation
    • Labels:
      None
    • Needs backport:
      No
    • Support Ticket IDs:
    • Needs QA verification:
      No
    • Functional tests:
      No
    • Are the reproduction steps defined?:
      No (add reasons in the comment)

      Description

      Bug description

      Document sunserviceID index needs to be created under certain case

      How to reproduce the issue

      Please refer to the details on OPENAM-14271 and OPENAM-15406.
      Basically, when there are thousands of OAuth2 clients or any Agents registered, you will receive error around sunserviceID. It needs to be documented that users need to index sunserviceID when there are large number of OAuth2 clients or any Agents registered on their system.

      1. AM 5.0.0 Amster export

      [06/Sep/2017:09:55:40 +0800] SEARCH REQ conn=7 op=123 msgID=124 base="ou=default,ou=OrganizationConfig,ou=1.0,ou=sunFMSAML2MetadataService,ou=services,dc=openam,dc=forgerock,dc=org" scope=one filter="(&(&(objectclass=top)(ou=*))(&(objectclass=top)(sunserviceID=EntityDescriptor)))" attrs="o"
       [06/Sep/2017:09:55:40 +0800]
      SEARCH RES conn=7 op=123 msgID=124 result=12 message="The search results cannot be sorted because the given search request is not indexed" nentries=0 unindexed etime=16
      

      2. AM 6.0.0.0.x upgrades

      [17/Jan/2019:12:51:37 +1300] SEARCH REQ conn=1968337 op=5411 msgID=5412 base="ou=default,ou=OrganizationConfig,ou=1.0,ou=AgentService,ou=services,o=xxxx,ou=services,dc=openam,dc=xxx,dc=xxx,dc=xx" scope=one filter="(&(&(objectclass=top)(ou=*))(&(objectclass=top)(sunserviceID=WebAgent)))" attrs="o"
      [17/Jan/2019:12:51:37 +1300] SEARCH RES conn=1968337 op=5411 msgID=5412 result=12 message="The search results cannot be sorted because the given search request is not indexed" nentries=0 unindexed etime=123
      
      Expected behaviour
      Users to be able to refer to document for existing problem and how to solve it.
      
      Current behaviour
      no document
      

      Possible Work around

      # create a index for sunserviceID
      dsconfig \
       create-backend-index \
       --hostname localhost \
       --port 24444 \
       --bindDN "cn=Directory Manager" \
       --bindPassword password \
       --backend-name userRoot \
       --index-name sunserviceID \
       --set index-type:equality \
       --trustAll \
       --no-prompt
      
      # increase the search limit to be 10000 <=== you may need to increase this higher 
      dsconfig \
       set-backend-index-prop \
       --hostname localhost \
       --port 24444 \
       --bindDN "cn=Directory Manager" \
       --bindPassword password \
       --backend-name userRoot \
       --index-name sunserviceID \
       --set index-entry-limit:10000 \
       --no-prompt \
       --trustAll
      
      # rebuild index 
      rebuild-index \
       --hostname localhost \
       --port 24444 \
       --bindDN "cn=Directory Manager" \
       --bindPassword password \
       --baseDN dc=openam,dc=forgerock,dc=org \
       --index sunserviceID \
       --start 0 \
       --trustAll
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                dom Dom Reed
                Reporter:
                sachiko Sachiko Wallace
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: