pgj commented on code in PR #4835:
URL: https://github.com/apache/couchdb/pull/4835#discussion_r1389623756
##########
README-DEV.rst:
##########
@@ -272,6 +266,50 @@ to keep those databases around for further investigation::
MANGO_TESTS_KEEP_DBS=please \
make mango-test MANGO_TEST_OPTS='03-operator-test'
+Running Clouseau
+~~~~~~~~~~~~~~~~
+
+When configured with the ``./configure`` script, the ``dev/run``
Review Comment:
Yes, that would make the text consistent with other instances.
##########
README-DEV.rst:
##########
@@ -272,6 +266,50 @@ to keep those databases around for further investigation::
MANGO_TESTS_KEEP_DBS=please \
make mango-test MANGO_TEST_OPTS='03-operator-test'
+Running Clouseau
+~~~~~~~~~~~~~~~~
+
+When configured with the ``./configure`` script, the ``dev/run``
+script is capable of launching Clouseau instances alongside the
+CouchDB nodes and hooking them up. This is what the ``mango-test``
+and ``elixir-search`` targets also use to run their respective test
+suites and let Clouseau automatically managed for them.
+
+Although the ``./configure`` and the ``dev/run`` scripts try to take
+care of the details of the Clouseau deployment, it is still the
+responsibility of the user to provide a suitable Java environment for
+running. Clouseau can run with JDK 1.7 and 1.8 only. Also, when
+Nouveau is in use, which uses a more recent Java environment, the old
+JDK has to be installed separately and the ``CLOUSEAU_JAVA_HOME``
+environment variable has to be set to point its location.
+
+Fortunately, the ```asdf`` tool <https://asdf-vm.com/>` provides a
+convenient way to install old versions of JDK through its ```java``
+plugin <https://github.com/halcyon/asdf-java>`::
+
+ asdf plugin add java
+
+Then use ``asdf`` to install it::
+
+ asdf install java zulu-8.74.0.17
+
+Finally, use ``asdf`` to set the ``CLOUSEAU_JAVA_HOME`` environment
+variable::
+
+ export CLOUSEAU_JAVA_HOME=$(asdf where java zulu-8.74.0.17)
+
+If the use of ``asdf`` is not an option, `the Zulu site
+<https://cdn.azul.com/zulu/bin/>` could be used directly to get the
+distribution package for the appropriate JDK version. But this is
+just one of the possibilities to access installers for old Java
+environments.
+
+Once both Clouseau and the corresponding Java environment are set,
+they are not put in use automatically. In order to do so, the
+``dev/run`` script needs to be run with Clouseau enabled as follows::
Review Comment:
Right.
--
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-unsubscr...@couchdb.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
