Update config.rst #8314
Update config.rst #8314
Conversation
Submitting an integration request on behalf of the StorJ team. StorJ has a vetted working S3 integration - added integration steps to reflect that integration.
|
Thanks @dhirst1 - we'll take a look! |
| @@ -240,7 +240,7 @@ As for the "Remote only" authentication mode, it means that: | |||
| - ``:DefaultAuthProvider`` has been set to use the desired authentication provider | |||
| - The "builtin" authentication provider has been disabled (:ref:`api-toggle-auth-provider`). Note that disabling the "builtin" authentication provider means that the API endpoint for converting an account from a remote auth provider will not work. Converting directly from one remote authentication provider to another (i.e. from GitHub to Google) is not supported. Conversion from remote is always to "builtin". Then the user initiates a conversion from "builtin" to remote. Note that longer term, the plan is to permit multiple login options to the same Dataverse installation account per https://github.com/IQSS/dataverse/issues/3487 (so all this talk of conversion will be moot) but for now users can only use a single login option, as explained in the :doc:`/user/account` section of the User Guide. In short, "remote only" might work for you if you only plan to use a single remote authentication provider such that no conversion between remote authentication providers will be necessary. | |||
|
|
|||
| File Storage: Using a Local Filesystem and/or Swift and/or S3 object stores | |||
| File Storage: Using a Local Filesystem and/or Swift and/or object stores | |||
There was a problem hiding this comment.
We only support "S3-accessible" object stores - can we add that instead of removing S3 here?
There was a problem hiding this comment.
Sorry for the delayed response, I didn't see these notifications. Will address!
| 'StorJ Integration' | ||
| Per the general Dataverse Installation to use S3 Storage noted 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 configurations to use a StorJ object store - dataverse.files.<id>.payload-signing=true This optional setting will enable payload signing for the S3 bucket. Set dataverse.files.<id>.chunked-encoding=false. This optional setting will disable chunked encoding. | ||
|
|
||
| Note that for direct uploads and downloads, Dataverse redirects to the proxy-url but presigns the urls based on the dataverse.files.<id>.custom-endpoint-url. Also, consider that if you choose to enable dataverse.files.<id>.download-redirect note that the S3 URLs expire after 60 minutes by default. You can change that minute value to reflect a timeout value that’s more appropriate by using .dataverse.files.<id>.url-expiration-minutes. |
There was a problem hiding this comment.
Are these specific to StorJ in some way? Could/should they move up to just under the table?
There was a problem hiding this comment.
I do believe so, at least specific for the integration for anyone looking to use S3 + Dataverse.
| @@ -557,6 +557,11 @@ Reported Working S3-Compatible Storage | |||
| **Can be used for quick testing, too:** just use the example values above. Uses the public (read: unsecure and | |||
| possibly slow) https://play.minio.io:9000 service. | |||
|
|
|||
| 'StorJ Integration' | |||
| Per the general Dataverse Installation to use S3 Storage noted 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 configurations to use a StorJ object store - dataverse.files.<id>.payload-signing=true This optional setting will enable payload signing for the S3 bucket. Set dataverse.files.<id>.chunked-encoding=false. This optional setting will disable chunked encoding. | |||
There was a problem hiding this comment.
I think a link and perhaps some brief description, e.g. StorJ is a distributed object store that can be configured with a S3 gateway, would be useful.
There was a problem hiding this comment.
Perfect, added! I'm not familiar with making the link bolded and italicized. Could you direct me on that? I did add the link.
There was a problem hiding this comment.
@dhirst1 it's probably easier to show than tell. I just create a pull request against this pull request with some tweaks. If you like it, please go ahead and merge it or steal what you want from it: dhirst1#1
Here's a preview of how it looks:
If you don't have Sphinx installed to preview changes with make html I highly recommend it. We can help you get it installed if you have trouble. Thanks!
|
I just clicked "approve and run" (screenshot below) so we can be sure
|
Submitting an integration request on behalf of the StorJ team.
StorJ has a vetted working S3 integration - added integration steps to reflect that integration.
What this PR does / why we need it:
Which issue(s) this PR closes:
Closes #
Special notes for your reviewer:
Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: