Skip to content

fix: use correct endpointURL in Linode example (#2629) - #2630

Merged
gbartolini merged 1 commit into
cloudnative-pg:mainfrom
mikewallace1979:dev/2629
Sep 28, 2023
Merged

gbartolini merged 1 commit into
cloudnative-pg:mainfrom
mikewallace1979:dev/2629

Conversation

@mikewallace1979

Copy link
Copy Markdown
Contributor

Updates the endpointURL for the Linode example in object_stores.md so that it does not include the bucket name and moves the bucket name into the S3 URL provided to destinationPath.

This is based on the recommendations in the current Linode documentation at:

https://www.linode.com/docs/products/storage/object-storage/guides/urls/#cluster-url-s3-endpoint

Closes #2629

@github-actions github-actions Bot added backport-requested ◀️ This pull request should be backported to all supported releases release-1.19 labels Aug 25, 2023
@github-actions

Copy link
Copy Markdown
Contributor

❗ By default, the pull request is configured to backport to all release branches.

  • To stop backporting this pr, remove the label: backport-requested ◀️ or add the label 'do not backport'
  • To stop backporting this pr to a certain release branch, remove the specific branch label: release-x.y

@sxd

sxd commented Sep 5, 2023 •

Copy link
Copy Markdown
Contributor

Hi @mikewallace1979

I don't see a reason to change this, since when you are asked for the endpoint your are asking for the bucket endpoint, what linode is allowing here, it's a nice feature, but it's common to point to the bucket and then a path inside the bucket, this allow users to have the same endpoint but a different path if they want different directories inside the same bucket.

Why you think this is needed ?

Regards!

@mikewallace1979

Copy link
Copy Markdown
Contributor Author

@sxd I wanted to change this because the bucket name should not be included in the endpoint URL. According to Linode:

Cluster URL (S3 Endpoint)

The cluster URL for Object Storage is unique to each data center. This URL can be used for accessing all of your Object Storage resources within a certain region. When used with third party tools, this URL might also be referred to as the S3 endpoint.

Cluster URL: https://[cluster-id].linodeobjects.com/, replacing [cluster-id] with the id of your data center.

The docs currently suggest using the bucket URL for the endpoint URL - if a user does this then they will end up with a configuration which works for some requests and does not for others. This is the case when using either barman cloud or the AWS cli to interact with the bucket. Debugging the resulting behaviour is time consuming, as demonstrated in both #1313 and EnterpriseDB/barman#835.

So the line I really care about changing here is:

endpointURL: "https://bucket.us-east1.linodeobjects.com"

because it suggests to users they should include the bucket name in the endpoint, which is not going to end well.

Keeping an example path in the destinationPath line would be fine, so the docs could say something like this:

destinationPath: "s3://bucket/<destination path here>"
endpointURL: "https://us-east1.linodeobjects.com"

Updates the endpointURL for the Linode example in object_stores.md so
that it does not include the bucket name and moves the bucket name into
the S3 URL provided to destinationPath.

This is based on the recommendations in the current Linode documentation
at:

    https://www.linode.com/docs/products/storage/object-storage/guides/urls/#cluster-url-s3-endpoint

Closes cloudnative-pg#2629

Signed-off-by: Michael Wallace <[email protected]>
@gbartolini gbartolini added the ok to merge 👌 This PR can be merged label Sep 28, 2023
@gbartolini
gbartolini merged commit db3a057 into cloudnative-pg:main Sep 28, 2023
cnpg-bot pushed a commit that referenced this pull request Sep 28, 2023
Updates the endpointURL for the Linode example in object_stores.md so
that it does not include the bucket name and moves the bucket name into
the S3 URL provided to destinationPath.

This is based on the recommendations in the current Linode documentation
at:

https://www.linode.com/docs/products/storage/object-storage/guides/urls/#cluster-url-s3-endpoint

Closes #2629

Signed-off-by: Michael Wallace <[email protected]>
(cherry picked from commit db3a057)
gbartolini pushed a commit that referenced this pull request Sep 28, 2023
Updates the endpointURL for the Linode example in object_stores.md so
that it does not include the bucket name and moves the bucket name into
the S3 URL provided to destinationPath.

This is based on the recommendations in the current Linode documentation
at:

https://www.linode.com/docs/products/storage/object-storage/guides/urls/#cluster-url-s3-endpoint

Closes #2629

Signed-off-by: Michael Wallace <[email protected]>
Lennart01 pushed a commit to Lennart01/cloudnative-pg that referenced this pull request Sep 30, 2023
…loudnative-pg#2630)

Updates the endpointURL for the Linode example in object_stores.md so
that it does not include the bucket name and moves the bucket name into
the S3 URL provided to destinationPath.

This is based on the recommendations in the current Linode documentation
at:

https://www.linode.com/docs/products/storage/object-storage/guides/urls/#cluster-url-s3-endpoint

Closes cloudnative-pg#2629

Signed-off-by: Michael Wallace <[email protected]>
Signed-off-by: Lennart Krauch <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-requested ◀️ This pull request should be backported to all supported releases ok to merge 👌 This PR can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix linode example in Other S3-compatible Object Storages providers

3 participants