luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Merge pull request #5892 from jen20/jen20/dynamodb-capacity-doc 

docs: Clarify the utility of DynamoDB capacities
This commit is contained in:
Becca Petrin 2018-12-20 11:54:26 -08:00 committed by GitHub
parent 0b2a63a6a3 65e7a2660d
commit d7f31fe5e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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