blob: 0d871cc1e1c1b0f2d0c71baa5b542163ea377925 [file] [log] [blame] [view]
Configuration
=========================
The dynamodb-refdb plugin is configured by adding a plugin stanza in the
`gerrit.config` file, for example:
```text
[plugin "aws-dynamodb-refdb"]
region = us-east-1
endpoint = http://localhost:4566
locksTableName = lockTable
refsDbTableName = refsDb
profileName = aws-dynamodb-refdb
```
`plugin.aws-dynamodb-refdb.region`
: Optional. Which AWS region to connect to.
Default: When not specified this value is provided via the default Region
Provider Chain, as explained [here](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html)
`plugin.aws-dynamodb-refdb.endpoint`
: Optional. When defined, it will override the default dynamodb endpoint
will connect to it, rather than connecting to AWS. This is useful when
developing or testing, in order to connect locally.
See [localstack](https://github.com/localstack/localstack) to understand
more about how run dynamodb stack outside AWS.
Default: <empty>
`plugin.aws-dynamodb-refdb.locksTableName`
: Optional. The name of the dynamoDB table used to store distribute locking
See [DynamoDB lock client](https://github.com/awslabs/amazon-dynamodb-lock-client)
`plugin.aws-dynamodb-refdb.locksTableName`
: Optional. The name of the dynamoDB table used to store git refs and their
associated sha1.
`plugin.aws-dynamodb-refdb.profileName`
: Optional. The name of the aws configuration and credentials profile used to
connect to the DynamoDb. See [Configuration and credential file settings](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)
Default: When not specified credentials are provided via the Default Credentials
Provider Chain, as explained [here](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html)