You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by "pgj (via GitHub)" <gi...@apache.org> on 2026/08/22 02:04:11 UTC
[PR] chore(`docs`): update the Search installation instructions for Clouseau 3.x [couchdb]
pgj opened a new pull request, #6099:
URL: https://github.com/apache/couchdb/pull/6099
## Overview
Clouseau 3.x has now become the supported version of Search, which works with more recent Java versions, and it features a new configuration syntax. Update the respective part of the installation guide to chase these changes.
## Testing recommendations
Make sure that documentation is enabled for the build and then build it:
```
make docs
```
Once finished, open `src/docs/build/html/install/search.html` and verify the contents of the updated page.
## Checklist
- [x] This is my own work, I did not use AI, LLM's or similar technology
- [ ] Code is written and works correctly
- [ ] Changes are covered by tests
- [ ] Any new configurable parameters are documented in `rel/overlay/etc/default.ini`
- [x] Documentation changes were made in the `src/docs` folder
- [ ] Documentation changes were backported (separated PR) to affected branches
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore(`docs`): update the Search installation instructions for Clouseau 3.x [couchdb]
Posted by "big-r81 (via GitHub)" <gi...@apache.org>.
big-r81 commented on code in PR #6099:
URL: https://github.com/apache/couchdb/pull/6099#discussion_r3835647966
##########
src/docs/src/install/search.rst:
##########
@@ -18,15 +18,13 @@ Search Plugin Installation
.. versionadded:: 3.0
-.. highlight:: ini
-
CouchDB can build and query full-text search indexes using an external Java
service that embeds `Apache Lucene <http://lucene.apache.org>`_. Typically, this
service is installed on the same host as CouchDB and communicates with it over
the loopback network.
-The search plugin is runtime-compatible with Java JDKs 6, 7 and 8. Building a
-release from source requires JDK 6. **It will not work with any newer version of
+The search plugin is runtime-compatible with Java JDKs 21 and later. Building a
+release from source requires JDK 17. **It will not work with any older version of
Review Comment:
Will only a JDK 17 work for building or is it a version >=17 ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore(`docs`): update the Search installation instructions for Clouseau 3.x [couchdb]
Posted by "pgj (via GitHub)" <gi...@apache.org>.
pgj commented on code in PR #6099:
URL: https://github.com/apache/couchdb/pull/6099#discussion_r3839160395
##########
src/docs/src/install/search.rst:
##########
@@ -18,15 +18,13 @@ Search Plugin Installation
.. versionadded:: 3.0
-.. highlight:: ini
-
CouchDB can build and query full-text search indexes using an external Java
service that embeds `Apache Lucene <http://lucene.apache.org>`_. Typically, this
service is installed on the same host as CouchDB and communicates with it over
the loopback network.
-The search plugin is runtime-compatible with Java JDKs 6, 7 and 8. Building a
-release from source requires JDK 6. **It will not work with any newer version of
+The search plugin is runtime-compatible with Java JDKs 21 and later. Building a
+release from source requires JDK 17. **It will not work with any older version of
Review Comment:
The minimum version of Java required there is 17, but the releases are actually built with 21. I changed the old text with the minimum number of edits, but perhaps this could be emphasized better.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore(`docs`): update the Search installation instructions for Clouseau 3.x [couchdb]
Posted by "pgj (via GitHub)" <gi...@apache.org>.
pgj commented on code in PR #6099:
URL: https://github.com/apache/couchdb/pull/6099#discussion_r3839188564
##########
src/docs/src/install/search.rst:
##########
@@ -43,52 +41,43 @@ to the server command below. If clouseau is installed in ``/opt/clouseau`` the l
-classpath '/opt/clouseau/*'
-The service expects to find a couple of configuration files
-conventionally called ``clouseau.ini`` and ``log4j.properties`` with the following
-content:
-
-**clouseau.ini**::
-
- [clouseau]
-
- ; the name of the Erlang node created by the service, leave this unchanged
- name=clouseau@127.0.0.1
+The service expects to find its configuration file conventionally called ``clouseau.conf``
+with the following content:
- ; set this to the same distributed Erlang cookie used by the CouchDB nodes
- cookie=brumbrum
+**clouseau.conf**::
- ; the path where you would like to store the search index files
- dir=/path/to/index/storage
+ config: [
+ {
+ node: {
+ # the name of the Erlang node created by the service, leave this unchanged
+ name: clouseau
+ domain: 127.0.0.1
- ; the number of search indexes that can be open simultaneously
- max_indexes_open=500
+ # set this to the same distributed Erlang cookie used by the CouchDB nodes
+ cookie: brumbrum
+ }
+ clouseau: {
+ # the path where you would like to store the search index files
+ dir: /path/to/index/storage
-**log4j.properties**::
+ # the number of search indexes that can be open simultaneously
+ max_indexes_open: 500
+ }
+ }
+ ]
- log4j.rootLogger=debug, CONSOLE
- log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
- log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
- log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %c [%p] %m%n
-
-Once these files are in place the service can be started with an invocation like
+Once this file is in place the service can be started with an invocation like
the following::
java -server \
-Xmx2G \
-Dsun.net.inetaddr.ttl=30 \
-Dsun.net.inetaddr.negative.ttl=30 \
- -Dlog4j.configuration=file:/path/to/log4j.properties \
-XX:OnOutOfMemoryError="kill -9 %p" \
Review Comment:
In theory, there is [`taskkill`](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/taskkill) for Windows. But I have not used that personally. I can remove that part to make it OS-agnostic or add a comment about this.
Albeit, today I learned that since Java 8u92, there is a dedicated `-XX:+ExitOnOutOfMemoryError` option, which is recommended for this purpose and, as the name suggests, it can exit or crash the JVM internally without needing to call external OS utilities.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore(`docs`): update the Search installation instructions for Clouseau 3.x [couchdb]
Posted by "pgj (via GitHub)" <gi...@apache.org>.
pgj merged PR #6099:
URL: https://github.com/apache/couchdb/pull/6099
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore(`docs`): update the Search installation instructions for Clouseau 3.x [couchdb]
Posted by "big-r81 (via GitHub)" <gi...@apache.org>.
big-r81 commented on code in PR #6099:
URL: https://github.com/apache/couchdb/pull/6099#discussion_r3835651898
##########
src/docs/src/install/search.rst:
##########
@@ -43,52 +41,43 @@ to the server command below. If clouseau is installed in ``/opt/clouseau`` the l
-classpath '/opt/clouseau/*'
-The service expects to find a couple of configuration files
-conventionally called ``clouseau.ini`` and ``log4j.properties`` with the following
-content:
-
-**clouseau.ini**::
-
- [clouseau]
-
- ; the name of the Erlang node created by the service, leave this unchanged
- name=clouseau@127.0.0.1
+The service expects to find its configuration file conventionally called ``clouseau.conf``
+with the following content:
- ; set this to the same distributed Erlang cookie used by the CouchDB nodes
- cookie=brumbrum
+**clouseau.conf**::
- ; the path where you would like to store the search index files
- dir=/path/to/index/storage
+ config: [
+ {
+ node: {
+ # the name of the Erlang node created by the service, leave this unchanged
+ name: clouseau
+ domain: 127.0.0.1
- ; the number of search indexes that can be open simultaneously
- max_indexes_open=500
+ # set this to the same distributed Erlang cookie used by the CouchDB nodes
+ cookie: brumbrum
+ }
+ clouseau: {
+ # the path where you would like to store the search index files
+ dir: /path/to/index/storage
-**log4j.properties**::
+ # the number of search indexes that can be open simultaneously
+ max_indexes_open: 500
+ }
+ }
+ ]
- log4j.rootLogger=debug, CONSOLE
- log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
- log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
- log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %c [%p] %m%n
-
-Once these files are in place the service can be started with an invocation like
+Once this file is in place the service can be started with an invocation like
the following::
java -server \
-Xmx2G \
-Dsun.net.inetaddr.ttl=30 \
-Dsun.net.inetaddr.negative.ttl=30 \
- -Dlog4j.configuration=file:/path/to/log4j.properties \
-XX:OnOutOfMemoryError="kill -9 %p" \
Review Comment:
Does this "kill" work on Windows too? (nothing to do with this commit, only a informational question ;-))
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org