mapbox / mapbox/dynamodb-replicator
Documentation: real world user documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 131
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Description
would it be possible to get some real world complete setup examples for using this tool?
Before I go further - I appreciate the hard work involved in getting this tool this far, and don't take my critical comments below in the wrong context. I'm trying to help improve the user experience for possibly the best and only complete replication and backup/restore tool for dynamo that exists today!! :)
The current documentation is just a marketing glossy - a user doesn't even have a feature-to-tool map. Where is "A replicator function that processes events from a DynamoDB stream" ? What file? I have to go become an expert in node, lambda, ddb streams, streambot to be able to consume this project.
A more complete walkthrough (even if it's only an example setup) would be great - aws cli, aws web console, just something to help a user understand all of the pieces required (and to know how to skip the pieces that are not required).
How do I setup/config DDB's streams for the purpose of using this tool?
How do I setup lambda?
IAM as it applies to the tool and relate services?
s3 as it relates to the tool? (specific bucket setup requirements for this usage?)
Other areas of concern - How does using the tool for replication, and for backups, impact ddb scaling in various scenarios?
thanks - I'd love to use it, but trying to figure out how to use this is going to be a huge undertaking and trial/error event.....
Even just a high level sketch of the pieces, without tons of detail, would be a great starting point for us to contribute to.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files or tests; start by mapping the replicator function and its DynamoDB Streams, Lambda, IAM, and S3 dependencies. Document a complete AWS CLI or web-console setup, explain which pieces are optional for replication versus backups, and cover the requested scaling considerations so a user can follow the walkthrough without trial and error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, javascript
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100