Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.43 KB

README.md

File metadata and controls

63 lines (45 loc) · 3.43 KB

What is riak_core_lite?

Riak Core Lite is a framework that simplifies the development of dynamo-style architectures, such as highly-available key-value stores and messaging systems.

Build upon the essence of Riak KV's core with an up-to-date, modular and extensible foundation for elastic distributed services.

riak_core_lite

Language Release Release Build

Hex pm Erlang CI Coverage Status

To get started with riak_core_lite you can follow Mariano Guerra's tutorials. They are based on the full riak_core, but are still applicable to riak_core_lite.

  1. Setup
  2. Starting
  3. Ping Command
  4. First Commands
  5. Quorum Requests
  6. Handoff
  7. HTTP API
  8. Persistent KV with leveled backend

Contributing

We love community code, bug fixes, and other forms of contribution. We use GitHub Issues and Pull Requests for contributions to this and all other code. To get started:

  1. Fork this repository.

  2. Clone your fork or add the remote if you already have a clone of the repository.

  3. Create a topic branch for your change.

  4. Make your change and commit. Use a clear and descriptive commit message, spanning multiple lines if detailed explanation is needed.

  5. Push to your fork of the repository and then send a pull request.

  6. A committer will review your patch and merge it into the main repository or send you feedback.

Issues, Questions, and Bugs

There are numerous ways to file issues or start conversations around something Core related

  • If you've found a bug in riak_core_lite, file a clear, concise, explanatory issue against this repo.

Reference Implementation

For some reference on how riak_core_lite can be used, you can read about projects which are using riak_core_lite as a library:

  • rcl_memkv: A minimalistic in-memory key-value store to understand how to implement the handoff behavior properly
  • rclref: A reference implementation of a distributed key-value store using riak_core_lite featuring quorum reads and writes.
  • AntidoteDB: A a highly available geo-replicated key-value database which uses riak_core_lite for sharding of data centers.