Issue 8584 - reloadhint for syncprov overlay should default to TRUE
Summary: reloadhint for syncprov overlay should default to TRUE
Status: VERIFIED FIXED
Alias: None
Product: OpenLDAP
Classification: Unclassified
Component: documentation (show other issues)
Version: 2.4.44
Hardware: All All
: --- normal
Target Milestone: ---
Assignee: OpenLDAP project
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-02-06 23:54 UTC by Quanah Gibson-Mount
Modified: 2017-06-01 22:12 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Quanah Gibson-Mount 2017-02-06 23:54:26 UTC
Full_Name: Quanah Gibson-Mount
Version: 2.4.44
OS: N/A
URL: ftp://ftp.openldap.org/incoming/
Submission from: (NULL) (47.208.148.26)


The "reloadhint" option for the syncprov overlay currently defaults to FALSE. 
However, the documentation clearly notes that you want to set it to true for any
release > 2.3.11.  Given that 2.3 has been obsolete for years and it has been
over 11 years since the release of 2.3.11, we should really fix the default
value, and note that it should be changed if and only if there is a consumer
running 2.3.11 or prior.
Comment 1 Quanah Gibson-Mount 2017-02-07 01:01:16 UTC
--On Monday, February 06, 2017 11:54 PM +0000 quanah@openldap.org wrote:


> The "reloadhint" option for the syncprov overlay currently defaults to
> FALSE.  However, the documentation clearly notes that you want to set it
> to true for any release > 2.3.11.  Given that 2.3 has been obsolete for
> years and it has been over 11 years since the release of 2.3.11, we
> should really fix the default value, and note that it should be changed
> if and only if there is a consumer running 2.3.11 or prior.

Actually, since it is not a valid configuration scenario to have a 2.4 
provider and a 2.3 consumer, it seems that the configuration option should 
be deprecated entirely, and the internal code simply default to TRUE.

--Quanah


--

Quanah Gibson-Mount
Product Architect
Symas Corporation
Packaged, certified, and supported LDAP solutions powered by OpenLDAP:
<http://www.symas.com>


Comment 2 Howard Chu 2017-02-07 08:53:16 UTC
quanah@openldap.org wrote:
> Full_Name: Quanah Gibson-Mount
> Version: 2.4.44
> OS: N/A
> URL: ftp://ftp.openldap.org/incoming/
> Submission from: (NULL) (47.208.148.26)
>
>
> The "reloadhint" option for the syncprov overlay currently defaults to FALSE.
> However, the documentation clearly notes that you want to set it to true for any
> release > 2.3.11.  Given that 2.3 has been obsolete for years and it has been
> over 11 years since the release of 2.3.11, we should really fix the default
> value, and note that it should be changed if and only if there is a consumer
> running 2.3.11 or prior.

The relevant part of the doc is "It must be set TRUE when using the accesslog 
overlay for delta-based syncrepl support." Otherwise it has no effect, so 
there is no reason to change it in the default case.

-- 
   -- Howard Chu
   CTO, Symas Corp.           http://www.symas.com
   Director, Highland Sun     http://highlandsun.com/hyc/
   Chief Architect, OpenLDAP  http://www.openldap.org/project/

Comment 3 Quanah Gibson-Mount 2017-02-07 17:37:28 UTC
--On Tuesday, February 07, 2017 8:53 AM +0000 Howard Chu <hyc@symas.com> 
wrote:


> The relevant part of the doc is "It must be set TRUE when using the
> accesslog overlay for delta-based syncrepl support." Otherwise it has no
> effect, so there is no reason to change it in the default case.

Actually, what the manpage says is:

This option should be set TRUE when working with
newer releases that properly support this flag. It must  be  set
TRUE  when  using the accesslog overlay for delta-based syncrepl
replication support.

So, that clearly states it should *always* be TRUE unless you have a 2.3.11 
or earlier consumer, which is technically not allowable.  There is zero 
reason for this tunable to exist.  It should be deprecated and the internal 
code changed to simply set the flag to TRUE.  One less item for anyone to 
have to ever deal with is a win.

--Quanah

--

Quanah Gibson-Mount
Product Architect
Symas Corporation
Packaged, certified, and supported LDAP solutions powered by OpenLDAP:
<http://www.symas.com>


Comment 4 Howard Chu 2017-02-07 18:23:06 UTC
Quanah Gibson-Mount wrote:
> --On Tuesday, February 07, 2017 8:53 AM +0000 Howard Chu <hyc@symas.com> wrote:
>
>
>> The relevant part of the doc is "It must be set TRUE when using the
>> accesslog overlay for delta-based syncrepl support." Otherwise it has no
>> effect, so there is no reason to change it in the default case.
>
> Actually, what the manpage says is:
>
> This option should be set TRUE when working with
> newer releases that properly support this flag. It must  be  set
> TRUE  when  using the accesslog overlay for delta-based syncrepl
> replication support.
>
> So, that clearly states it should *always* be TRUE unless you have a 2.3.11 or
> earlier consumer, which is technically not allowable.  There is zero reason
> for this tunable to exist.  It should be deprecated and the internal code
> changed to simply set the flag to TRUE.  One less item for anyone to have to
> ever deal with is a win.

"when working with newer releases that properly support this flag."

The syncrepl consumer only pays attention to this flag in delta-sync. There is 
no reason to use reloadhint in regular syncrepl. Turning it on by default only 
slows down the refresh negotiation in regular syncrepl.

-- 
   -- Howard Chu
   CTO, Symas Corp.           http://www.symas.com
   Director, Highland Sun     http://highlandsun.com/hyc/
   Chief Architect, OpenLDAP  http://www.openldap.org/project/

Comment 5 Quanah Gibson-Mount 2017-02-07 19:19:44 UTC

> On Feb 7, 2017, at 10:25 AM, hyc@symas.com wrote:
> 
> Quanah Gibson-Mount wrote:
>> --On Tuesday, February 07, 2017 8:53 AM +0000 Howard Chu <hyc@symas.com> wrote:
>> 
>> 
>>> The relevant part of the doc is "It must be set TRUE when using the
>>> accesslog overlay for delta-based syncrepl support." Otherwise it has no
>>> effect, so there is no reason to change it in the default case.
>> 
>> Actually, what the manpage says is:
>> 
>> This option should be set TRUE when working with
>> newer releases that properly support this flag. It must  be  set
>> TRUE  when  using the accesslog overlay for delta-based syncrepl
>> replication support.
>> 
>> So, that clearly states it should *always* be TRUE unless you have a 2.3.11 or
>> earlier consumer, which is technically not allowable.  There is zero reason
>> for this tunable to exist.  It should be deprecated and the internal code
>> changed to simply set the flag to TRUE.  One less item for anyone to have to
>> ever deal with is a win.
> 
> "when working with newer releases that properly support this flag."
> 
> The syncrepl consumer only pays attention to this flag in delta-sync. There is 
> no reason to use reloadhint in regular syncrepl. Turning it on by default only 
> slows down the refresh negotiation in regular syncrepl.
> 
> -- 
>   -- Howard Chu
>   CTO, Symas Corp.           http://www.symas.com
>   Director, Highland Sun     http://highlandsun.com/hyc/
>   Chief Architect, OpenLDAP  http://www.openldap.org/project/
> 

Then the man page needs updating since the information on it is blatantly wrong.  The "newer releases" is clearly indicated to be anything later than 2.3.11.

--Quanah
Comment 6 Quanah Gibson-Mount 2017-03-17 16:44:40 UTC
moved from Incoming to Documentation
Comment 7 Quanah Gibson-Mount 2017-03-29 19:52:16 UTC
changed notes
changed state Open to Release
Comment 8 OpenLDAP project 2017-06-01 22:12:38 UTC
Fixed in master
Fixed in RE25
Fixed in RE24 (2.4.45)
Comment 9 Quanah Gibson-Mount 2017-06-01 22:12:38 UTC
changed notes
changed state Release to Closed