aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortrinity-1686a <trinity.pointard@gmail.com>2021-12-13 14:09:28 +0100
committertrinity-1686a <trinity.pointard@gmail.com>2021-12-13 14:09:28 +0100
commit5a8be6fc734429bf80f0566fd070396be39aa008 (patch)
tree2806cd507d850c90c87f1e7dfa40ae128004cea0 /README.md
parent01c4c7196f2245858014ffd3f2b1a9dbcc91b1e2 (diff)
parent79a14c3cbc4f0553f331eb9eadfffe043b0aa792 (diff)
downloadmknet-5a8be6fc734429bf80f0566fd070396be39aa008.tar.gz
mknet-5a8be6fc734429bf80f0566fd070396be39aa008.zip
Merge pull request 'Upstreaming patches written for Garage's benchmark' (#1) from quentin/mknet:improvements into main
Reviewed-on: https://git.deuxfleurs.fr/trinity-1686a/mknet/pulls/1
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92abc61
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# mknet
+
+## Installation
+
+```bash
+sudo pip3 install git+https://git.deuxfleurs.fr/trinity-1686a/mknet
+```
+
+## Usage
+
+```bash
+sudo rm -rf /tmp/garage-testnet/ # always start by deleting previous run
+sudo mknet create ./config.yml
+sudo mknet run-all example/deploy_garage.sh
+sudo mknet run dc1:dc1s1 garage -c /tmp/garage-testnet/dc1/dc1s1/garage.toml status
+sudo mknet destroy
+```
+
+## Instrumented daemons
+
+If you want to use the scripts provided in the `example` folder,
+you must add to your path some tools.
+
+### Garage (`deploy_garage.sh`)
+
+```bash
+# see versions on https://garagehq.deuxfleurs.fr/_releases.html
+export GRG_ARCH=x86_64-unknown-linux-musl
+export GRG_VERSION=v0.5.0
+
+sudo wget https://garagehq.deuxfleurs.fr/_releases/${GRG_VERSION}/${GRG_ARCH}/garage -O /usr/local/bin/garage
+sudo chmod +x /usr/local/bin/garage
+
+garage help
+```
+
+### Minio (`deploy_minio.py`)
+
+```
+sudo wget https://dl.min.io/server/minio/release/linux-amd64/minio -O /usr/local/bin/minio
+sudo chmod +x /usr/local/bin/minio
+```
+