Document metadata_strategy

This commit is contained in:
mvdbeek
2020-07-04 19:44:34 +02:00
parent 0c78aca542
commit ea3f48a5ec
4 changed files with 48 additions and 0 deletions
+16
View File
@@ -3563,6 +3563,22 @@
:Type: bool
~~~~~~~~~~~~~~~~~~~~~
``metadata_strategy``
~~~~~~~~~~~~~~~~~~~~~
:Description:
Determines how metadata will be set. Valid values are `directory`,
`extended` and `legacy`. In extended mode jobs will decide if a
tool run failed, the object stores configuration is serialized
and made available to the job and is used for writing output
datasets to the object store as part of the job and dynamic
output discovery (e.g. discovered datasets <discover_datasets>,
unpopulated collections, etc) happens as part of the job.
:Default: ``directory``
:Type: str
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``retry_metadata_internally``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1741,6 +1741,15 @@ galaxy:
# database.
#enable_job_recovery: true
# Determines how metadata will be set. Valid values are `directory`,
# `extended` and `legacy`. In extended mode jobs will decide if a tool
# run failed, the object stores configuration is serialized and made
# available to the job and is used for writing output datasets to the
# object store as part of the job and dynamic output discovery (e.g.
# discovered datasets <discover_datasets>, unpopulated collections,
# etc) happens as part of the job.
#metadata_strategy: directory
# Although it is fairly reliable, setting metadata can occasionally
# fail. In these instances, you can choose to retry setting it
# internally or leave it in a failed state (since retrying internally
@@ -401,6 +401,17 @@
try it early - it will slightly speed up local jobs by
embedding metadata calculation in job script itself.
-->
<param id="metadata_strategy">directory</param>
<!-- If set overwrites metadata_strategy (configurable in galaxy.yml).
Valid values are `directory` (default), `extended` and `legacy`.
Setting metadata_strategy to extended requires that all object stores
that can be written to store datasets by uuid. In extended mode jobs
will decide if a tool run failed, the object stores configuration
is serialized and made available to the job and is used for writing output
datasets to the object store as part of the job and dynamic output discovery
(e.g. discovered datasets <discover_datasets>, unpopulated collections, etc)
happens as part of the job.
-->
<job_metrics />
<!-- Above element demonstrates embedded job metrics definition - see
job_metrics_conf.xml.sample for full documentation on possible nested
@@ -2638,6 +2638,18 @@ mapping:
it can "recover" them when it starts). This is not safe to use if you are
running more than one Galaxy server using the same database.
metadata_strategy:
type: str
required: false
default: directory
desc: |
Determines how metadata will be set. Valid values are `directory`, `extended` and `legacy`.
In extended mode jobs will decide if a tool run failed, the object stores
configuration is serialized and made available to the job and is used for
writing output datasets to the object store as part of the job and dynamic
output discovery (e.g. discovered datasets <discover_datasets>, unpopulated collections,
etc) happens as part of the job.
retry_metadata_internally:
type: bool
default: true