Skip to content

Commit

Permalink
docs: Updating the docs for new JULEA and packages (#57)
Browse files Browse the repository at this point in the history
* docs: update julea instructions

* docs: add libpmem install instructions
  • Loading branch information
jwuensche authored Apr 10, 2024
1 parent 0d678fe commit 76f6319
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
12 changes: 6 additions & 6 deletions docs/src/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,21 @@ bindings.
### Fedora/RHEL

```sh
$ sudo dnf install glib2 glib2-devel libbson libbson-devel clang make pkgconf
$ sudo dnf install glib2 glib2-devel libbson libbson-devel clang make pkgconf libpmem libpmem-devel
```

### Ubuntu/Debian/...

```sh
$ sudo apt update
$ sudo apt install libglib2.0-0 libglib2.0-dev libbson-1.0-0 libbson-dev clang make pkg-config
$ sudo apt install libglib2.0-0 libglib2.0-dev libbson-1.0-0 libbson-dev clang make pkg-config libpmem1 libpmem-dev
```

### Arch Linux+

> Arch Linux does not package libpmem, if you want to use it you may try the
> AUR. Otherwise, compile without the `nvm` feature.
```sh
$ sudo pacman -Sy glib2 clang make libbson pkgconf
```
Expand All @@ -53,10 +56,7 @@ $ sudo pacman -Sy glib2 clang make libbson pkgconf
To compile the bindings you'll need JULEA present and specify it's headers in your environemnt.

```sh
# git clone https://github.com/parcio/julea.git
# Support for seamless integration is not quite there yet in JULEA, we require a special fork
$ git clone -b modules-conditional-unload https://github.com/tilpner/julea.git
$ git clone https://github.com/parcio/haura.git
$ git clone https://github.com/parcio/julea.git
```

To build the complete _Haura_ project from this state, execute:
Expand Down
19 changes: 11 additions & 8 deletions docs/src/julea-betree/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ have to set the appropriate flags for `julea-config`. The example below uses the
user instance of haura as used in [bectl documentation](../bectl/usage.md).

```sh
julea-config --user \
julea-config --user \
--object-servers="$(hostname)" --kv-servers="$(hostname)" --db-servers="$(hostname)" \
--object-backend=betree --object-component=server --object-path="$HOME/.config/haura.json" \
--kv-backend=lmdb --kv-component=server --kv-path="/tmp/julea-$(id -u)/lmdb" \
--db-backend=sqlite --db-component=server --db-path="/tmp/julea-$(id -u)/sqlite"
--object-backend=betree --object-path="$HOME/.config/haura.json" \
--kv-backend=lmdb --kv-path="/tmp/julea-$(id -u)/lmdb" \
--db-backend=sqlite --db-path="/tmp/julea-$(id -u)/sqlite"
```

## Prepare the library
Expand Down Expand Up @@ -49,7 +49,7 @@ $ cp target/debug/libobject_betree.so $JULEA_BACKEND_PATH/libobject-betree.so

## Start JULEA

To start now JULEA run
To start JULEA, navigate back to it's directory and run

```sh
$ ./scripts/setup.sh start
Expand All @@ -63,9 +63,12 @@ $ journalctl -e GLIB_DOMAIN=JULEA
> On success this should look like this (some details will look different on
> your machine):
> ```
> Nov 24 14:41:54 nicomedia julea-server[133661]: Initialized object backend betree.
> Nov 24 14:41:54 nicomedia julea-server[133661]: Initialized kv backend lmdb.
> Nov 24 14:41:54 nicomedia julea-server[133661]: Initialized db backend sqlite.
> Apr 10 11:46:31 nicomedia julea-server[15742]: Loaded object backend betree.
> Apr 10 11:46:32 nicomedia julea-server[15742]: Initialized object backend betree.
> Apr 10 11:46:32 nicomedia julea-server[15742]: Loaded kv backend lmdb.
> Apr 10 11:46:32 nicomedia julea-server[15742]: Initialized kv backend lmdb.
> Apr 10 11:46:32 nicomedia julea-server[15742]: Loaded db backend sqlite.
> Apr 10 11:46:32 nicomedia julea-server[15742]: Initialized db backend sqlite.
> ```
If everything worked fine so far you can run the JULEA test suite with
Expand Down
1 change: 1 addition & 0 deletions docs/src/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Implementation:
Bindings:
- [**julea-betree**](./julea-betree.md): Bindings exposed to be used by [JULEA](https://github.com/parcio/julea). Specifies a betree backend.
- [**julea-sys**](./julea-sys.md): Generated bindings by bindgen for use in *julea-betree*.
- [**fio-haura**](./fio-haura/mod.md): Engine for fio.

0 comments on commit 76f6319

Please sign in to comment.