Skip to content

Commit ab55312

Browse files
committed
Clarify leveldb vs cassandra
1 parent 8179ea5 commit ab55312

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

Documents/local-dependencies.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This project depends on several services, which all need to be running in order for the project to operate fully.
1+
This project depends on several services, which all need to be running in order for the project to operate fully.
22

33
Assuming you have Docker-Compose installed, the easiest way to get all of the platform's dependencies up and running with the provided docker-compose dev setup:
44

@@ -7,9 +7,15 @@ Assuming you have Docker-Compose installed, the easiest way to get all of the pl
77
Alternatively, you can start each one individually with the following instructions.
88

99

10-
##### Write Journal
10+
## Write Journal
1111

12-
* The write side of this system is supported by either a local `leveldb` database or Cassandra. By default, the local `leveldb` is utilized, and some sample data is loaded automatically.
12+
* The write side of this system is supported by either a local `leveldb` database or Cassandra.
13+
14+
### leveldb
15+
16+
`leveldb` is best for local environments and for smoke testing. To use it, set the `HMDA_IS_DEMO` environment variable to `true` in the same session where you run the project in sbt. When that var is set, the platform loads sample data automatically upon startup.
17+
18+
### Cassandra
1319

1420
If using `Cassandra` is desired, set the following environment variable:
1521

@@ -44,7 +50,7 @@ run <full local path to sample file>
4450
```
4551
A sample file is located in the following folder: `panel/src/main/resources/inst_data_2017_dummy.csv`
4652

47-
##### Read Journal
53+
## Read Journal
4854

4955
* In order to support the read side, a local PostgreSQL and Cassandra server are needed. Assuming it runs on the default port, on the same machine as the API, the following environment variable needs to be set:
5056

@@ -63,7 +69,7 @@ export CASSANDRA_CLUSTER_HOSTS=192.168.99.100
6369
export CASSANDRA_CLUSTER_PORT=9042
6470
```
6571

66-
##### Apache Zookeeper
72+
## Apache Zookeeper
6773

6874
* The `HMDA Platform` is a distributed system that is meant to be run as a clustered application in production.
6975
As such, it needs a mechanism for storing configuration information for additional nodes joining the cluster.

0 commit comments

Comments
 (0)