From ae9f57e58912c180c3384dda0e4c0eabc88feb41 Mon Sep 17 00:00:00 2001
From: shyam Jesal <s.jesalpura@gmail.com>
Date: Wed, 14 Apr 2021 20:28:14 +0530
Subject: [PATCH] docs update + minor tweaks

Signed-off-by: shyam Jesal <s.jesalpura@gmail.com>
---
 CHANGELOG.md                                    |  2 ++
 configs/.wordlist.txt                           |  2 ++
 docs/quickstart_guide.md                        | 12 +++++++++++-
 scripts/cloudlab/start_onenode_vhive_cluster.sh | 15 +++++++++++++--
 4 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7df80b7b4..e13cd780c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -30,6 +30,8 @@ More info [here](./docs/developers_guide.md#MinIO-S3-service)
 Other
 - vHive now also supports vanilla Knative benchmarking and testing (i.e., using containers for function sandboxes).
 More info [here](./docs/developers_guide.md#Testing-stock-Knative-images).
+- Added [script](./scripts/cloudlab/start_onenode_vhive_cluster.sh) to (re)start vHive single node cluster in a push-button.
+- CRI test logs are now stored as GitHub artifacts.
 
 
 ### Changed
diff --git a/configs/.wordlist.txt b/configs/.wordlist.txt
index d10a56e3c..9f6607d26 100644
--- a/configs/.wordlist.txt
+++ b/configs/.wordlist.txt
@@ -23,6 +23,7 @@ ASBD
 Asheim
 ASPLOS
 autoscaling
+autostart
 backend
 Backend
 baseurl
@@ -240,6 +241,7 @@ NUMA
 OCI
 Ocin
 OneLab
+onenode
 Onur
 OpenCV
 orchestrator
diff --git a/docs/quickstart_guide.md b/docs/quickstart_guide.md
index 790f31735..2cf2c8a21 100644
--- a/docs/quickstart_guide.md
+++ b/docs/quickstart_guide.md
@@ -118,13 +118,23 @@ kn service delete --all
 
 ## Setup a single-node cluster (master and worker functionality on the same node)
 
-```
+### Manual (Recommended)
+Start each component separately.
+
+```bash
 ./scripts/cloudlab/setup_node.sh
 sudo containerd
 sudo PATH=$PATH /usr/local/bin/firecracker-containerd --config /etc/firecracker-containerd/config.toml
 source /etc/profile && go build && sudo ./vhive
 ./scripts/cluster/create_one_node_cluster.sh
 ```
+### Using autostart script
+This script stops the existing cluster if any, cleans up and then starts a fresh single-node cluster.
+
+```bash
+scripts/cloudlab/start_onenode_vhive_cluster.sh <folder to store logs>
+```
+
 ### Clean up
 ```bash
 ./scripts/github_runner/clean_cri_runner.sh
diff --git a/scripts/cloudlab/start_onenode_vhive_cluster.sh b/scripts/cloudlab/start_onenode_vhive_cluster.sh
index 976b39454..e64142e88 100755
--- a/scripts/cloudlab/start_onenode_vhive_cluster.sh
+++ b/scripts/cloudlab/start_onenode_vhive_cluster.sh
@@ -28,10 +28,21 @@ SCRIPTS=$ROOT/scripts
 
 $SCRIPTS/github_runner/clean_cri_runner.sh
 
-CTRDLOGDIR=/tmp/ctrd-logs/$GITHUB_RUN_ID
+CTRDLOGDIR=$1
+
+if [ -z $CTRDLOGDIR ] && [ -z "$GITHUB_RUN_ID" ] ; then
+    echo "[ERROR]: The log-directory argument is missing"
+    echo "USAGE: start_onenode_vhive_cluster.sh <Directory to store logs>" 
+    exit -1
+else
+    if [ -z "$CTRDLOGDIR" ]; then
+        CTRDLOGDIR=/tmp/ctrd-logs/$GITHUB_RUN_ID
+    fi
+fi
 
-sudo mkdir -p -m777 -p $CTRDLOGDIR
+echo "using $CTRDLOGDIR for storing logs"
 
+sudo mkdir -p -m777 -p $CTRDLOGDIR
 sudo containerd 1>$CTRDLOGDIR/ctrd.out 2>$CTRDLOGDIR/ctrd.err &
 sleep 1s
 sudo /usr/local/bin/firecracker-containerd --config /etc/firecracker-containerd/config.toml 1>$CTRDLOGDIR/fccd.out 2>$CTRDLOGDIR/fccd.err &