-
Notifications
You must be signed in to change notification settings - Fork 557
Disable s3 multipart download option #12413
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
janvanmansum
wants to merge
10
commits into
IQSS:develop
Choose a base branch
from
janvanmansum:disable-s3-multipart-download-option
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+301
−197
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
5718ae6
DD-2271 separate clients for upload and download
janvanmansum afb1766
Added extension mime type definition for css to git rid of warnings i…
janvanmansum 859285f
DD-2283 No Accept/Cancel buttons when downloading dataset in Archival…
janvanmansum 3b347a4
wip
janvanmansum ed4f4e1
reformat
janvanmansum a1420c0
docs
janvanmansum 05a25e7
Release note
janvanmansum a786378
Update release notes for S3 multipart download setting
qqmyers 4432154
Update S3-compatible storage documentation
qqmyers 9668f11
Merge branch 'develop' into disable-s3-multipart-download-option
pdurbin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
doc/release-notes/12413-disable-multipart-download-for-indirect-download.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| A new configuration setting has been introduced for S3 compatible storage drivers that addresses an incompatibility between the AWS S3 library used in Dataverse and certain S3 implementations such as the Ceph Object Gateway: | ||
| `dataverse.files.<id>.disable-multipart-download-for-indirect-download` (default: `false`). | ||
|
|
||
| When set to `true`, multipart download is disabled for the specified S3 driver, forcing the server to handle part reassembly and avoiding the incompatible | ||
| headers. This is recommended for Ceph-backed S3 storage if `412` errors are encountered during download when `dataverse.files.<id>.download-redirect` is set to `false`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1399,28 +1399,29 @@ List of S3 Storage Options | |
| .. table:: | ||
| :align: left | ||
|
|
||
| =========================================== ================== =================================================================================== ============= | ||
| JVM Option Value Description Default value | ||
| =========================================== ================== =================================================================================== ============= | ||
| dataverse.files.storage-driver-id <id> Enable <id> as the default storage driver. ``file`` | ||
| dataverse.files.<id>.type ``s3`` **Required** to mark this storage as S3 based. (none) | ||
| dataverse.files.<id>.label <?> **Required** label to be shown in the UI for this storage (none) | ||
| dataverse.files.<id>.bucket-name <?> The bucket name. See above. (none) | ||
| dataverse.files.<id>.download-redirect ``true``/``false`` Enable direct download or proxy through Dataverse. ``false`` | ||
| dataverse.files.<id>.upload-redirect ``true``/``false`` Enable direct upload of files added to a dataset in the S3 store. ``false`` | ||
| dataverse.files.<id>.upload-out-of-band ``true``/``false`` Allow upload of files by out-of-band methods (using some tool other than Dataverse) ``false`` | ||
| dataverse.files.<id>.ingestsizelimit <size in bytes> Maximum size of directupload files that should be ingested (none) | ||
| dataverse.files.<id>.url-expiration-minutes <?> If direct uploads/downloads: time until links expire. Optional. 60 | ||
| dataverse.files.<id>.min-part-size <?> Multipart direct uploads will occur for files larger than this. Optional. ``1024**3`` | ||
| dataverse.files.<id>.custom-endpoint-url <?> Use custom S3 endpoint. Needs URL either with or without protocol. (none) | ||
| dataverse.files.<id>.custom-endpoint-region <?> Only used when using custom endpoint. Optional. ``dataverse`` | ||
| dataverse.files.<id>.profile <?> Allows the use of AWS profiles for storage spanning multiple AWS accounts. (none) | ||
| dataverse.files.<id>.proxy-url <?> URL of a proxy protecting the S3 store. Optional. (none) | ||
| dataverse.files.<id>.path-style-access ``true``/``false`` Use path style buckets instead of subdomains. Optional. ``false`` | ||
| dataverse.files.<id>.chunked-encoding ``true``/``false`` Disable chunked encoding. Optional ``true`` | ||
| dataverse.files.<id>.connection-pool-size <?> The maximum number of open connections to the S3 server ``256`` | ||
| dataverse.files.<id>.disable-tagging ``true``/``false`` Do not place the ``temp`` tag when redirecting the upload to the S3 server. ``false`` | ||
| =========================================== ================== =================================================================================== ============= | ||
| ===================================================================== ================== =================================================================================== ============= | ||
| JVM Option Value Description Default value | ||
| ===================================================================== ================== =================================================================================== ============= | ||
| dataverse.files.storage-driver-id <id> Enable <id> as the default storage driver. ``file`` | ||
| dataverse.files.<id>.type ``s3`` **Required** to mark this storage as S3 based. (none) | ||
| dataverse.files.<id>.label <?> **Required** label to be shown in the UI for this storage (none) | ||
| dataverse.files.<id>.bucket-name <?> The bucket name. See above. (none) | ||
| dataverse.files.<id>.download-redirect ``true``/``false`` Enable direct download or proxy through Dataverse. ``false`` | ||
| dataverse.files.<id>.upload-redirect ``true``/``false`` Enable direct upload of files added to a dataset in the S3 store. ``false`` | ||
| dataverse.files.<id>.upload-out-of-band ``true``/``false`` Allow upload of files by out-of-band methods (using some tool other than Dataverse) ``false`` | ||
| dataverse.files.<id>.ingestsizelimit <size in bytes> Maximum size of directupload files that should be ingested (none) | ||
| dataverse.files.<id>.url-expiration-minutes <?> If direct uploads/downloads: time until links expire. Optional. 60 | ||
| dataverse.files.<id>.min-part-size <?> Multipart direct uploads will occur for files larger than this. Optional. ``1024**3`` | ||
| dataverse.files.<id>.custom-endpoint-url <?> Use custom S3 endpoint. Needs URL either with or without protocol. (none) | ||
| dataverse.files.<id>.custom-endpoint-region <?> Only used when using custom endpoint. Optional. ``dataverse`` | ||
| dataverse.files.<id>.profile <?> Allows the use of AWS profiles for storage spanning multiple AWS accounts. (none) | ||
| dataverse.files.<id>.proxy-url <?> URL of a proxy protecting the S3 store. Optional. (none) | ||
| dataverse.files.<id>.path-style-access ``true``/``false`` Use path style buckets instead of subdomains. Optional. ``false`` | ||
| dataverse.files.<id>.chunked-encoding ``true``/``false`` Disable chunked encoding. Optional ``true`` | ||
| dataverse.files.<id>.connection-pool-size <?> The maximum number of open connections to the S3 server ``256`` | ||
| dataverse.files.<id>.disable-tagging ``true``/``false`` Do not place the ``temp`` tag when redirecting the upload to the S3 server. ``false`` | ||
| dataverse.files.<id>.disable-multipart-download-for-indirect-download ``true``/``false`` Disable multipart download for indirect downloads from S3. ``false`` | ||
| ===================================================================== ================== =================================================================================== ============= | ||
|
|
||
| .. table:: | ||
| :align: left | ||
|
|
@@ -1461,6 +1462,10 @@ You may provide the values for these via any `supported MicroProfile Config API | |
| Reported Working S3-Compatible Storage | ||
| ###################################### | ||
|
|
||
| `Ceph Object Gateway <https://docs.ceph.com/en/reef/radosgw/#ceph-object-gateway>`_ (added July 2026/Dataverse v6.12) | ||
| Set ``dataverse.files.<id>.disable-multipart-download-for-indirect-download=true`` if not using direct download. | ||
| (This forces the S3 server to handle part reassembly and avoid incompatible headers that cause `412` errors from the Ceph Gateway.) | ||
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just a heads up that there was a merge conflict here that I resolved in 9668f11 The conflict was because of this PR we merged: |
||
| `StorJ Object Store <https://www.storj.io>`_ | ||
| StorJ is a distributed object store that can be configured with an S3 gateway. Per the S3 Storage instructions above, you'll first set up the StorJ S3 store by defining the id, type, and label. After following the general installation, set the following configuration to use a StorJ object store: ``dataverse.files.<id>.chunked-encoding=false``. For step-by-step instructions see https://docs.storj.io/dcs/how-tos/dataverse-integration-guide/ | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@janvanmansum - I made some edits - feel free to revert. I wanted to make it clear this new setting is mainly to address a problem, not something you'd want to set true otherwise. I also guessed that you're talking about the Ceph Object Gateway.
Beyond that, I might suggest adding Ceph to the list at https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/installation/config.rst#reported-working-s3-compatible-storage with a note about this setting.