Skip to content

Commit 7acacbb

Browse files
committed
Updated docs
Signed-off-by: aryans1204 <arshar1204@gmail.com>
1 parent 6befe01 commit 7acacbb

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs/generate_deploy_info_docs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `deploy_info.json` file is used to identify deployment information for servi
44

55
## Schema and Usage
66

7-
The `deploy_info.json` file in the `vSwarm_deploy_metadata.tar.gz` is used to identify the relative file paths for the Knative YAML manifests for deploying vSwarm functions. It is generated using `workloads/container/generate_deploy_info.py` Python script, which outputs a JSON that embeds the yaml-location and pre-deployment commands for every vSwarm function. It also contains the path of YAML files needed as part of the pre-deployment commands to run certain vSwarm benchmarks, for example the `online-shop-database` which requires to be deployed before running `cartservice` benchmark.
7+
The `deploy_info.json` file in the `vSwarm_deploy_metadata.tar.gz` is used to identify the relative file paths for the Knative YAML manifests for deploying vSwarm functions. It also contains the path of YAML files needed as part of the pre-deployment commands to run certain vSwarm benchmarks, for example the `online-shop-database` which requires to be deployed before running `cartservice` benchmark.
88

99
The `deploy_info.json` has the following schema:
1010
```console
@@ -17,7 +17,8 @@ The `deploy_info.json` has the following schema:
1717
}
1818
```
1919

20-
The `PredeploymentPath` is the path to the YAML file, which is applied via `kubectl apply -f`, before creating the service under `YamlLocation`. This pre-deployment step is required in some vSwarm benchmarks, like `cartservice` which depends on a separate service `online-shop-database` before it can be started.
20+
The `PredeploymentPath` is the path to the YAML file, which is applied via `kubectl apply -f`, before creating the service under `YamlLocation`.
21+
2122
## Deployment File Generation
2223

2324
While the `deploy_info.json` file ships with the `vSwarm_deploy_metadata.tar.gz`, In order to regenerate the `deploy_info.json` run from the root of this repository:

docs/loader.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,12 +134,12 @@ To run load generator use the following command:
134134
```bash
135135
$ go run cmd/loader.go --config cmd/config_knative_trace.json
136136
```
137-
To run load generator to use vSwarm functions based on `mapper_output.json` run the following:
137+
To run load generator with vSwarm functions based on `mapper_output.json` run the following:
138138

139139
```bash
140140
$ go run cmd/loader.go --config cmd/config_vswarm_trace.json
141141
```
142-
The difference between instructing the loader to run vSwarm functions is by setting the `VSwarm` flag in the loader configuration to `true`. For information on how to configure the workload for load generator, please refer to `docs/configuration.md`.
142+
To direct the loader to execute vSwarm functions, set the `VSwarm` flag in the loader configuration `true`. For information on how to configure the workload for load generator, please refer to `docs/configuration.md`.
143143

144144
Additionally, one can specify log verbosity argument as `--verbosity [info, debug, trace]`. The default value is `info`.
145145

0 commit comments

Comments
 (0)