Skip to content
This repository was archived by the owner on Dec 2, 2020. It is now read-only.

Commit a0b9958

Browse files
committed
Add to README
1 parent 38b084b commit a0b9958

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
## AWS Lambda Container Image Converter
22

3-
This container image converter tool (img2lambda) repackages container images (such as Docker images) into AWS Lambda layers, and publishes them as new layer versions to Lambda. The tool copies all files under '/opt' in the Docker image, maintaining the individual Docker image layers as individual Lambda layers. The published layer ARNs will be stored in a file 'output/layers.json', which can be used as input when creating Lambda functions.
3+
This container image converter tool (img2lambda) repackages container images (such as Docker images) into AWS Lambda layers, and publishes them as new layer versions to Lambda.
4+
5+
The tool copies all files under '/opt' in the Docker image, maintaining the individual Docker image layers as individual Lambda layers. The published layer ARNs will be stored in a file 'output/layers.json', which can be used as input when creating Lambda functions. Each layer is named using a "namespace" prefix (like img2lambda or my-docker-image) and the SHA256 digest of the Docker image layer, in order to provide a way of tracking the provenance of the Lambda layer back to the Docker image that created it.
6+
7+
If a layer is already published to Lambda (same layer name, SHA256 digest, and size), it will not be published again. Instead the existing layer version ARN will be written to the output file.
8+
9+
**Table of Contents**
10+
11+
<!-- toc -->
12+
13+
- [Usage](#usage)
14+
- [Install](#install)
15+
+ [Binaries](#binaries)
16+
+ [From Source](#from-source)
17+
- [Example](#example)
18+
- [License Summary](#license-summary)
19+
20+
<!-- tocstop -->
21+
22+
## Usage
423

524
```
625
USAGE:
@@ -15,10 +34,20 @@ GLOBAL OPTIONS:
1534
--help, -h show help
1635
```
1736

18-
## Build
37+
## Install
38+
39+
#### Binaries
40+
41+
Download pre-built binaries from the [Releases Page](https://github.com/awslabs/aws-lambda-container-image-converter/releases).
42+
43+
#### From Source
1944

2045
```
21-
make
46+
$ mkdir -p $GOPATH/src/github.com/awslabs
47+
$ git clone https://github.com/awslabs/aws-lambda-container-image-converter $GOPATH/src/github.com/awslabs/aws-lambda-container-image-converter
48+
$ cd !$
49+
$ make
50+
$ ./bin/local/img2lambda --help
2251
```
2352

2453
## Example

0 commit comments

Comments
 (0)