diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index 04ad0c5a1d5..441d5d2d85a 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -5151,8 +5151,11 @@ :Description: Offload long-running tasks to a Celery task queue. Activate this - only if you have setup a Celery worker for Galaxy. For details, - see https://docs.galaxyproject.org/en/master/admin/production.html + 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 + https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks :Default: ``false`` :Type: bool @@ -5174,7 +5177,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: ``{'task_routes': {'galaxy.fetch_data': 'galaxy.external', 'galaxy.set_job_metadata': 'galaxy.external'}}`` +:Default: ``{'result_backend': 'redis://127.0.0.1:6379/0', '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 532f582920e..fffe8446af4 100644 --- a/lib/galaxy/config/sample/galaxy.yml.sample +++ b/lib/galaxy/config/sample/galaxy.yml.sample @@ -2758,8 +2758,11 @@ galaxy: #amqp_internal_connection: sqlalchemy+sqlite:///./database/control.sqlite?isolation_level=IMMEDIATE # Offload long-running tasks to a Celery task queue. Activate this - # only if you have setup a Celery worker for Galaxy. For details, see - # https://docs.galaxyproject.org/en/master/admin/production.html + # 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 + # https://docs.galaxyproject.org/en/master/admin/production.html#use-celery-for-asynchronous-tasks #enable_celery_tasks: false # Configuration options passed to Celery. @@ -2775,6 +2778,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 # 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 04e0e41c6f5..8178826bbbf 100644 --- a/lib/galaxy/config/schemas/config_schema.yml +++ b/lib/galaxy/config/schemas/config_schema.yml @@ -3761,13 +3761,17 @@ mapping: required: false desc: | Offload long-running tasks to a Celery task queue. - Activate this only if you have setup a Celery worker for Galaxy. - For details, see https://docs.galaxyproject.org/en/master/admin/production.html + 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. + 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 task_routes: 'galaxy.fetch_data': 'galaxy.external' 'galaxy.set_job_metadata': 'galaxy.external'