a3dfde5cec
* conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
86 lines
2.8 KiB
Markdown
86 lines
2.8 KiB
Markdown
---
|
||
layout: "docs"
|
||
page_title: "S3 - Storage Backends - Configuration"
|
||
sidebar_title: "S3"
|
||
sidebar_current: "docs-configuration-storage-s3"
|
||
description: |-
|
||
The S3 storage backend is used to persist Vault's data in an Amazon S3
|
||
bucket.
|
||
---
|
||
|
||
# S3 Storage Backend
|
||
|
||
The S3 storage backend is used to persist Vault's data in an [Amazon S3][s3]
|
||
bucket.
|
||
|
||
- **No High Availability** – the S3 storage backend does not support high
|
||
availability.
|
||
|
||
- **Community Supported** – the S3 storage backend is supported by the
|
||
community. While it has undergone review by HashiCorp employees, they may not
|
||
be as knowledgeable about the technology. If you encounter problems with them,
|
||
you may be referred to the original author.
|
||
|
||
```hcl
|
||
storage "s3" {
|
||
access_key = "abcd1234"
|
||
secret_key = "defg5678"
|
||
bucket = "my-bucket"
|
||
}
|
||
```
|
||
|
||
## `s3` Parameters
|
||
|
||
- `bucket` `(string: <required>)` – Specifies the name of the S3 bucket. This
|
||
can also be provided via the environment variable `AWS_S3_BUCKET`.
|
||
|
||
- `endpoint` `(string: "")` – Specifies an alternative, AWS compatible, S3
|
||
endpoint. This can also be provided via the environment variable
|
||
`AWS_S3_ENDPOINT`.
|
||
|
||
- `region` `(string "us-east-1")` – Specifies the AWS region. This can also be
|
||
provided via the environment variable `AWS_REGION` or `AWS_DEFAULT_REGION`,
|
||
in that order of preference.
|
||
|
||
The following settings are used for authenticating to AWS. If you are
|
||
running your Vault server on an EC2 instance, you can also make use of the EC2
|
||
instance profile service to provide the credentials Vault will use to make
|
||
S3 API calls. Leaving the `access_key` and `secret_key` fields empty will
|
||
cause Vault to attempt to retrieve credentials from the AWS metadata service.
|
||
|
||
- `access_key` – Specifies the AWS access key. This can also be provided via
|
||
the environment variable `AWS_ACCESS_KEY_ID`, AWS credential files, or by
|
||
IAM role.
|
||
|
||
- `secret_key` – Specifies the AWS secret key. This can also be provided via
|
||
the environment variable `AWS_SECRET_ACCESS_KEY`, AWS credential files, or
|
||
by IAM role.
|
||
|
||
- `session_token` `(string: "")` – Specifies the AWS session token. This can
|
||
also be provided via the environment variable `AWS_SESSION_TOKEN`.
|
||
|
||
- `max_parallel` `(string: "128")` – Specifies the maximum number of concurrent
|
||
requests to S3.
|
||
|
||
- `s3_force_path_style` `(string: "false")` - Specifies whether to use host
|
||
bucket style domains with the configured endpoint.
|
||
|
||
- `disable_ssl` `(string: "false")` - Specifies if SSL should be used for the
|
||
endpoint connection (highly recommended not to disable for production).
|
||
|
||
## `s3` Examples
|
||
|
||
### Default Example
|
||
|
||
This example shows using Amazon S3 as a storage backend.
|
||
|
||
```hcl
|
||
storage "s3" {
|
||
access_key = "abcd1234"
|
||
secret_key = "defg5678"
|
||
bucket = "my-bucket"
|
||
}
|
||
```
|
||
|
||
[s3]: https://aws.amazon.com/s3/
|