Bug 1465947

Summary: [DS 10.1.1] Document the behavior of plugin nsslapd-pluginargs and friendly config names in the console
Product: Red Hat Directory Server Reporter: mreynolds
Component: Doc-release-notesAssignee: Marc Muehlfeld <mmuehlfe>
Status: CLOSED CURRENTRELEASE QA Contact: Viktor Ashirov <vashirov>
Severity: unspecified Docs Contact: Marc Muehlfeld <mmuehlfe>
Priority: unspecified    
Version: 10.1CC: mmuehlfe, mreynolds, rhel-docs
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Known Issue
Doc Text:
In Red Hat Directory Server 10, you can configure certain plug-ins, such as *Attribute Uniqueness* and "Referential Integrity*, using either the new plug-in configuration parameters or the old-style "nsslapd-pluginarg*" parameters. If both parameters types are present in the plug-in configuration, the new configuration parameters take precedence and the old plug-in argument style parameters are ignored. To avoid problems, Red Hat recommends using the *Advanced Editor* in the Directory Server Console to configure a plug-in's arguments. For further details, see https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/using-ds-plugins#configuring_plug-ins
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-08-10 07:34:59 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1466653, 1473373    
Bug Blocks:    

Description mreynolds 2017-06-28 13:54:31 UTC
https://bugzilla.redhat.com/show_bug.cgi?id=1459840

In DS 10 we introduced "friendly" plugin configuration attribute names to replace nsslapd-pluginargs# for a few plugins.  The server still accepts the plugin args, but if the new friendly attributes are being used they will override the nsslapd-pluginargs.

So if the plugin is already using the new attributes, and a user updates the nsslapd-plugins args in the console then those changes are actually silently ignored.  This behavior is discussed in this doc for example:

http://www.port389.org/docs/389ds/design/ri-plugin-configuration.html


The admin guide should discourage the use of plugins arguments in the console for these two plugins below, instead we should use the "advanced editor" to set the new "friendly names":


[1]  Attribute uniqueness plugin

This information is correct:

https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/managing_attributes_and_values#Using_the_Attribute_Uniqueness_Plug_in-Attribute_Uniqueness_Plug-in_Variables

http://www.port389.org/docs/389ds/howto/howto-uid-uniqueness.html

This is outdated:

https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/managing_attributes_and_values#Configuring_Attribute_Uniqueness_Plug_ins-Configuring_Attribute_Uniqueness_Plug_ins_from_the_DS_Console

Now this link below does use the new names, but not in the link above:

https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/managing_attributes_and_values#Configuring_Attribute_Uniqueness_Plug_ins-Configuring_Attribute_Uniqueness_Plug_ins_from_the_Command_Line


[2]  Referential Integrity plugin

https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/creating_directory_entries-maintaining_referential_integrity#Modifying_the_Attribute_List-console

https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/creating_directory_entries-maintaining_referential_integrity#Maintaining_Referential_Integrity-Modifying_the_Update_Interval

Some of this needs to be cleaned up, but not all:

https://access.redhat.com/documentation/en-us/red_hat_directory_server/10/html/administration_guide/creating_directory_entries-maintaining_referential_integrity#Maintaining_Referential_Integrity-Modifying_the_Attribute_List

These should really reference:

http://www.port389.org/docs/389ds/design/ri-plugin-configuration.html

Comment 1 mreynolds 2017-06-28 13:57:23 UTC
Actually this bug is two parts:

[1]  Release notes - we should state that the "friendly names" override the nsslapd-pluginargsN, and that the console's "Advanced editor" should be used for RI and attr uniqueness plugins.

[2]  Admin guide should be cleaned up as mentioned in the bug description above.

Comment 2 Marc Muehlfeld 2017-06-30 07:26:27 UTC
I created BZ#1466653 to create a general section in the DS Admin Guide about configuring plug-ins. It will include the recommendation to use the Advanced Editor. This section I will then additionally link from the Release Note.

Comment 4 Marc Muehlfeld 2017-07-27 15:28:48 UTC
Attribute Uniqueness plug-in:
I rewrote the whole section: I work on this in BZ#1473373
It's currently on SME review (tbordaz).

Comment 7 Marc Muehlfeld 2017-08-10 07:34:59 UTC
The update is now available on the Customer Portal.

Comment 8 Marc Muehlfeld 2017-08-30 12:52:54 UTC
*** Bug 1471716 has been marked as a duplicate of this bug. ***