Paxos

This is a reference implementation of single-decree Paxos.

Configuration

By default, the program looks for a configuration file named config.yml in the working directory. This file describes the cluster membership. An example configuration is provided in this repository.

Usage

For a simple demonstration, run the following commands from separate terminals in the repository root:

paxos --node 0 --propose foo
paxos --node 1 --propose bar
paxos --node 2 --propose baz

The cluster will likely achieve consensus immediately after two of the three nodes have been started. The chosen value will be printed to STDOUT by each node in the cluster.

Here are the supported command-line options:

Usage: paxos [OPTIONS] --node <INDEX>

Options:
  -v, --version             Print version
  -n, --node <INDEX>        Set the index of the node corresponding to this instance
  -x, --propose <VALUE>     Propose a value to the cluster
  -c, --config-file <PATH>  Set the path to the config file [default: config.yml]
  -d, --data-dir <PATH>     Set the path to the directory in which to store persistent data
                            [default: data]
  -i, --ip <ADDRESS>        Set the IP address to run on (if different from the configuration)
  -p, --port <PORT>         Set the port to run on (if different from the configuration)
  -h, --help                Print help

Installation instructions

Installation on macOS or Linux (AArch64 or x86-64)

If you're running macOS or Linux (AArch64 or x86-64), you can install Paxos with this command:

curl https://raw.githubusercontent.com/stepchowfun/paxos/main/install.sh -LSfs | sh

The same command can be used again to update to the latest version.

The installation script supports the following optional environment variables:

VERSION=x.y.z (defaults to the latest version)
PREFIX=/path/to/install (defaults to /usr/local/bin)

For example, the following will install Paxos into the working directory:

curl https://raw.githubusercontent.com/stepchowfun/paxos/main/install.sh -LSfs | PREFIX=. sh

If you prefer not to use this installation method, you can download the binary from the releases page, make it executable (e.g., with chmod), and place it in some directory in your PATH (e.g., /usr/local/bin).

Installation on Windows (AArch64 or x86-64)

If you're running Windows (AArch64 or x86-64), download the latest binary from the releases page and rename it to paxos (or paxos.exe if you have file extensions visible). Create a directory called Paxos in your %PROGRAMFILES% directory (e.g., C:\Program Files\Paxos), and place the renamed binary in there. Then, in the "Advanced" tab of the "System Properties" section of Control Panel, click on "Environment Variables..." and add the full path to the new Paxos directory to the PATH variable under "System variables". Note that the Program Files directory might have a different name if Windows is configured for a language other than English.

To update an existing installation, simply replace the existing binary.

References

The Paxos algorithm was first described in [1].

Leslie Lamport. 1998. The part-time parliament. ACM Trans. Comput. Syst. 16, 2 (May 1998), 133-169. DOI: https://doi.org/10.1145/279227.279229

stepchowfun/paxos

README