From 9d9630dc1c288d18cbcf858a0a944b812c987ddc Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Tue, 9 Apr 2024 17:09:18 +0200 Subject: [PATCH 1/8] Replace sample Celery result_backend in config --- doc/source/admin/galaxy_options.rst | 6 ++++-- lib/galaxy/config/sample/galaxy.yml.sample | 6 ++++-- lib/galaxy/config/schemas/config_schema.yml | 5 +++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index 441d5d2d85ad..5cd5d4d2649f 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5154,7 +5154,9 @@ only if you have setup a Celery worker for Galaxy and you have configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to - a valid Celery result backend URL. For details, see + a valid Celery result backend URL. By default a SQLite database is + used for storing task results, please use a more robust backend + for production setups like Redis. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks :Default: ``false`` :Type: bool @@ -5177,7 +5179,7 @@ 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: ``{'result_backend': 'redis://127.0.0.1:6379/0', 'task_routes': {'galaxy.fetch_data': 'galaxy.external', 'galaxy.set_job_metadata': 'galaxy.external'}}`` +:Default: ``{'result_backend': 'db+sqlite:///./database/results.sqlite?isolation_level=IMMEDIATE', '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 fffe8446af47..b379fa67e838 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2761,7 +2761,9 @@ galaxy: # only if you have setup a Celery worker for Galaxy and you have # configured the `celery_conf` option below. Specifically, you need to # set the `result_backend` option in the `celery_conf` option to a - # valid Celery result backend URL. For details, see + # valid Celery result backend URL. By default a SQLite database is + # used for storing task results, please use a more robust backend for + # production setups like Redis. For details, see # https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks #enable_celery_tasks: false @@ -2778,7 +2780,7 @@ galaxy: # For details, see Celery documentation at # https://docs.celeryq.dev/en/stable/userguide/configuration.html. #celery_conf: - # result_backend: redis://127.0.0.1:6379/0 + # result_backend: db+sqlite:///./database/results.sqlite?isolation_level=IMMEDIATE # 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 8178826bbbf7..1f742f869339 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3764,14 +3764,15 @@ mapping: Activate this only if you have setup a Celery worker for Galaxy and you have configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to a valid Celery result - backend URL. + backend URL. By default a SQLite database is used for storing task results, please + use a more robust backend for production setups like Redis. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks celery_conf: type: any required: false default: - result_backend: redis://127.0.0.1:6379/0 + result_backend: db+sqlite:///./database/results.sqlite?isolation_level=IMMEDIATE task_routes: 'galaxy.fetch_data': 'galaxy.external' 'galaxy.set_job_metadata': 'galaxy.external' From ac526184e8cb78f2b0df3cf1670955fec870a52d Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Wed, 10 Apr 2024 15:06:11 +0200 Subject: [PATCH 2/8] Make sure `data_dir` is used for default result backend DB --- doc/source/admin/galaxy_options.rst | 7 ++++--- lib/galaxy/config/__init__.py | 13 +++++++++++++ lib/galaxy/config/sample/galaxy.yml.sample | 7 ++++--- lib/galaxy/config/schemas/config_schema.yml | 4 ++-- 4 files changed, 23 insertions(+), 8 deletions(-) diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index 5cd5d4d2649f..a8a7066d2554 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5154,9 +5154,10 @@ only if you have setup a Celery worker for Galaxy and you have configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to - a valid Celery result backend URL. By default a SQLite database is - used for storing task results, please use a more robust backend - for production setups like Redis. For details, see + a valid Celery result backend URL. By default, Galaxy uses an + SQLite database at '/results.sqlite' for storing task + results. Please use a more robust backend for production setups + like Redis. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks :Default: ``false`` :Type: bool diff --git a/lib/galaxy/config/__init__.py b/lib/galaxy/config/__init__.py index ce8e5e8dc2b0..626aa1d489ea 100644 --- a/lib/galaxy/config/__init__.py +++ b/lib/galaxy/config/__init__.py @@ -1082,6 +1082,9 @@ def _process_config(self, kwargs: Dict[str, Any]) -> None: self.amqp_internal_connection = ( f"sqlalchemy+sqlite:///{self._in_data_dir('control.sqlite')}?isolation_level=IMMEDIATE" ) + + self._process_celery_config() + self.pretty_datetime_format = expand_pretty_datetime_format(self.pretty_datetime_format) try: with open(self.user_preferences_extra_conf_path) as stream: @@ -1203,6 +1206,16 @@ def _load_theme(path: str, theme_dict: dict): else: _load_theme(self.themes_config_file, self.themes) + def _process_celery_config(self): + if self.celery_conf: + result_backend = self.celery_conf.get("result_backend") + if result_backend: + # If the result_backend is the default SQLite database, we need to + # ensure that the correct data directory is used. + if "results.sqlite" in result_backend: + result_backend = f"db+sqlite:///{self._in_data_dir('results.sqlite')}?isolation_level=IMMEDIATE" + self.celery_conf["result_backend"] = result_backend + def _check_database_connection_strings(self): """ Verify connection URI strings in galaxy's configuration are parseable with urllib. diff --git a/lib/galaxy/config/sample/galaxy.yml.sample b/lib/galaxy/config/sample/galaxy.yml.sample index b379fa67e838..a7ed80d5a489 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2761,9 +2761,10 @@ galaxy: # only if you have setup a Celery worker for Galaxy and you have # configured the `celery_conf` option below. Specifically, you need to # set the `result_backend` option in the `celery_conf` option to a - # valid Celery result backend URL. By default a SQLite database is - # used for storing task results, please use a more robust backend for - # production setups like Redis. For details, see + # valid Celery result backend URL. By default, Galaxy uses an SQLite + # database at '/results.sqlite' for storing task results. + # Please use a more robust backend for production setups like Redis. + # For details, see # https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks #enable_celery_tasks: false diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml index 1f742f869339..8e9c0e44a13e 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3764,8 +3764,8 @@ mapping: Activate this only if you have setup a Celery worker for Galaxy and you have configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to a valid Celery result - backend URL. By default a SQLite database is used for storing task results, please - use a more robust backend for production setups like Redis. + backend URL. By default, Galaxy uses an SQLite database at '/results.sqlite' for storing task results. + Please use a more robust backend for production setups like Redis. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks celery_conf: From f3b968adf667a6d000e0ad7966258830fc67926c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20L=C3=B3pez?= <46503462+davelopez@users.noreply.github.com> Date: Wed, 10 Apr 2024 16:42:38 +0200 Subject: [PATCH 3/8] Fix typo Co-authored-by: John Davis --- lib/galaxy/config/schemas/config_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml index 8e9c0e44a13e..95f5aaa027de 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3765,7 +3765,7 @@ mapping: configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to a valid Celery result backend URL. By default, Galaxy uses an SQLite database at '/results.sqlite' for storing task results. - Please use a more robust backend for production setups like Redis. + Please use a more robust backend for production setups (e.g. Redis). For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks celery_conf: From 4ec8cef337cb62be6e1e3529e3fdf507fc9ea982 Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Wed, 10 Apr 2024 17:03:55 +0200 Subject: [PATCH 4/8] Reword sentence Co-authored-by: Nicola Soranzo --- doc/source/admin/galaxy_options.rst | 4 ++-- lib/galaxy/config/sample/galaxy.yml.sample | 2 +- lib/galaxy/config/schemas/config_schema.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index a8a7066d2554..d83bbb65edd3 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5156,8 +5156,8 @@ to set the `result_backend` option in the `celery_conf` option to a valid Celery result backend URL. By default, Galaxy uses an SQLite database at '/results.sqlite' for storing task - results. Please use a more robust backend for production setups - like Redis. For details, see + results. Please use a more robust backend (e.g. Redis) for + production setups. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks :Default: ``false`` :Type: bool diff --git a/lib/galaxy/config/sample/galaxy.yml.sample b/lib/galaxy/config/sample/galaxy.yml.sample index a7ed80d5a489..b27e6c887ae3 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2763,7 +2763,7 @@ galaxy: # set the `result_backend` option in the `celery_conf` option to a # valid Celery result backend URL. By default, Galaxy uses an SQLite # database at '/results.sqlite' for storing task results. - # Please use a more robust backend for production setups like Redis. + # Please use a more robust backend (e.g. Redis) for production setups. # For details, see # https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks #enable_celery_tasks: false diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml index 95f5aaa027de..4fffa48b62d3 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3765,7 +3765,7 @@ mapping: configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to a valid Celery result backend URL. By default, Galaxy uses an SQLite database at '/results.sqlite' for storing task results. - Please use a more robust backend for production setups (e.g. Redis). + Please use a more robust backend (e.g. Redis) for production setups. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks celery_conf: From f10ba4a37b53e7e35e4f8fb8e0ee4635eaa0ec33 Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Wed, 10 Apr 2024 17:12:37 +0200 Subject: [PATCH 5/8] Do not set default value for result_backend --- lib/galaxy/config/__init__.py | 12 ++++-------- lib/galaxy/config/schemas/config_schema.yml | 4 ++-- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/lib/galaxy/config/__init__.py b/lib/galaxy/config/__init__.py index 626aa1d489ea..6670611637e6 100644 --- a/lib/galaxy/config/__init__.py +++ b/lib/galaxy/config/__init__.py @@ -1207,14 +1207,10 @@ def _load_theme(path: str, theme_dict: dict): _load_theme(self.themes_config_file, self.themes) def _process_celery_config(self): - if self.celery_conf: - result_backend = self.celery_conf.get("result_backend") - if result_backend: - # If the result_backend is the default SQLite database, we need to - # ensure that the correct data directory is used. - if "results.sqlite" in result_backend: - result_backend = f"db+sqlite:///{self._in_data_dir('results.sqlite')}?isolation_level=IMMEDIATE" - self.celery_conf["result_backend"] = result_backend + if self.celery_conf and self.celery_conf.get("result_backend") is None: + # If the result_backend is not set, use a SQLite database in the data directory + result_backend = f"db+sqlite:///{self._in_data_dir('results.sqlite')}?isolation_level=IMMEDIATE" + self.celery_conf["result_backend"] = result_backend def _check_database_connection_strings(self): """ diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml index 4fffa48b62d3..13051a2098ef 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3772,7 +3772,6 @@ mapping: type: any required: false default: - result_backend: db+sqlite:///./database/results.sqlite?isolation_level=IMMEDIATE task_routes: 'galaxy.fetch_data': 'galaxy.external' 'galaxy.set_job_metadata': 'galaxy.external' @@ -3783,7 +3782,8 @@ mapping: 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 must be set if the `enable_celery_tasks` option is set. + The `result_backend` option, if unset, 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.) From a739ed1cb80e2a9961053e6950503db9dd019c8b Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Wed, 10 Apr 2024 17:56:52 +0200 Subject: [PATCH 6/8] Rebuild config samples --- doc/source/admin/galaxy_options.rst | 7 ++++--- lib/galaxy/config/sample/galaxy.yml.sample | 6 +++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index d83bbb65edd3..2af6995cfd09 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5173,14 +5173,15 @@ `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 must be - set if the `enable_celery_tasks` option is set. + `amqp_internal_connection`. The `result_backend` option, if unset, + 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: ``{'result_backend': 'db+sqlite:///./database/results.sqlite?isolation_level=IMMEDIATE', 'task_routes': {'galaxy.fetch_data': 'galaxy.external', 'galaxy.set_job_metadata': 'galaxy.external'}}`` +:Default: ``{'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 b27e6c887ae3..1cc93b78e462 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2773,15 +2773,15 @@ galaxy: # `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 must be set - # if the `enable_celery_tasks` option is set. + # `amqp_internal_connection`. The `result_backend` option, if unset, + # 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: - # result_backend: db+sqlite:///./database/results.sqlite?isolation_level=IMMEDIATE # task_routes: # galaxy.fetch_data: galaxy.external # galaxy.set_job_metadata: galaxy.external 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 7/8] 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 2af6995cfd09..9ffc90e33ba4 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 1cc93b78e462..d55859a04eba 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 13051a2098ef..7e15c81cb566 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`. From 3bb49cab8e0b8352e6210851e57875abd28dc6cb Mon Sep 17 00:00:00 2001 From: davelopez <46503462+davelopez@users.noreply.github.com> Date: Thu, 11 Apr 2024 09:21:27 +0200 Subject: [PATCH 8/8] Move result_backend comment to celery_conf Co-authored-by: Nicola Soranzo --- doc/source/admin/galaxy_options.rst | 6 +++--- lib/galaxy/config/sample/galaxy.yml.sample | 4 ++-- lib/galaxy/config/schemas/config_schema.yml | 3 +-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index 9ffc90e33ba4..b5511036af2f 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5156,8 +5156,7 @@ to set the `result_backend` option in the `celery_conf` option to a valid Celery result backend URL. By default, Galaxy uses an SQLite database at '/results.sqlite' for storing task - results. Please use a more robust backend (e.g. Redis) for - production setups. For details, see + results. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks :Default: ``false`` :Type: bool @@ -5175,7 +5174,8 @@ 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. + '/results.sqlite' for storing task results. Please use a + more robust backend (e.g. Redis) for production setups. 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.) diff --git a/lib/galaxy/config/sample/galaxy.yml.sample b/lib/galaxy/config/sample/galaxy.yml.sample index d55859a04eba..8032d879039b 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2763,7 +2763,6 @@ galaxy: # set the `result_backend` option in the `celery_conf` option to a # valid Celery result backend URL. By default, Galaxy uses an SQLite # database at '/results.sqlite' for storing task results. - # Please use a more robust backend (e.g. Redis) for production setups. # For details, see # https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks #enable_celery_tasks: false @@ -2775,7 +2774,8 @@ galaxy: # 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. + # for storing task results. Please use a more robust backend (e.g. + # Redis) for production setups. # 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.) diff --git a/lib/galaxy/config/schemas/config_schema.yml b/lib/galaxy/config/schemas/config_schema.yml index 7e15c81cb566..99dbe9657746 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3765,7 +3765,6 @@ mapping: configured the `celery_conf` option below. Specifically, you need to set the `result_backend` option in the `celery_conf` option to a valid Celery result backend URL. By default, Galaxy uses an SQLite database at '/results.sqlite' for storing task results. - Please use a more robust backend (e.g. Redis) for production setups. For details, see https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks celery_conf: @@ -3785,7 +3784,7 @@ mapping: 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. + for storing task results. Please use a more robust backend (e.g. Redis) for production setups. 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.)