Fix s3 example URLs in the artifacts docs #15123
Conversation
Unfortunately, s3 urls prefixed with https:// do NOT work with the underlying go-getter library. As such, this fixes the examples so that they are working examples that won't cause problems for people reading the docs. See discussion in #1113 circa 2016.
There was a problem hiding this comment.
Thanks for the fix @twunderlich-grapl!
Per your findings and existing documentation ("non-Amazon S3-compatible endpoints like Minio are supported, but you must explicitly set the "s3::" prefix.") using the explicit s3:// protocol may be the example that is most likely to work in different scenarios.
How do you feel about setting it in the docs?
| @@ -210,7 +210,7 @@ This example uses path-based notation on a publicly-accessible bucket: | |||
|
|
|||
| ```hcl | |||
| artifact { | |||
| source = "https://my-bucket-example.s3-us-west-2.amazonaws.com/my_app.tar.gz" | |||
| source = "my-bucket-example.s3-us-west-2.amazonaws.com/my_app.tar.gz" | |||
There was a problem hiding this comment.
| source = "my-bucket-example.s3-us-west-2.amazonaws.com/my_app.tar.gz" | |
| source = "s3://my-bucket-example.s3-us-west-2.amazonaws.com/my_app.tar.gz" |
There was a problem hiding this comment.
I've updated this in a follow-up commit
| @@ -240,7 +240,7 @@ Alternatively you can use virtual hosted style: | |||
|
|
|||
| ```hcl | |||
| artifact { | |||
| source = "https://my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz" | |||
| source = "my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz" | |||
There was a problem hiding this comment.
| source = "my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz" | |
| source = "s3://my-bucket-example.s3-eu-west-1.amazonaws.com/my_app.tar.gz" |
There was a problem hiding this comment.
I've updated this in a follow-up commit
Per the discussion in #15123, we're going to use the explicit s3 protocol in the examples since that is the likeliest to work in all scenarios
ghost
requested a review
from 
|
@lgfa29, |
lgfa29
added
backport/website
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Unfortunately, s3 urls prefixed with https:// do NOT work with the underlying go-getter library. As such, this fixes the examples so that they are working examples that won't cause problems for people reading the docs.
This is a known limitation of the go-getter lib since at least 2016 per #1113
I've also put up a PR with the underlying go-getter lib to fix their docs as well: hashicorp/go-getter#394