upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-06-10 17:32:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

docs: Clarify the utility of DynamoDB capacities

Browse source 
When configuring DynamoDB, the read and write capacities configured only
have any effect if the table does not exist. As per the comment in the
code [1], the configuration of an existing table is never modified. This
was not previously reflected in the documentation - this commit
rectifies that.

[1]: https://github.com/hashicorp/vault/blob/master/physical/dynamodb/dynamodb.go#L743-L745
This commit is contained in:
James Nugent 2018-12-03 17:55:18 -06:00
parent 5a70c5b0ec
commit ac784f400d
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
website/source/docs/configuration/storage/dynamodb.html.md
View file

@ -51,8 +51,9 @@ see the [official AWS DynamoDB documentation][dynamodb-rw-capacity].
provided via the environment variable `AWS_DEFAULT_REGION`.
- `read_capacity` `(int: 5)` – Specifies the maximum number of reads consumed
per second on the table. This can also be provided via the environment
variable `AWS_DYNAMODB_READ_CAPACITY`.
per second on the table, for use if Vault creates the DynamoDB table. This has
no effect if the `table` already exists. This can also be provided via the
environment variable `AWS_DYNAMODB_READ_CAPACITY`.
- `table` `(string: "vault-dynamodb-backend")` – Specifies the name of the
DynamoDB table in which to store Vault data. If the specified table does not
@ -61,8 +62,9 @@ see the [official AWS DynamoDB documentation][dynamodb-rw-capacity].
information on the table schema below.
- `write_capacity` `(int: 5)` – Specifies the maximum number of writes performed
per second on the table. This can also be provided via the environment
variable `AWS_DYNAMODB_WRITE_CAPACITY`.
per second on the table, for use if Vault creates the DynamoDB table. This value
has no effect if the `table` already exists. This can also be provided via the
environment variable `AWS_DYNAMODB_WRITE_CAPACITY`.
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
@ -146,6 +148,14 @@ resource "aws_dynamodb_table" "dynamodb-table" {
}
```
If a table with the configured name already exists, Vault will not modify it -
and the Vault configuration values of `read_capacity` and `write_capacity` have
no effect.
If the table does not already exist, Vault will try to create it, with read and
write capacities set to the values of `read_capacity` and `write_capacity`
respectively.
## DynamoDB Examples of Vault Configuration
### Custom Table and Read-Write Capacity