Bug 1148064

Summary:	QueryGuide: indexLocalOnly="true" with RAM directory provider
Product:	[JBoss] JBoss Data Grid 6	Reporter:	Radim Vansa <rvansa>
Component:	Documentation	Assignee:	jdg-docs <jdg-docs>
Status:	CLOSED WONTFIX	QA Contact:	Radim Vansa <rvansa>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	6.3.1	CC:	jdg-bugs, rvansa, ttarrant
Target Milestone:	Post GA
Target Release:	6.4.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:
Clones:	1148686 (view as bug list)		Environment:
Last Closed:	2020-09-16 06:05:08 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:	1148686
Bug Blocks:

Description Radim Vansa 2014-09-30 15:45:45 UTC

In https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Data_Grid/6.3/html/Infinispan_Query_Guide/sect-Configure_Indexing.html in Example 2.3 indexLocalOnly is set to true.

While in this particular configuration the setting works (default cache is local and therefore indexLocalOnly does not affect anything), it may be confusing for users who reuse that configuration in replicated cache.

Please, remove this attribute at all.

Also, in Example 2.4 remove line

 .indexLocalOnly(true)

In Example 2.5, change <indexing index="LOCAL"> to <indexing index="ALL">

Comment 2 Divya Mehra 2014-09-30 15:59:53 UTC

We need Need to simplify the indexing configuration - remove variables that do not provide much value, just increase chances of a customer making an error in configuration.

Comment 3 Radim Vansa 2014-10-01 08:40:18 UTC

Divya, this is a documentation bug BZ. Please move any discussion about indexing configuration into separate BZ.

Comment 4 Divya Mehra 2014-10-01 08:43:37 UTC

Radim, the underlying issues is not that of Documentation, but of the default value of indexLocalOnly, which should be false for any clustered cache (and user should not have to specifically set this value). 

So I would suggest that QE open a separate BZ accordingly.

Comment 5 Misha H. Ali 2014-10-01 23:10:18 UTC

Thanks for logging this bug, Radim. I have one other minor bug that I will be pushing as a 6.3.1 patch and this bug looks like a good candidate for a 6.3.1 patch as well. I'll fix it up ASAP and request review so we can push it live ASAP.

Comment 7 Divya Mehra 2014-10-02 05:58:20 UTC

We can't just remove this from documentation until the product's default behavior is correct across cache configurations - local, replicated, distributed cache - so that we would not require this extra variable any more.

Is there a similar tracking BZ for product?
Only after that is verified can we revise Documentation.

Comment 8 Radim Vansa 2014-10-02 09:03:55 UTC

Misha: no, that's not correct. Any configuration using Infinispan directory provider, as in

http://docbuilder.usersys.redhat.com/22937/#Infinispan_Directory_Provider
http://docbuilder.usersys.redhat.com/22937/#Tuning_Infinispan_Directory

needs to have this flag set. Please, return the flag in those configurations.

Comment 9 Radim Vansa 2014-10-02 09:11:31 UTC

(In reply to Divya Mehra from comment #4)
> Radim, the underlying issues is not that of Documentation, but of the
> default value of indexLocalOnly, which should be false for any clustered
> cache (and user should not have to specifically set this value). 
> 
> So I would suggest that QE open a separate BZ accordingly.

The documentation states how the flag should be set in which configuration. IndexLocalOnly must not be false for clustered cache that shares the state across cluster, such as Infinispan directory does.

I have opened https://bugzilla.redhat.com/show_bug.cgi?id=1148740 for further discussion.

Comment 14 Mike McCune 2016-03-28 22:45:31 UTC

This bug was accidentally moved from POST to MODIFIED via an error in automation, please see mmccune with any questions