Skip to content

chore: fix poorly formatted README.md section #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 5, 2021
Merged

chore: fix poorly formatted README.md section #18

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7edae26
fix poorly formatted README.md section
sjansen Dec 22, 2020
f392902
Update README.md based on review feedback
sjansen Feb 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,32 @@ You can build RIE into a base image. Download the RIE from GitHub to your local
#### To build the emulator into your image

1. Create a script and save it in your project directory. The following example shows a typical script for a Node.js function. The presence of the AWS_LAMBDA_RUNTIME_API environment variable indicates the presence of the runtime API. If the runtime API is present, the script runs the runtime interface client (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-images.html#runtimes-api-client). Otherwise, the script runs the runtime interface emulator.
```
#!/bin/sh
if [ -z "${AWS_LAMBDA_RUNTIME_API}" ]; then
exec /usr/local/bin/aws-lambda-rie /usr/bin/npx aws-lambda-ric
else
exec /usr/bin/npx aws-lambda-ric
fi
```

2. Download the runtime interface emulator (https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie) from GitHub into your project directory.

* `#!/bin/sh if [ -z "${AWS_LAMBDA_RUNTIME_API}" ]; then exec /usr/local/bin/aws-lambda-rie /usr/bin/npx aws-lambda-ricelseexec /usr/bin/npx aws-lambda-ricfi`
* Download the runtime interface emulator (https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie) from GitHub into your project directory.
* Install the emulator package and change ENTRYPOINT to run the new script by adding the following lines to your Dockerfile:
```
ADD aws-lambda-rie /usr/local/bin/aws-lambda-rie
ENTRYPOINT [ “/entry_script.sh” ]
```
3. Install the emulator package and change ENTRYPOINT to run the new script by adding the following lines to your Dockerfile:
```
ADD aws-lambda-rie /usr/local/bin/aws-lambda-rie
ENTRYPOINT [ “/entry_script.sh” ]
```

2. Build your image locally using the docker build command.
4. Build your image locally using the docker build command.
```
docker build -t myfunction:latest .
```

`docker build -t myfunction:latest .`
`docker run -p 9000:8080 myfunction:latest`
5. Execute your image locally using the docker run command.
```
docker run -p 9000:8080 myfunction:latest
```

### Test an image without adding RIE to the image

Expand Down Expand Up @@ -110,7 +123,7 @@ You can configure timeout by setting AWS_LAMBDA_FUNCTION_TIMEOUT to the number o

The rest of these Environment Variables can be set to match AWS Lambda's environment but are not required.
* `AWS_LAMBDA_FUNCTION_VERSION`
* `AWS_LAMBDA_FUNCION_NAME`
* `AWS_LAMBDA_FUNCTION_NAME`
* `AWS_LAMBDA_MEMORY_SIZE`

## Level of support
Expand Down