s3:mdssvc: add Elasticsearch backend

Signed-off-by: Ralph Boehme <slow@samba.org>
Reviewed-by: Noel Power <noel.power@suse.com>

7 files changed, 91 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/misc/elasticsearchaddress.xml b/docs-xml/smbdotconf/misc/elasticsearchaddress.xml
new file mode 100644
index 00000000000..61125461a91
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchaddress.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="elasticsearch:address"
+                 context="S"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Specifies the name of the Elasticsearch server to use for Spotlight
+      queries when using the Elasticsearch backend.
+    </para>
+  </description>
+
+  <value type="default">localhost</value>
+  <value type="example">needle.haystack.samba.org</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/elasticsearchindex.xml b/docs-xml/smbdotconf/misc/elasticsearchindex.xml
new file mode 100644
index 00000000000..7f394b264f8
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchindex.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="elasticsearch:index"
+                 context="S"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Specifies the name of the Elasticsearch index to use for Spotlight queries
+      when using the Elasticsearch backend. The default value of "_all" is a
+      special Elasticsearch value that performs the search operation on all
+      indices.
+    </para>
+  </description>
+
+  <value type="default">_all</value>
+  <value type="example">spotlight</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/elasticsearchmappings.xml b/docs-xml/smbdotconf/misc/elasticsearchmappings.xml
new file mode 100644
index 00000000000..d2502a6fc3b
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchmappings.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="elasticsearch:mappings"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Path to a file specifying metadata attribute mappings in JSON format. Use
+      by the Elasticsearch backend of the Spotlight RPC service.
+    </para>
+  </description>
+
+  <value type="default">&pathconfig.SAMBA_DATADIR;/elasticsearch_mappings.json</value>
+  <value type="example">/usr/share/foo/mymappings.json</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/elasticsearchmaxresults.xml b/docs-xml/smbdotconf/misc/elasticsearchmaxresults.xml
new file mode 100644
index 00000000000..1086b898ed8
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchmaxresults.xml
@@ -0,0 +1,15 @@
+<samba:parameter name="elasticsearch:max results"
+                 context="S"
+                 type="integer"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Path to a file specifying metadata attribute mappings in JSON format. Used
+      by the Elasticsearch backend of the Spotlight RPC service. A value of 0
+      means no limit.
+    </para>
+  </description>
+
+  <value type="default">100</value>
+  <value type="example">10</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/elasticsearchport.xml b/docs-xml/smbdotconf/misc/elasticsearchport.xml
new file mode 100644
index 00000000000..ea87daabc28
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchport.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="elasticsearch:port"
+                 context="S"
+                 type="integer"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Specifies the TCP port of the Elasticsearch server to use for Spotlight
+      queries when using the Elasticsearch backend.
+    </para>
+  </description>
+
+  <value type="default">9200</value>
+  <value type="example">9201</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/elasticsearchusetls.xml b/docs-xml/smbdotconf/misc/elasticsearchusetls.xml
new file mode 100644
index 00000000000..e1aa8a31495
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchusetls.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="elasticsearch:use tls"
+                 context="S"
+                 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Specifies whether to use HTTPS when talking to the Elasticsearch server
+      used for Spotlight queries when using the Elasticsearch backend.
+    </para>
+  </description>
+
+  <value type="default">no</value>
+  <value type="example">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/spotlight_backend.xml b/docs-xml/smbdotconf/misc/spotlight_backend.xml
index 6d224b81e5f..0643fc16cbd 100644
--- a/docs-xml/smbdotconf/misc/spotlight_backend.xml
+++ b/docs-xml/smbdotconf/misc/spotlight_backend.xml
@@ -19,6 +19,10 @@
 	Gnome Tracker.
 	</para></listitem>
 
+	<listitem><para><constant>elasticsearch</constant> -
+	a backend that uses JSON and REST over HTTP(s) to query an
+	Elasticsearch server.
+	</para></listitem>
 	</itemizedlist>
 	</para>
 </description>