Skip to content

Commit

Permalink
Add instruction about virtualenv to tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
rdettai committed Jan 18, 2024
1 parent cecdc80 commit 02ed789
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion distribution/lambda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Prerequisites

- Install AWS CDK Toolkit (cdk command)
- `npm install -g aws-cdk `
- `npm install -g aws-cdk`
- Ensure `curl` and `make` are installed
- To run the invocation example `make` commands, you will also need Python 3.10
or later and `pip` installed (see [Python venv](#python-venv) below).
Expand Down
10 changes: 7 additions & 3 deletions docs/get-started/tutorials/tutorial-aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Before running a system in the Cloud, it is always a good idea to get a rough es

### Prerequisites

We use [AWS CDK](https://aws.amazon.com/cdk/) for our infrastructure automation script. Install it using [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm):
We use [AWS CDK](https://aws.amazon.com/cdk/) for our infrastructure automation script. Install or upgrade it using [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm):
```bash
npm install -g aws-cdk
npm install -g aws-cdk@latest
```
We also use the `curl` and `make` commands. For instance on Debian based distributions:
```bash
Expand All @@ -94,11 +94,15 @@ sudo apt update && sudo apt install curl make

You also need AWS credentials to be properly configured in your shell. One way is using the [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).

Finally, clone the Quickwit repository:
Finally, clone the Quickwit repository and install the Python dependencies (Python3.10 required) in a virtual environment:
```bash
git clone https://github.com/quickwit-oss/quickwit.git
cd quickwit/distribution/lambda
python3 -m venv .venv
source .venv/bin/activate
pip install .
```

### Deploy
Configure the AWS region and [account id](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html) where you want to deploy the example stack:
```bash
Expand Down

0 comments on commit 02ed789

Please sign in to comment.