Fix native S3 config docs #24319
Fix native S3 config docs #24319
Conversation
| `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 service endpoint URL to communicate with. | ||
| * - `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 ? |
|
This pull request has gone a while without any activity. Tagging for triage help: @mosabua |
|
Ping @hashhar |
|
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. |
|
We should get this in after expanding .. let me know if you need help @hashhar |
mosabua
added
stale-ignore
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.
ebyhr
force-pushed
the
hashhar/fix-s3-required-config
branch
from
380a990 to
c3ed557
Compare
4 participants
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.