From 514df553239f76d8ffa2ece3f537198b58aff7dd Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Wed, 10 Apr 2024 18:23:52 +0200 Subject: [PATCH] Add broker and backend defaults as null This will keep the values in the sample config. --- doc/source/admin/galaxy_options.rst | 10 +++++----- lib/galaxy/config/sample/galaxy.yml.sample | 10 ++++++---- lib/galaxy/config/schemas/config_schema.yml | 6 ++++-- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index 2af6995cfd0..9ffc90e33ba 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5172,16 +5172,16 @@ To refer to a task by name, use the template `galaxy.foo` where `foo` is the function name of the task defined in the galaxy.celery.tasks module. - The `broker_url` option, if unset, defaults to the value of - `amqp_internal_connection`. The `result_backend` option, if unset, - defaults to an SQLite database at '/results.sqlite' for - storing task results. + The `broker_url` option, if unset or null, defaults to the value + of `amqp_internal_connection`. The `result_backend` option, if + unset or null, defaults to an SQLite database at + '/results.sqlite' for storing task results. The galaxy.fetch_data task can be disabled by setting its route to "disabled": `galaxy.fetch_data: disabled`. (Other tasks cannot be disabled on a per-task basis at this time.) For details, see Celery documentation at https://docs.celeryq.dev/en/stable/userguide/configuration.html. -:Default: ``{'task_routes': {'galaxy.fetch_data': 'galaxy.external', 'galaxy.set_job_metadata': 'galaxy.external'}}`` +:Default: ``{'broker_url': None, 'result_backend': None, 'task_routes': {'galaxy.fetch_data': 'galaxy.external', 'galaxy.set_job_metadata': 'galaxy.external'}}`` :Type: any diff --git a/lib/galaxy/config/sample/galaxy.yml.sample b/lib/galaxy/config/sample/galaxy.yml.sample index 1cc93b78e46..d55859a04eb 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2772,16 +2772,18 @@ galaxy: # To refer to a task by name, use the template `galaxy.foo` where # `foo` is the function name of the task defined in the # galaxy.celery.tasks module. - # The `broker_url` option, if unset, defaults to the value of - # `amqp_internal_connection`. The `result_backend` option, if unset, - # defaults to an SQLite database at '/results.sqlite' for - # storing task results. + # The `broker_url` option, if unset or null, defaults to the value of + # `amqp_internal_connection`. The `result_backend` option, if unset or + # null, defaults to an SQLite database at '/results.sqlite' + # for storing task results. # The galaxy.fetch_data task can be disabled by setting its route to # "disabled": `galaxy.fetch_data: disabled`. (Other tasks cannot be # disabled on a per-task basis at this time.) # For details, see Celery documentation at # https://docs.celeryq.dev/en/stable/userguide/configuration.html. #celery_conf: + # broker_url: null + # result_backend: null # task_routes: # galaxy.fetch_data: galaxy.external # galaxy.set_job_metadata: galaxy.external diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml index 13051a2098e..7e15c81cb56 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3772,6 +3772,8 @@ mapping: type: any required: false default: + broker_url: null + result_backend: null task_routes: 'galaxy.fetch_data': 'galaxy.external' 'galaxy.set_job_metadata': 'galaxy.external' @@ -3781,8 +3783,8 @@ mapping: To refer to a task by name, use the template `galaxy.foo` where `foo` is the function name of the task defined in the galaxy.celery.tasks module. - The `broker_url` option, if unset, defaults to the value of `amqp_internal_connection`. - The `result_backend` option, if unset, defaults to an SQLite database at '/results.sqlite' + The `broker_url` option, if unset or null, defaults to the value of `amqp_internal_connection`. + The `result_backend` option, if unset or null, defaults to an SQLite database at '/results.sqlite' for storing task results. The galaxy.fetch_data task can be disabled by setting its route to "disabled": `galaxy.fetch_data: disabled`.