You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-12Lines changed: 19 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,17 @@ You can include this package in your preferred base image to make that base imag
11
11
12
12
## Requirements
13
13
The Ruby Runtime Interface Client package currently supports ruby 3.0 and above.
14
+
15
+
## Migration from 2.x to 3.x
16
+
17
+
**Important**: Version 2.x is deprecated. Please upgrade to version 3.x. For more information about Lambda runtime support, see the [AWS Lambda runtimes documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
18
+
19
+
**Breaking Change**: Version 3.0.0 introduced a change in how the handler is specified:
20
+
21
+
-**Version 2.x**: Handler was passed as a command line argument
22
+
-**Version 3.x+**: Handler must be specified via the `_HANDLER` environment variable
23
+
24
+
If you're upgrading from 2.x, update your Dockerfile to use the `_HANDLER` environment variable instead of relying on `CMD` arguments.
14
25
15
26
## Usage
16
27
@@ -39,7 +50,9 @@ Or install it manually as:
39
50
40
51
The next step would be to copy your Lambda function code into the image's working directory.
41
52
You will need to set the `ENTRYPOINT` property of the Docker image to invoke the Runtime Interface Client and
42
-
then set the `CMD` argument to specify the desired handler.
53
+
set the `_HANDLER` environment variable to specify the desired handler.
54
+
55
+
**Important**: The Runtime Interface Client requires the handler to be specified via the `_HANDLER` environment variable.
43
56
44
57
Example Dockerfile:
45
58
```dockerfile
@@ -57,23 +70,16 @@ RUN gem install bundler
57
70
# Install the Runtime Interface Client
58
71
RUN gem install aws_lambda_ric
59
72
60
-
# If you want to install Runtime Interface Client From Source, you can uncomment the following `ADD` and `RUN` layers.
61
-
# Do not forget to comment/remove the above `RUN gem install aws_lambda_ric` command.
0 commit comments