Add info about aws timeouts to docs #10209
Conversation
In auth/aws, seal/awskms, and secrets/aws.
There was a problem hiding this comment.
Looks good, just a few minor comments.
Might be worth to also add a note about the timeout/delay on the 1.4.0 Upgrade Guide and 1.5.0 Upgrade Guide pages (as a known issue). We can say that this is fixed on 1.5.5 and later.
website/pages/docs/auth/aws.mdx
Outdated
| service][aws-ec2-mds] on an EC2 instance, there may be a delay. The AWS SDK used | ||
| by Vault first attempts to connect to [v2 of the instance metadata service | ||
| (IMDSv2)][aws-ec2-imdsv2], and if that times out, it falls back to v1. In Vault | ||
| 1.4, this timeout could take up to 2 minutes. In Vault 1.5 and later, it can |
There was a problem hiding this comment.
I wonder if we should explicitly call out the patch version instead, i.e. 1.5.5.
website/pages/docs/auth/aws.mdx
Outdated
| by Vault first attempts to connect to [v2 of the instance metadata service | ||
| (IMDSv2)][aws-ec2-imdsv2], and if that times out, it falls back to v1. In Vault | ||
| 1.4, this timeout could take up to 2 minutes. In Vault 1.5 and later, it can | ||
| take up to 2 seconds. The timeout occurs in situations such as Vault running in |
There was a problem hiding this comment.
We tested specifically for the Docker case, but I think this can also happen if the host has a proxy in front of it which requires an extra hop before it can reach IMDSv2.
There was a problem hiding this comment.
Good point, I reworded that part a bit to make it more general, and mention docker as a specific case.
One blurb for the docs pages and one for the .0 upgrade pages. Also added to s3 and dynamodb pages.
Good idea, I added a note to the 1.4.0 and 1.5.0 pages, with links in the PR description. |
In auth/aws, seal/awskms, and secrets/aws, storage/s3, and storage/dynamodb. One blurb for the docs pages and one for the .0 upgrade pages.
Used one included file in the docs pages. Preview links:
Added a note to the upgrade pages for 1.4.0 and 1.5.0 as well.
Related to #10133