machi/doc
2015-04-22 21:40:09 +09:00
..
src.high-level Oops, forgot to add chain-self-management-sketch.Diagram1.eps 2015-04-22 21:40:09 +09:00
chain-self-management-sketch.Diagram1.dia Initial documentation import 2015-03-02 13:32:56 +09:00
chain-self-management-sketch.Diagram1.pdf Initial documentation import 2015-03-02 13:32:56 +09:00
chain-self-management-sketch.org WIP: more restructuring (yay) 2015-04-22 19:26:28 +09:00
high-level-machi.pdf Add the 1st draft of high-level-machi.pdf 2015-04-20 12:54:05 +09:00
overview.edoc Add first basic round of EDoc documentation, 'make edoc' target 2015-04-08 17:32:01 +09:00
README.md Add the 1st draft of high-level-machi.pdf 2015-04-20 12:54:05 +09:00

Machi Documentation Overview

For a Web-browsable version of a snapshot of the source doc "EDoc" Erlang documentation, please use this link: Machi EDoc snapshot.

Documents in this directory

chain-self-management-sketch.org

chain-self-management-sketch.org is an introduction to the self-management algorithm proposed for Machi. This algorithm is (hoped to be) sufficient for managing the Chain Replication state of a Machi cluster.

high-level-machi.pdf

high-level-machi.pdf is an overview of the high level design for Machi. Its abstract:

Our goal is a robust & reliable, distributed, highly available large file store based upon write-once registers, append-only files, Chain Replication, and client-server style architecture. All members of the cluster store all of the files. Distributed load balancing/sharding of files is outside of the scope of this system. However, it is a high priority that this system be able to integrate easily into systems that do provide distributed load balancing, e.g., Riak Core. Although strong consistency is a major feature of Chain Replication, this document will focus mainly on eventual consistency features --- strong consistency design will be discussed in a separate document.