Skip to content

Commit

Permalink
Update the README files under scalardb and scalardl directories (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
komamitsu authored Jul 25, 2024
1 parent c08ceea commit 08c19ef
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions scalardb/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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`
Expand Down
10 changes: 5 additions & 5 deletions scalardl/README.md
Original file line number Diff line number Diff line change
@@ -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`
Expand All @@ -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
Expand Down

0 comments on commit 08c19ef

Please sign in to comment.