Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README files under scalardb and scalardl directories #129

Merged
merged 2 commits into from
Jul 25, 2024
Merged

Update the README files under scalardb and scalardl directories #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bda701f
Add --ssh-private-key option to scalardb/README
komamitsu Jul 24, 2024
e33db1f
Remove space between "Scalar" and "DB"/"DL"
komamitsu Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions scalardb/README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading