[REF] queue_job: documentation cleanup

Author: RLeeOSI

queue_job/jobrunner/runner.py

@@ -16,111 +16,7 @@
 * It maintains an in-memory priority queue of jobs that
   is populated from the queue_job tables in all databases.
 * It does not run jobs itself, but asks Odoo to run them through an
-  anonymous ``/queue_job/runjob`` HTTP request. [1]_
-
-How to use it?
---------------
-
-* Optionally adjust your configuration through environment variables:
-
-  - ``ODOO_QUEUE_JOB_CHANNELS=root:4`` (or any other channels
-    configuration), default ``root:1``.
-  - ``ODOO_QUEUE_JOB_SCHEME=https``, default ``http``.
-  - ``ODOO_QUEUE_JOB_HOST=load-balancer``, default ``http_interface``
-    or ``localhost`` if unset.
-  - ``ODOO_QUEUE_JOB_PORT=443``, default ``http_port`` or 8069 if unset.
-  - ``ODOO_QUEUE_JOB_HTTP_AUTH_USER=jobrunner``, default empty.
-  - ``ODOO_QUEUE_JOB_HTTP_AUTH_PASSWORD=s3cr3t``, default empty.
-  - ``ODOO_QUEUE_JOB_JOBRUNNER_DB_HOST=master-db``, default ``db_host``
-    or ``False`` if unset.
-  - ``ODOO_QUEUE_JOB_JOBRUNNER_DB_PORT=5432``, default ``db_port``
-    or ``False`` if unset.
-  - ``ODOO_QUEUE_JOB_JOBRUNNER_DB_USER=userdb``, default ``db_user``
-    or ``False`` if unset.
-  - ``ODOO_QUEUE_JOB_JOBRUNNER_DB_PASSWORD=passdb``, default ``db_password``
-    or ``False`` if unset.
-
-* Alternatively, configure the channels through the Odoo configuration
-  file, like:
-
-.. code-block:: ini
-
-  [queue_job]
-  channels = root:4
-  scheme = https
-  host = load-balancer
-  port = 443
-  http_auth_user = jobrunner
-  http_auth_password = s3cr3t
-  jobrunner_db_host = master-db
-  jobrunner_db_port = 5432
-  jobrunner_db_user = userdb
-  jobrunner_db_password = passdb
-
-* Or, if using ``anybox.recipe.odoo``, add this to your buildout configuration:
-
-.. code-block:: ini
-
-  [odoo]
-  recipe = anybox.recipe.odoo
-  (...)
-  queue_job.channels = root:4
-  queue_job.scheme = https
-  queue_job.host = load-balancer
-  queue_job.port = 443
-  queue_job.http_auth_user = jobrunner
-  queue_job.http_auth_password = s3cr3t
-
-* Start Odoo with ``--load=web,web_kanban,queue_job``
-  and ``--workers`` greater than 1 [2]_, or set the ``server_wide_modules``
-  option in The Odoo configuration file:
-
-.. code-block:: ini
-
-  [options]
-  (...)
-  workers = 4
-  server_wide_modules = web,web_kanban,queue_job
-  (...)
-
-* Or, if using ``anybox.recipe.odoo``:
-
-.. code-block:: ini
-
-  [odoo]
-  recipe = anybox.recipe.odoo
-  (...)
-  options.workers = 4
-  options.server_wide_modules = web,web_kanban,queue_job
-
-* Confirm the runner is starting correctly by checking the odoo log file:
-
-.. code-block:: none
-
-  ...INFO...queue_job.jobrunner.runner: starting
-  ...INFO...queue_job.jobrunner.runner: initializing database connections
-  ...INFO...queue_job.jobrunner.runner: queue job runner ready for db <dbname>
-  ...INFO...queue_job.jobrunner.runner: database connections ready
-
-* Create jobs (eg using base_import_async) and observe they
-  start immediately and in parallel.
-
-* Tip: to enable debug logging for the queue job, use
-  ``--log-handler=odoo.addons.queue_job:DEBUG``
-
-Caveat
-------
-
-* After creating a new database or installing queue_job on an
-  existing database, Odoo must be restarted for the runner to detect it.
-
-.. rubric:: Footnotes
-
-.. [1] From a security standpoint, it is safe to have an anonymous HTTP
-       request because this request only accepts to run jobs that are
-       enqueued.
-.. [2] It works with the threaded Odoo server too, although this way
-       of running Odoo is obviously not for production purposes.
+  anonymous ``/queue_job/runjob`` HTTP request.
 """
 
 import logging

queue_job/readme/CONFIGURE.md

@@ -2,9 +2,14 @@
   - Adjust environment variables (optional):
     - `ODOO_QUEUE_JOB_CHANNELS=root:4` or any other channels
       configuration. The default is `root:1`
-    - if `xmlrpc_port` is not set: `ODOO_QUEUE_JOB_PORT=8069`
-  - Start Odoo with `--load=web,queue_job` and `--workers` greater than
-    1.[^1]
+    - `ODOO_QUEUE_JOB_PORT=8069`, default `--http-port`
+    - `ODOO_QUEUE_JOB_SCHEME=https`, default `http`
+    - `ODOO_QUEUE_JOB_HOST=load-balancer`, default `--http-interface`
+      or `localhost` if unset
+    - `ODOO_QUEUE_JOB_HTTP_AUTH_USER=jobrunner`, default empty
+    - `ODOO_QUEUE_JOB_HTTP_AUTH_PASSWORD=s3cr3t`, default empty
+    - Start Odoo with `--load=web,queue_job` and `--workers` greater than
+      1.[^1]
 - Using the Odoo configuration file:
 
 ``` ini
@@ -16,6 +21,11 @@ server_wide_modules = web,queue_job
 (...)
 [queue_job]
 channels = root:2
+scheme = https
+host = load-balancer
+port = 443
+http_auth_user = jobrunner
+http_auth_password = s3cr3t
 ```
 
 - Confirm the runner is starting correctly by checking the odoo log