[ 
https://issues.apache.org/jira/browse/SOLR-18100?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

ilariapet updated SOLR-18100:
-----------------------------
    Description: 
I investigated the Combined Query feature to write a blog post about it, and I 
found a few aspects of the documentation that, are unclear and should be 
improved (I can take care of addressing them).

In particular:

*Configuration section*
The part that explains the configuration is not very clear. 
{{maxCombinerQueries}} is a parameter that must be specified in the 
{{{}searchComponent{}}}, not in the handler.
The search component is shown only to explain the custom algorithm part, so it 
is not obvious that it is mandatory even when using the default algorithm. 
Otherwise, a {{NullPointerException}} is thrown.

*Solr Standalone - Distributed Search*
As explained here 
([https://solr.apache.org/guide/solr/latest/deployment-guide/user-managed-distributed-search.html#allowurls-parameter])
 {{allowUrls}} is automatically configured for SolrCloud, but it requires 
explicit configuration for user-managed setups.

Therefore, when executing the combined query *without* starting Solr with:
{code:java}
--jvm-opts "-Dsolr.security.allow.urls=http://localhost:8983/solr/"; {code}
the following error is returned:
{code:java}
"errorClass": "org.apache.solr.common.SolrException",
"msg": "The 'shards' parameter value 'http://localhost:8983/solr/test' 
contained value(s) not allowed: URL http://localhost:8983/solr/test is neither 
a live node of the cluster nor in the configured 'allowUrls' []. Set 
-Dsolr.security.allow.urls.enabled=false to disable URL allow-list 
checks."{code}
This should be explicitly mentioned in the documentation.

*Custom plugin section*
This section is not detailed enough to clearly explain how it should be used, 
especially for users who are not experienced with Solr and do not want to dig 
into the internal implementation.

  was:
I investigated the Combined Query feature to write a blog post about it, and I 
found a few aspects of the documentation that, are unclear and should be 
improved (I can take care of addressing them).

In particular:

*Configuration section*
The part that explains the configuration is not very clear. 
{{maxCombinerQueries}} is a parameter that must be specified in the 
{{{}searchComponent{}}}, not in the handler.
The search component is shown only to explain the custom algorithm part, so it 
is not obvious that it is mandatory even when using the default algorithm. 
Otherwise, a {{NullPointerException}} is thrown.

*Solr Standalone - Distributed Search*
As explained here 
([https://solr.apache.org/guide/solr/latest/deployment-guide/user-managed-distributed-search.html#allowurls-parameter])
 {{allowUrls}} is automatically configured for SolrCloud, but it requires 
explicit configuration for user-managed setups.

Therefore, when executing the combined query *without* starting Solr with:
{code:java}
--jvm-opts "-Dsolr.security.allow.urls=http://localhost:8983/solr/"; {code}
the following error is returned:
{code:java}
"errorClass": "org.apache.solr.common.SolrException",
"msg": "The 'shards' parameter value 'http://localhost:8983/solr/test' 
contained value(s) not allowed: URL http://localhost:8983/solr/test is neither 
a live node of the cluster nor in the configured 'allowUrls' []. Set 
-Dsolr.security.allow.urls.enabled=false to disable URL allow-list 
checks."{code}
This should be explicitly mentioned in the documentation.

*Custom plugin section*
The section about the custom plugin is not detailed enough to clearly explain 
how it should be used, especially for users who are not experienced with Solr 
and do not want to dig into the internal implementation.


> Improve Combined Query Feature Documentation 
> ---------------------------------------------
>
>                 Key: SOLR-18100
>                 URL: https://issues.apache.org/jira/browse/SOLR-18100
>             Project: Solr
>          Issue Type: Improvement
>          Components: vector-search
>            Reporter: ilariapet
>            Priority: Minor
>
> I investigated the Combined Query feature to write a blog post about it, and 
> I found a few aspects of the documentation that, are unclear and should be 
> improved (I can take care of addressing them).
> In particular:
> *Configuration section*
> The part that explains the configuration is not very clear. 
> {{maxCombinerQueries}} is a parameter that must be specified in the 
> {{{}searchComponent{}}}, not in the handler.
> The search component is shown only to explain the custom algorithm part, so 
> it is not obvious that it is mandatory even when using the default algorithm. 
> Otherwise, a {{NullPointerException}} is thrown.
> *Solr Standalone - Distributed Search*
> As explained here 
> ([https://solr.apache.org/guide/solr/latest/deployment-guide/user-managed-distributed-search.html#allowurls-parameter])
>  {{allowUrls}} is automatically configured for SolrCloud, but it requires 
> explicit configuration for user-managed setups.
> Therefore, when executing the combined query *without* starting Solr with:
> {code:java}
> --jvm-opts "-Dsolr.security.allow.urls=http://localhost:8983/solr/"; {code}
> the following error is returned:
> {code:java}
> "errorClass": "org.apache.solr.common.SolrException",
> "msg": "The 'shards' parameter value 'http://localhost:8983/solr/test' 
> contained value(s) not allowed: URL http://localhost:8983/solr/test is 
> neither a live node of the cluster nor in the configured 'allowUrls' []. Set 
> -Dsolr.security.allow.urls.enabled=false to disable URL allow-list 
> checks."{code}
> This should be explicitly mentioned in the documentation.
> *Custom plugin section*
> This section is not detailed enough to clearly explain how it should be used, 
> especially for users who are not experienced with Solr and do not want to dig 
> into the internal implementation.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to