From 08c19efce52a25650b910d8032231a70a93bece9 Mon Sep 17 00:00:00 2001 From: Mitsunori Komatsu Date: Thu, 25 Jul 2024 11:38:58 +0900 Subject: [PATCH] Update the README files under `scalardb` and `scalardl` directories (#129) --- scalardb/README.md | 8 ++++---- scalardl/README.md | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/scalardb/README.md b/scalardb/README.md index 83c7f5c..a7b875d 100644 --- a/scalardb/README.md +++ b/scalardb/README.md @@ -1,6 +1,6 @@ -# Jepsen tests for Scalar DB +# Jepsen tests for ScalarDB -This guide will teach you how to run Jepsen tests for Scalar DB. +This guide will teach you how to run Jepsen tests for ScalarDB. The current tests use [Cassandra test tools in Jepsen](https://github.com/scalar-labs/scalar-jepsen/tree/cassandra). ## How to test @@ -15,13 +15,13 @@ The current tests use [Cassandra test tools in Jepsen](https://github.com/scalar $ lein install ``` -3. Run a test of Scalar DB +3. Run a test of ScalarDB ``` # in jepsen-control $ cd ${SCALAR_JEPSEN}/scalardb - $ lein run test --workload transfer --nemesis crash --admin join --time-limit 300 + $ lein run test --workload transfer --nemesis crash --admin join --time-limit 300 --ssh-private-key ~/.ssh/id_rsa ``` - For elle-* tests, `graphviz` package is required in jepsen-control. You can install it with `apt-get install graphviz` diff --git a/scalardl/README.md b/scalardl/README.md index 04eb6c1..6cc918d 100755 --- a/scalardl/README.md +++ b/scalardl/README.md @@ -1,10 +1,10 @@ -# Jepsen tests for Scalar DL +# Jepsen tests for ScalarDL -The Scalar DL Jepsen tests make use of the [Cassandra Jepsen tests](https://github.com/scalar-labs/scalar-jepsen/tree/master/cassandra). +The ScalarDL Jepsen tests make use of the [Cassandra Jepsen tests](https://github.com/scalar-labs/scalar-jepsen/tree/master/cassandra). ## How to run a test -1. Get Scalar DL - - Scalar DL is licensed under commercial license only +1. Get ScalarDL + - ScalarDL is licensed under commercial license only - A test checks `resources/ledger.tar` as default - You can specify the DL archive by `--ledger-tarball` option - A certificate and a private key for a sample is stored in `resources` @@ -22,7 +22,7 @@ The Scalar DL Jepsen tests make use of the [Cassandra Jepsen tests](https://gith $ lein install ``` -4. Run a Scalar DL Jepsen test +4. Run a ScalarDL Jepsen test ``` # in jepsen-control