Skip to content

Commit

Permalink
Update quickstart guide
Browse files Browse the repository at this point in the history
Signed-off-by: Leonid Kondrashov <[email protected]>
  • Loading branch information
leokondrashov committed Feb 13, 2024
1 parent eebb8c8 commit 0d25965
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 16 deletions.
25 changes: 10 additions & 15 deletions docs/quickstart_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,12 @@ SSD-equipped nodes are highly recommended. Full list of CloudLab nodes can be fo

### 4. Go Installation

If you intend to build the setup scripts from source, you need to install go by running `./scripts/install_go.sh; source /etc/profile`.
If you intend to build the setup scripts from source, you need to install go by running: (This will install version `1.19.10`. You can configure the version to install in `configs/setup/system.json` as `GoVersion`)
```bash
./scripts/install_go.sh; source /etc/profile
```

This will install version `1.19.10`. You can configure the version to install in `configs/setup/system.json` as `GoVersion`.
Another option is to install using official instructions: [https://golang.org/doc/install](https://golang.org/doc/install).

- Confirm the installation:
```bash
Expand All @@ -73,7 +76,6 @@ This will install version `1.19.10`. You can configure the version to install in
```
3. Get the setup scripts:
```bash
# Build from source
pushd scripts && go build -o setup_tool && popd && mv scripts/setup_tool .
```

Expand Down Expand Up @@ -192,14 +194,7 @@ This will install version `1.19.10`. You can configure the version to install in
> ```
> **Leave this hanging in the terminal as we will go back to this later.**
>
> However, in the current working directory, you will see a yaml file named `masterKey.yaml` in following format:
> ```yaml
> ApiserverAdvertiseAddress: <IP Address>
> ApiserverPort: <Port>
> ApiserverToken: <Token>
> ApiserverTokenHash: <Token Hash>
> ```
> You will use this file during subsequent settings.
> This step will print the command to join the cluster, run it on each worker node.
> **IMPORTANT:**
> If you built the cluster using the `stock-only` flag, execute the following
Expand Down Expand Up @@ -322,15 +317,15 @@ for benchmarking asynchronous (i.e., Knative Eventing) case and more details abo
1. Clone vSwarm repo:
```bash
git clone --depth=1 --branch=v1.0 https://github.com/vhive-serverless/vSwarm ../vswarm
cd ../vswarm
git clone --depth=1 --branch=v1.0 https://github.com/vhive-serverless/vSwarm ~/vswarm
cd ~/vswarm
```
**Note:** all the following commands in this section should be executed from the `vswarm` directory. To return to the `vhive` directory, run `cd -`.
2. Optionally, configure the types and the number of functions to deploy in `tools/deployer/functions.json`.
3. Run the deployer client:
```bash
source /etc/profile && pushd ./tools/deployer && go build && popd && ./tools/deployer/deployer
source /etc/profile && pushd ./tools/deployer && go build && popd && ./tools/deployer/deployer -funcPath ~/vhive/configs/knative_workloads
```
> **BEWARE:**
>
Expand All @@ -349,7 +344,7 @@ for benchmarking asynchronous (i.e., Knative Eventing) case and more details abo
1. Run the invoker client:
```bash
pushd ./tools/invoker && go build && popd && ./tools/invoker/invoker
pushd ./tools/invoker && go mod tidy && go build && popd && ./tools/invoker/invoker
```
> **Note:**
Expand Down
3 changes: 2 additions & 1 deletion scripts/cluster/create_multinode_cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ func ExtractMasterNodeInfo() error {
return err
}

utils.SuccessPrintf("Master node key information has been written to %s/masterKey.yaml! Check for details.\n", configs.System.CurrentDir)
utils.SuccessPrintf("Join cluster from worker nodes with command: sudo kubeadm join %s:%s --token %s --discovery-token-ca-cert-hash %s\n",
configs.Kube.ApiserverAdvertiseAddress, configs.Kube.ApiserverPort, configs.Kube.ApiserverToken, configs.Kube.ApiserverTokenHash)

return nil
}
Expand Down

0 comments on commit 0d25965

Please sign in to comment.