You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by to...@apache.org on 2014/07/08 16:49:37 UTC
svn commit: r1608811 - in /jackrabbit/oak/trunk/oak-doc/src/site/markdown:
osgi_config.md query.md
Author: tommaso
Date: Tue Jul 8 14:49:36 2014
New Revision: 1608811
URL: http://svn.apache.org/r1608811
Log:
OAK-1695 - added documentation for Solr index OSGi configuration
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md?rev=1608811&r1=1608810&r2=1608811&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md Tue Jul 8 14:49:36 2014
@@ -234,4 +234,79 @@ need not be specified in config files
[1]: http://docs.mongodb.org/manual/reference/connection-string/
[2]: http://jackrabbit.apache.org/api/2.4/org/apache/jackrabbit/core/data/FileDataStore.html
-[OAK-1645]: https://issues.apache.org/jira/browse/OAK-1645
\ No newline at end of file
+[OAK-1645]: https://issues.apache.org/jira/browse/OAK-1645
+
+### Solr Server Configuration
+Solr index requires some configuration to be properly used, in OSGi environments such configurations can be performed
+via OSGi Configuration Admin.
+
+The following configuration items can be defined (e.g. through Apache Felix WebConsole).
+
+1. Oak Solr indexing / search configuration: Configuration for _OakSolrConfigurationProvider_ service with the following parameters:
+
+ #field for searching for nodes having a certain exact path
+ path.exact.field = path_exact
+
+ #field for searching for nodes descendants of a node with a certain path
+ path.desc.field = path_des
+
+ #field for searching for nodes children of a node with a certain path
+ path.child.field = path_child
+
+ #field for searching for nodes parents of a node with a certain path
+ path.parent.field = path_anc
+
+ #field to be used for searching when no field is defined in the search query (e.g. user entered queries like 'foo bar')
+ catch.all.field = catch_all
+
+ #number of documents per 'page' to be fetched for each query
+ rows = 100000
+
+ #Solr commit policy to be used when indexing nodes as documents in Solr
+ commit.policy = SOFT
+
+ #wether the Solr index should be used also for filtering nodes by path restrictions
+ path.restrictions = false
+
+ #wether the Solr index should be used also for filtering nodes by property restrictions
+ property.restrictions = false
+
+ #wether the Solr index should be used also for filtering nodes by primary type
+ primarytypes.restrictions = false
+
+2. Oak Solr remote server configuration: Configuration for _RemoteSolrServerProvider_ service with the following parameters:
+
+ #URL to connect to a single remote Solr instance, including the core name (e.g. http://10.10.1.107:8983/solr/oak)
+ solr.http.url =
+
+ #Zookeeper host to connect to when using SolrCloud clusters (e.g. 10.10.1.102:9983)
+ solr.zk.host =
+
+ #name ot the Solr collection to use when connecting to a SolrCloud cluster
+ solr.collection = oak
+
+ #number of shards to be used for the collection to be used with SolrCloud
+ solr.shards.no = 2
+
+ #Solr replication factor, no. of replicas to be created for each shard (for each collection) with SolrCloud
+ solr.replication.factor = 2
+
+ #number of documents per 'page' to be fetched for each query
+ solr.conf.dir = directory eventually containing the configuration files to be uploaded for creating the SolrCloud collection
+
+3. Oak Solr embedded server configuration: Configuration for _EmbeddedSolrServerProvider_ service with the following parameters:
+
+ #path to the Solr home directory to be used for starting the EmbeddedSolrServer (can be absolute or relative)
+ solr.home.path = solr
+
+ #name of the Solr core to be created within the EmbeddedSolrServer
+ solr.core.name = oak
+
+ #path to the cores config file to be used for starting Solr
+ solr.config.path = solr.xml
+
+4. Oak Solr server provider: Configuration for _SolrServerProvider_ service with the following parameters:
+
+ #type of Solr server provider to be used, supported types are none, remote (RemoteSolrServerProvider) and embedded (EmbeddedSolrServerProvider)
+ server.type = none
+
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query.md?rev=1608811&r1=1608810&r2=1608811&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query.md Tue Jul 8 14:49:36 2014
@@ -324,6 +324,7 @@ The index definition node for a Solr-bas
* must contain the `async` property set to the value `async`, this is what sends the
index update process to a background thread.
+
_Optionally_ one can add
* the `reindex` flag which when set to `true`, triggers a full content re-index.
@@ -346,14 +347,14 @@ Apache Solr supports multiple deployment
* embedded Solr instance running in the same JVM the client runs into
* single remote instance
* master / slave architecture, eventually with multiple shards and replicas
- * SolrCloud cluster, with Zookeeper instance(s) to control a dynamic, resilient set of Solr instances for high
+ * SolrCloud cluster, with Zookeeper instance(s) to control a dynamic, resilient set of Solr servers for high
availability and fault tolerance
The Oak Solr index can be configured to use an 'embedded Solr server' or either a 'remote Solr server' (being able to
connect to a single remote instance or to a SolrCloud cluster via Zookeeper).
##### OSGi environment
-TODO
+see the 'Solr Server Configuration' section on the [OSGi configuration](osgi_config.html) page
##### non OSGi environment
TODO