Skip to content

Commit 2aea6aa

Browse files
author
Callum Bodels
authored
docs: removing trailing whitespace (aws#76)
Removing the trailing whitespace in the README.md to improve the formatting and readability of the file.
1 parent 112b05b commit 2aea6aa

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,26 @@ Instructions for installing AWS Lambda Runtime Interface Emulator for your platf
2626

2727
## Getting started
2828

29-
There are a few ways you use the Runtime Interface Emulator (RIE) to locally test your function depending on the base image used.
29+
There are a few ways you use the Runtime Interface Emulator (RIE) to locally test your function depending on the base image used.
3030

3131

3232
### Test an image with RIE included in the image
3333

34-
The AWS base images for Lambda include the runtime interface emulator. You can also follow these steps if you built the RIE into your alternative base image.
34+
The AWS base images for Lambda include the runtime interface emulator. You can also follow these steps if you built the RIE into your alternative base image.
3535

3636
#### To test your Lambda function with the emulator
3737

38-
1. Build your image locally using the docker build command.
38+
1. Build your image locally using the docker build command.
3939

4040
`docker build -t myfunction:latest .`
4141

42-
2. Run your container image locally using the docker run command.
42+
2. Run your container image locally using the docker run command.
4343

4444
`docker run -p 9000:8080 myfunction:latest`
4545

46-
This command runs the image as a container and starts up an endpoint locally at `localhost:9000/2015-03-31/functions/function/invocations`.
46+
This command runs the image as a container and starts up an endpoint locally at `localhost:9000/2015-03-31/functions/function/invocations`.
4747

48-
3. Post an event to the following endpoint using a curl command:
48+
3. Post an event to the following endpoint using a curl command:
4949

5050
`curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'`
5151

@@ -71,7 +71,7 @@ The following example shows a typical script for a Node.js function.
7171
fi
7272
```
7373

74-
2. Download the [runtime interface emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest) for your target architecture (`aws-lambda-rie` for x86\_64 or `aws-lambda-rie-arm64` for arm64) from GitHub into your project directory.
74+
2. Download the [runtime interface emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest) for your target architecture (`aws-lambda-rie` for x86\_64 or `aws-lambda-rie-arm64` for arm64) from GitHub into your project directory.
7575

7676
3. Install the emulator package and change `ENTRYPOINT` to run the new script by adding the following lines to your Dockerfile:
7777

@@ -108,30 +108,30 @@ You install the runtime interface emulator to your local machine. When you run t
108108
mkdir -p ~/.aws-lambda-rie && curl -Lo ~/.aws-lambda-rie/aws-lambda-rie \
109109
https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie \
110110
&& chmod +x ~/.aws-lambda-rie/aws-lambda-rie
111-
```
111+
```
112112
113113
To download the RIE for arm64 architecture, use the previous command with a different GitHub download url.
114114
```
115115
https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie-arm64 \
116116
```
117117
118-
2. Run your Lambda image function using the docker run command.
118+
2. Run your Lambda image function using the docker run command.
119119
```
120-
docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 myfunction:latest
120+
docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 myfunction:latest
121121
--entrypoint /aws-lambda/aws-lambda-rie <image entrypoint> <(optional) image command>`
122122
```
123123
124-
This runs the image as a container and starts up an endpoint locally at `localhost:9000/2015-03-31/functions/function/invocations`.
124+
This runs the image as a container and starts up an endpoint locally at `localhost:9000/2015-03-31/functions/function/invocations`.
125125
126-
3. Post an event to the following endpoint using a curl command:
126+
3. Post an event to the following endpoint using a curl command:
127127
128128
`curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'`
129129
130130
This command invokes the function running in the container image and returns a response.
131131
132-
## How to configure
132+
## How to configure
133133
134-
`aws-lambda-rie` can be configured through Environment Variables within the local running Image.
134+
`aws-lambda-rie` can be configured through Environment Variables within the local running Image.
135135
You can configure your credentials by setting:
136136
* `AWS_ACCESS_KEY_ID`
137137
* `AWS_SECRET_ACCESS_KEY`
@@ -147,17 +147,17 @@ The rest of these Environment Variables can be set to match AWS Lambda's environ
147147
148148
## Level of support
149149
150-
You can use the emulator to test if your function code is compatible with the Lambda environment, executes successfully
151-
and provides the expected output. For example, you can mock test events from different event sources. You can also use
152-
it to test extensions and agents built into the container image against the Lambda Extensions API. This component
153-
does *not *emulate* *the orchestration behavior of AWS Lambda. For example, Lambda has a network and security
154-
configurations that will not be emulated by this component.
150+
You can use the emulator to test if your function code is compatible with the Lambda environment, executes successfully
151+
and provides the expected output. For example, you can mock test events from different event sources. You can also use
152+
it to test extensions and agents built into the container image against the Lambda Extensions API. This component
153+
does *not *emulate* *the orchestration behavior of AWS Lambda. For example, Lambda has a network and security
154+
configurations that will not be emulated by this component.
155155
156156
157157
* You can use the emulator to test if your function code is compatible with the Lambda environment, runs successfully and provides the expected output.
158158
* You can also use it to test extensions and agents built into the container image against the Lambda Extensions API.
159-
* This component does _not_ emulate Lambda’s orchestration, or security and authentication configurations.
160-
* The component does _not_ support X-ray and other Lambda integrations locally.
159+
* This component does _not_ emulate Lambda’s orchestration, or security and authentication configurations.
160+
* The component does _not_ support X-ray and other Lambda integrations locally.
161161
* The component supports only Linux, for x86-64 and arm64 architectures.
162162
163163
## Security

0 commit comments

Comments
 (0)