aboutsummaryrefslogtreecommitdiff
path: root/script/jepsen.garage/README.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2023-04-18 17:47:53 +0200
committerAlex Auvolat <alex@adnab.me>2023-10-18 12:03:11 +0200
commitdc5245ce65e6acc4c2b1f81dfdf38fc76fe06d3f (patch)
treed4917d9e89b9c1733b22bbbeae4eba5904365338 /script/jepsen.garage/README.md
parent70c1d3db46b3bbdfad55b61c29e346c629380a32 (diff)
downloadgarage-dc5245ce65e6acc4c2b1f81dfdf38fc76fe06d3f.tar.gz
garage-dc5245ce65e6acc4c2b1f81dfdf38fc76fe06d3f.zip
even without nemesis, s3 get/put/delete is not linearizable (is this normal?)
Diffstat (limited to 'script/jepsen.garage/README.md')
-rw-r--r--script/jepsen.garage/README.md34
1 files changed, 22 insertions, 12 deletions
diff --git a/script/jepsen.garage/README.md b/script/jepsen.garage/README.md
index e1d1a555..ed956830 100644
--- a/script/jepsen.garage/README.md
+++ b/script/jepsen.garage/README.md
@@ -1,22 +1,32 @@
# jepsen.garage
-A Clojure library designed to ... well, that part is up to you.
+Jepsen checking of Garage consistency properties.
## Usage
-FIXME
+Requirements:
+
+- vagrant
+- VirtualBox, configured so that nodes can take an IP in a private network `192.168.56.0/24`
+- a user that can create VirtualBox VMs
+- leiningen
+- gnuplot
+
+Set up VMs:
+
+```
+vagrant up
+```
+
+Run tests:
+
+```
+lein run test --nodes-file nodes.vagrant
+```
## License
-Copyright © 2023 FIXME
+Copyright © 2023 Alex Auvolat
This program and the accompanying materials are made available under the
-terms of the Eclipse Public License 2.0 which is available at
-http://www.eclipse.org/legal/epl-2.0.
-
-This Source Code may also be made available under the following Secondary
-Licenses when the conditions for such availability set forth in the Eclipse
-Public License, v. 2.0 are satisfied: GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or (at your
-option) any later version, with the GNU Classpath Exception which is available
-at https://www.gnu.org/software/classpath/license.html.
+terms of the GNU General Public License v3.0.