Skip to content

Commit

Permalink
Big warning box about distributed object stores being required.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmchilton committed May 16, 2024
1 parent 36b51d2 commit 56a32fe
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/source/admin/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@ pointed to by the configuration option ``object_store_templates_config_file`` in
Alternatively, the configuration can be placed directly into ``galaxy.yml`` using the
``object_store_templates`` configuration option.

:::{admonition} Warning
:class: warning

Object store selection within Galaxy is available only when the primary object store is a
distributed object store. All the other object stores provide stronger guarantees about how
datasets are stored. Object Store Templates will not currently work if the primary
object store (usually defined by ``object_store_config_file``) is a simple disk object
store, a hierarchal object store, or anything other than a ``distributed`` object store.

Ongoing discussion on this topic can be found at [this Galaxy Discussions post (#18157)](https://github.com/galaxyproject/galaxy/discussions/18157).
:::

A minimal object store template might look something like:

```{literalinclude} ../../../lib/galaxy/objectstore/templates/examples/simple_example.yml
Expand Down
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"attrs_block",
"deflist",
"substitution",
"colon_fence",
]
myst_heading_anchors = 5
myst_heading_slug_func = "docutils.nodes.make_id"
Expand Down

0 comments on commit 56a32fe

Please sign in to comment.