Fix native S3 config docs #24319
Open
Fix native S3 config docs #24319
Conversation
This file contains 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
Neither region nor endpoint are required. The defaults are auto-discovered by the AWS SDK. The region might only need to be specified if running outside of EC2 or AWS SDK related settings/environment variables haven't been configured or if using a S3-compatible system where there is a single fixed region always. The endpoint is also similarly usually not needed to be specified in real S3 unless using something like private endpoints. It's really only necessary when using a S3-compatible system.
wendigo
approved these changes
Dec 1, 2024
mosabua
requested changes
Dec 1, 2024
| @@ -25,9 +25,9 @@ support: | |||
| - Activate the native implementation for S3 storage support. Defaults to | |||
| `false`. Set to `true` to use S3 and enable all other properties. | |||
| * - `s3.endpoint` | |||
| - Required endpoint URL for S3. | |||
| - S3 service endpoint URL to communicate with. | |||
There was a problem hiding this comment.
Lets expand this a bit more as you explained in the description.
| * - `s3.region` | ||
| - Required region name for S3. | ||
| - S3 region to communicate with. |
|
Also fyi @electrum ... I think while regions is autofilled with the AWS SDK .. it is still a required field. For example .. even though it does not even exist as a concept in MinIO a value for region is still required .. although it is basically not used. |
|
This pull request has gone a while without any activity. Tagging for triage help: @mosabua |
|
Closing this pull request, as it has been stale for six weeks. Feel free to re-open at any time. |
|
I still think this is useful and valid .. can you expand as requested @hashhar ? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Current docs don't match the implementation and hence are incorrect and create confusion for user and make it more likely that users misconfigure things in the common usecases.
Additional context and related issues
Neither region nor endpoint are required. The defaults are auto-discovered by the AWS SDK.
The region might only need to be specified if running outside of EC2 or AWS SDK related settings/environment variables haven't been configured or if using a S3-compatible system where there is a single fixed region always.
The endpoint is also similarly usually not needed to be specified in real S3 unless using something like private endpoints. It's really only necessary when using a S3-compatible system.
Release notes
(x) This is not user-visible or is docs only, and no release notes are required.