Skip to content

Commit

Permalink
Add Python virtualenv installation in Salvo's readme. (#264)
Browse files Browse the repository at this point in the history
I want to build Salvo following the readme. And I find that virtualenv installation step is missing, which is a necessary dependency for building Salvo.

Signed-off-by: Xin Huang <[email protected]>
Co-authored-by: Jakub Sobon <[email protected]>
  • Loading branch information
gyohuangxin and mum4k authored Jan 29, 2024
1 parent 2b478ea commit 695c4e0
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions salvo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@ command as follows:
sudo http_proxy="example.com:port" https_proxy="example.com:port" apt install ...
```

### Python virtual environment

Salvo uses a Python virtual environment located in the `salvo/salvo_venv`
directory. This environment is created when `./ci/do_ci.sh` is executed. The
`./ci/do_ci.sh` script reuses a previously created virtual environment if found.

Therefore, you need to install the Python virtualenv dependencies, please refer to:
https://virtualenv.pypa.io/en/latest/installation.html

If you encounter issues related to Python dependencies, a good first step in
debugging is to remove the existing virtual environment by deleting the
`salvo/salvo_venv` directory.

## Building Salvo

To build Salvo, use the following command:
Expand All @@ -62,16 +75,6 @@ export SOURCE_DIR_MOUNT_DEST=path_of_your_envoy-perf
ci/run_envoy_docker.sh 'ci/do_ci.sh build'
```

### Python virtual environment

Salvo uses a Python virtual environment located in the `salvo/salvo_venv`
directory. This environment is created when `./ci/do_ci.sh` is executed. The
`./ci/do_ci.sh` script reuses a previously created virtual environment if found.

If you encounter issues related to Python dependencies, a good first step in
debugging is to remove the existing virtual environment by deleting the
`salvo/salvo_venv` directory.

## Benchmark Test Cases for Salvo

Benchmark test cases for Salvo are defined as Python files with test cases written in pytest
Expand Down

0 comments on commit 695c4e0

Please sign in to comment.