Skip to content
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.

Sign up for GitHub

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

docs: Presign URLs are compatible with any storage class #770

Merged
merged 1 commit into from
Nov 13, 2024
Merged

docs: Presign URLs are compatible with any storage class #770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: Presign URLs are compatible with any storage class 
- Remove the note on cloud_project_region_storage_presign resource telling it's
  compatible only with the High Performance storage class. Pre-signed URLs are
compatible with any class.
- Region name must be in uppercase

Signed-off-by: Julien Riou <julien.riou@ovhcloud.com>
  • Loading branch information
@jriouovh
jriouovh committed Nov 13, 2024
commit afb8ee76eb50b5c8f620792864a4453eed09d116
18 changes: 9 additions & 9 deletions website/docs/r/cloud_project_region_storage_presign.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ subcategory : "Object Storage"

Generates a temporary presigned S3 URLs to download or upload an object.

-> __NOTE__ This resource is only compatible with the `High Performance - S3` solution for object storage.

## Example Usage

```hcl
Expand All @@ -29,14 +27,16 @@ output "presigned_url" {

The following arguments are supported:

* `service_name` - (Required) The id of the public cloud project. If omitted,
- `service_name` - (Required) The id of the public cloud project. If omitted,
the `OVH_CLOUD_PROJECT_SERVICE` environment variable is used.
* `region_name` - (Required) The region in which your storage is located.
Ex.: "GRA".
* `name` - (Required) The name of your S3 storage container/bucket.
* `expire` - (Required) Define, in seconds, for how long your URL will be valid.
* `method` - (Required) The method you want to use to interact with your object. Can be either 'GET' or 'PUT'.
* `object` - (Required) The name of the object in your S3 bucket.
- `region_name` - (Required) The region in which your storage is located. Must
be in **uppercase**. Ex.: "GRA".
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the region must be in uppercase, should the terraform provider take care of putting it in uppercase if it was supplied in lower case ?

for example here:

terraform-provider-ovh/ovh/resource_cloud_project_region_storage_presign.go

Line 76 in 5bbcd92

regionName := d.Get("region_name").(string)

This would prevent confusion when some documentation state that regions must be in lower case: https://help.ovhcloud.com/csm?id=kb_article_view&sysparm_article=KB0047384
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a good idea: #772 :)

- `name` - (Required) The name of your S3 storage container/bucket.
- `expire` - (Required) Define, in seconds, for how long your URL will be
valid.
- `method` - (Required) The method you want to use to interact with your
object. Can be either 'GET' or 'PUT'.
- `object` - (Required) The name of the object in your S3 bucket.


## Attributes Reference
Expand Down