Skip to content

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jseed committed Aug 24, 2017
1 parent 6325f7a commit 46fdfc1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ The dynamodb replication solution makes use of dynamodb table streams and lambda
## Documentation
This README serves as a 'quick start' guide for getting replication up and running. Full documentation can be found in the [wiki](https://github.com/Signiant/dynamodb-replication/wiki).

## Build and Deployment
Cloudformation is used to deploy the replicator. To simplify the deployment process, the lambda function code is minified, and then injected into the cloudformation template using cfn-include, a cloudformation pre-processor. This process is automated using grunt. To build the template, execute the following steps:
## Deployment
DymanoDB replication infrastructure is managed entirely through cloudformation.
To deploy, simply use the cloudformation template from the latest [release](https://github.com/Signiant/dynamodb-replication/releases) to create a new cloudformation stack.

## Building The Template
If you're making any changes of your own to the code, you will need to generate a new cloudformation template before you can deploy. To do this, execute the following steps:

1. Install dependencies:
```
Expand All @@ -17,4 +21,4 @@ Cloudformation is used to deploy the replicator. To simplify the deployment pro
$ npm run build
```

The template will be written to dist/replication.cfn.json. Simply create a new cloudformation stack using this template to deploy the replicator.
The generated template will be output to dist/replication.cfn.json
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "dynamodb-replication",
"description": "A lambda backed dynamodb cross region replication solution",
"version": "0.1.0",
"version": "1.0.0",
"author": "Jonathan Seed <jonathan.j.seed@gmail.com>",
"repository": {
"type": "git",
Expand Down

0 comments on commit 46fdfc1

Please sign in to comment.