diff --git a/doc/README.md b/doc/README.md index 74849f7..c4d1c8c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,7 +6,27 @@ Erlang documentation, please use this link: ## Documents in this directory -* __chain-self-management-sketch.org__ is an introduction to the +### 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. + diff --git a/doc/high-level-machi.pdf b/doc/high-level-machi.pdf new file mode 100644 index 0000000..c357c2d Binary files /dev/null and b/doc/high-level-machi.pdf differ diff --git a/doc/src.high-level/high-level-machi.tex b/doc/src.high-level/high-level-machi.tex index 6f2a37f..c59c9ff 100644 --- a/doc/src.high-level/high-level-machi.tex +++ b/doc/src.high-level/high-level-machi.tex @@ -48,8 +48,7 @@ consistency have been moved to a separate document, please see \section{Abstract} \label{sec:abstract} -Our goal -is creation of a robust \& reliable, distributed, highly +Our goal is a robust \& reliable, distributed, highly available\footnote{Capable of operating in ``AP mode'' or ``CP mode'' relative to the CAP Theorem, see Section~\ref{sub:wedge}.}