From 3f1e0fc57ed402e5af4999f5a2baaf8a29440e49 Mon Sep 17 00:00:00 2001 From: Callum Bodels Date: Thu, 5 Jan 2023 16:33:42 +0000 Subject: [PATCH] docs: corrected bullet point's content spacing/indentation The content for some bullet points are not correctly indented or spaced. This causes text and code blocks to not be displayed properly, causing confusion for customers. This change indents the content of the bullet points so it is now correctly displayed increasing readability. --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 45674c9..26e2bda 100644 --- a/README.md +++ b/README.md @@ -59,9 +59,10 @@ You can build RIE into a base image. Download the RIE from GitHub to your local 1. Create a script and save it in your project directory. Set execution permissions for the script file. -The script checks for the presence of the `AWS_LAMBDA_RUNTIME_API` environment variable, which 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. + The script checks for the presence of the `AWS_LAMBDA_RUNTIME_API` environment variable, which 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. + + The following example shows a typical script for a Node.js function. -The following example shows a typical script for a Node.js function. ``` #!/bin/sh if [ -z "${AWS_LAMBDA_RUNTIME_API}" ]; then @@ -75,24 +76,28 @@ The following example shows a typical script for a Node.js function. 3. Install the emulator package and change `ENTRYPOINT` to run the new script by adding the following lines to your Dockerfile: -To use the default x86\_64 architecture + To use the default x86\_64 architecture + ``` ADD aws-lambda-rie /usr/local/bin/aws-lambda-rie ENTRYPOINT [ "/entry_script.sh" ] ``` -To use the arm64 architecture: + To use the arm64 architecture: + ``` ADD aws-lambda-rie-arm64 /usr/local/bin/aws-lambda-rie ENTRYPOINT [ "/entry_script.sh" ] ``` 4. Build your image locally using the docker build command. + ``` docker build -t myfunction:latest . ``` 5. Run your image locally using the docker run command. + ``` docker run -p 9000:8080 myfunction:latest ``` @@ -110,12 +115,14 @@ You install the runtime interface emulator to your local machine. When you run t && chmod +x ~/.aws-lambda-rie/aws-lambda-rie ``` -To download the RIE for arm64 architecture, use the previous command with a different GitHub download url. + To download the RIE for arm64 architecture, use the previous command with a different GitHub download url. + ``` https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie-arm64 \ ``` 2. Run your Lambda image function using the docker run command. + ``` docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 myfunction:latest --entrypoint /aws-lambda/aws-lambda-rie <(optional) image command>`