Update docs for AWS Endpoint parameter for all S3 + Path Style URL Parameter #19366
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
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
kathancox
force-pushed
the
aws-endpoint-all-s3
branch
from
c830bae to
0984e28
Compare
kathancox
changed the title
benbardin
reviewed
Feb 12, 2025
src/current/v24.1/backup.md
Outdated
| @@ -97,6 +97,9 @@ Query parameter | Value | Description | |||
| ----------------+-------+------------ | |||
| `ASSUME_ROLE` | [`STRING`]({% link {{ page.version.version }}/string.md %}) |{% include {{ page.version.version }}/misc/assume-role-description.md %} Refer to [Cloud Storage Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) for setup details. | |||
| `AUTH` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The authentication parameter can define either `specified` (default) or `implicit` authentication. To use `specified` authentication, pass your [Service Account](https://cloud.google.com/iam/docs/understanding-service-accounts) credentials with the URI. To use `implicit` authentication, configure these credentials via an environment variable. Refer to the [Cloud Storage Authentication page]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) page for examples of each of these. | |||
| `AWS_ENDPOINT` | Specify a custom endpoint for Amazon S3 or S3-compatible services. Use to define a particular region or a Virtual Private Cloud (VPC) endpoint. | |||
| `AWS_SESSION_TOKEN` | (Optional) Use as part of temoporary security credentials when accessing AWS S3. For more information, refer to Amazon's guide on [temporary credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html). | |||
| {% include_cached new-in.html version="v24.1.10" %} `AWS_USE_PATH_STYLE` | Change the URL format to path style from the default AWS S3 virtual-hosted–style URLs when connecting to Amazon S3 or S3-compatible services. | |||
There was a problem hiding this comment.
So, not exactly - that's true on 24.3+. But on 24.1/24.2, the param exists but does nothing. Path style is actually the only available system on those versions. For 24.3, we changed the behavior. We added AWS_USE_PATH_STYLE to force the old behavior on 24.3+, and backported the param as a noop to 24.1/24.2 so users who need it could set it in advance of upgrading.
| @@ -96,6 +96,9 @@ N/A | Back up the cluster. For an example of a fu | |||
| Query parameter | Value | Description | |||
| ----------------+-------+------------ | |||
| `ASSUME_ROLE` | [`STRING`]({% link {{ page.version.version }}/string.md %}) |{% include {{ page.version.version }}/misc/assume-role-description.md %} Refer to [Cloud Storage Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) for setup details. | |||
| `AUTH` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The authentication parameter can define either `specified` (default) or `implicit` authentication. To use `specified` authentication, pass your [Service Account](https://cloud.google.com/iam/docs/understanding-service-accounts) credentials with the URI. To use `implicit` authentication, configure these credentials via an environment variable. Refer to the [Cloud Storage Authentication page]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) page for examples of each of these. | |||
| `AWS_ENDPOINT` | Specify a custom endpoint for Amazon S3 or S3-compatible services. Use to define a particular region or a Virtual Private Cloud (VPC) endpoint. | |||
There was a problem hiding this comment.
ENDPOINT and SESSION TOKEN comments look good throughout, thank you!
kathancox
commented
Feb 12, 2025
| @@ -97,6 +97,9 @@ Query parameter | Value | Description | |||
| ----------------+-------+------------ | |||
| `ASSUME_ROLE` | [`STRING`]({% link {{ page.version.version }}/string.md %}) |{% include {{ page.version.version }}/misc/assume-role-description.md %} Refer to [Cloud Storage Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) for setup details. | |||
| `AUTH` | [`STRING`]({% link {{ page.version.version }}/string.md %}) | The authentication parameter can define either `specified` (default) or `implicit` authentication. To use `specified` authentication, pass your [Service Account](https://cloud.google.com/iam/docs/understanding-service-accounts) credentials with the URI. To use `implicit` authentication, configure these credentials via an environment variable. Refer to the [Cloud Storage Authentication page]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) page for examples of each of these. | |||
| `AWS_ENDPOINT` | Specify a custom endpoint for Amazon S3 or S3-compatible services. Use to define a particular region or a Virtual Private Cloud (VPC) endpoint. | |||
| `AWS_SESSION_TOKEN` | (Optional) Use as part of temoporary security credentials when accessing AWS S3. For more information, refer to Amazon's guide on [temporary credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html). | |||
| {% include_cached new-in.html version="v24.1.10" %} `AWS_USE_PATH_STYLE` | Set the URL format to path style. In v24.3+, the default URL format is AWS S3 virtual-hosted–style URLs when connecting to Amazon S3 or S3-compatible services. Before upgrading to v24.3+, use `AWS_USE_PATH_STYLE` to keep the URL format as path style. | |||
There was a problem hiding this comment.
@benbardin Ah! Yes, apologies. Does this change cover it?
benbardin
approved these changes
Feb 12, 2025
|
Thanks for the quick review @benbardin ! |
kathancox
force-pushed
the
aws-endpoint-all-s3
branch
from
53dc98d to
3129bd8
Compare
|
TFTRs! |
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.
Fixes DOC-11949, DOC-12079
This PR adds: