From e077bc66a89220b0326f65f0bc5fea96f2576483 Mon Sep 17 00:00:00 2001 From: Marcin Chrzanowski Date: Wed, 29 Jan 2020 22:32:35 +0100 Subject: Describe demo setup scripts --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3a5ad5b..834574a 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,55 @@ a hard-coded test hierarchy. ./gradlew test --tests InterpreterTests.fileTest13 Generates an HTML test report at `build/reports/tests/test/index.html`. + +## Demo setup + +The `scripts/` directory contains a bundle of scripts that can be helpful when +setting up a simple hierarchy. + +### Envrionment Variables + +The scripts assume that there are 5 machines with hostnames `rainbow01`, ..., +`rainbow05`. Each machine should have the following environment variables +available: + +* `NODE_NUMBER`: ranging from `01` to `05` +* `ZONE`: a level-1 zone name (e.g. `uw`) + +For example, if `rainbow01` corresponds to node `/uw/rainbow01` in the +hierarchy, it should have `NODE_NUMBER=01` and `ZONE=uw`. + +### RMI registry + +Each node should have an RMI registry running, started with + + ./scripts/registry + +### Query signer + +The scripts assume that the query signer runs on `rainbow01`. Before starting +it, run + + ./scripts/generate_keys.sh + +If `rainbow01` has ssh access to the other machines, the public key can then be +distributed with + + ./scripts/copyKey.sh + +Finally, start the query signer on `rainbow01` with + + ./scripts/runQuerySigner.sh + +### Agent and fetcher + +On each machine, the agent and fetcher components should be started with + + ./scripts/runAgent.sh + ./scripts/runFetcher.sh + +### Client (optional) + +A client connected to the local agent can be optionally started with + + ./scripts/runClient.sh -- cgit v1.2.3 From 7b8d1f5adfe49341de5cd2b595030955c2186ac8 Mon Sep 17 00:00:00 2001 From: Marcin Chrzanowski Date: Wed, 29 Jan 2020 22:37:50 +0100 Subject: Mention that keys need only be generated once --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 834574a..e159904 100644 --- a/README.md +++ b/README.md @@ -79,11 +79,13 @@ Each node should have an RMI registry running, started with ### Query signer -The scripts assume that the query signer runs on `rainbow01`. Before starting -it, run +The scripts assume that the query signer runs on `rainbow01`. Before first +starting it, run ./scripts/generate_keys.sh +to generate keys. + If `rainbow01` has ssh access to the other machines, the public key can then be distributed with -- cgit v1.2.3 From c964ff60a53ec57c4da02bce9cb7d8ef5cb3f806 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magdalena=20Grodzi=C5=84ska?= Date: Wed, 29 Jan 2020 23:04:51 +0100 Subject: Add flags README --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 46 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e159904..d4689c3 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ## Running -The agent, fetcher, and interpreter take an optional `-Dhostname= Date: Wed, 29 Jan 2020 23:06:22 +0100 Subject: Small fixes to README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d4689c3..5000d06 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,11 @@ Flags: * port - public UDP port, default: 5999 * timeout - UDP server timeout, default: 5 * 1000 * bufsize - UDP message buffer size, default: 512 -* zoneSelectionStrategy - zone selection strategy for gossiping, default: RandomUniform +* zoneSelectionStrategy - zone selection strategy for gossiping, default: RandomUniform, available options: RoundRobinExp, RoundRobinUniform, RandomExp, RandomUniform * zonePath - zone pathname of agent, default: /uw/violet07 -* publicKeyFilename - path to public key file, relative to root of project, default: build/tmp/query_signer.pub +* publicKeyFilename - path to public key file, relative to root of project, + default: build/tmp/query_signer.pub ### Client @@ -75,6 +76,7 @@ Flags: * ownAddr - public IP address or domain name of agent/fetcher machine * fallbackContacts - initialize fallback contacts, default: {}, example: + -DfallbackContacts=\{\"/uw/violet07\":[192,168,0,11]} ### Interpreter -- cgit v1.2.3 From d7efd88eedd47d0879a1fb3712f3a622ece5a9e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magdalena=20Grodzi=C5=84ska?= Date: Wed, 29 Jan 2020 23:07:19 +0100 Subject: One last fix to flags, lol --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5000d06..877b150 100644 --- a/README.md +++ b/README.md @@ -74,10 +74,7 @@ Flags: * hostname - agent RMI API hostname, default: localhost * zonePath - zone pathname of agent, default: /uw/violet07 * ownAddr - public IP address or domain name of agent/fetcher machine -* fallbackContacts - initialize fallback contacts, default: {}, example: - - - -DfallbackContacts=\{\"/uw/violet07\":[192,168,0,11]} +* fallbackContacts - initialize fallback contacts, default: {}, example: \{\"/uw/violet07\":[192,168,0,11]} ### Interpreter -- cgit v1.2.3