Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keithrozario/klayers
Python Packages as AWS Lambda Layers
https://github.com/keithrozario/klayers
aws-lambda lambda lambda-layer python spacy
Last synced: 6 days ago
JSON representation
Python Packages as AWS Lambda Layers
- Host: GitHub
- URL: https://github.com/keithrozario/klayers
- Owner: keithrozario
- License: other
- Created: 2019-01-06T01:49:43.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T01:03:42.000Z (3 months ago)
- Last Synced: 2024-10-29T14:55:19.247Z (3 months ago)
- Topics: aws-lambda, lambda, lambda-layer, python, spacy
- Language: Python
- Homepage:
- Size: 166 MB
- Stars: 2,149
- Watchers: 24
- Forks: 310
- Open Issues: 16
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Keith's Layers (Klayers)
🐍 A collection of Python Packages as AWS Lambda(λ) Layers 🐍
[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-3110/) [](https://www.python.org/downloads/release/python-3120/) [](https://github.com/psf/black)
- [List of ARNs](#list-of-arns)
- [Python Packages](#python-packages)
- [Using the Layers](#using-the-layers)
- [Option 1: Using the Console](#option-1-using-the-console)
- [Option 2: Download copy of layer](#option-2-download-copy-of-layer)
- [Option 3: Using Serverless Framework](#option-3-using-serverless-framework)
- [Option 4: Using AWS Serverless Application Model (SAM)](#option-4-using-aws-serverless-application-model-sam)
- [Option 5: Using Terraform with the Klayer provider](#option-5-using-terraform-with-the-klayer-provider)
- [Option 6: Using CDK with cdk-klayers](#option-6-using-cdk-with-cdk-klayers)
- [Status of layers](#status-of-layers)
- [Layer expiry](#layer-expiry)
- [Architecture Diagram](#architecture-diagram)
- [API](#api)
- [Get latest ARN for all packages in region](#get-latest-arn-for-all-packages-in-region)
- [Get all ARNs for specific package in region](#get-all-arns-for-specific-package-in-region)
- [Special Thanks](#special-thanks)
- [Asking for additional layers](#asking-for-additional-layers)
## List of ARNs
List of the latest layer version arns are available by region:
* [Python 3.10](deployments/python3.10)
* [Python 3.11](deployments/python3.11)
* [Python 3.12](deployments/python3.12)
* [Python 3.10-arm64](deployments/python3.10-arm64)
* [Python 3.11-arm64](deployments/python3.11-arm64)
* [Python 3.12-arm64](deployments/python3.12-arm64)
*Note: We have deprecated layers for python3.6, python3.7, python 3.8 and python3.9, Please use the latest version of python (currently python3.12) going forward*
## Python Packages
For the full list of Python packages, refer to the following, feel free to make a `pull requests` modifying the files below to requests for a specific package.
* [Python 3.10](pipeline/config/packages_p310.csv)
* [Python 3.11](pipeline/config/packages_p311.csv)
* [Python 3.12](pipeline/config/packages_p312.csv)
* [Python 3.10-arm64](pipeline/config/packages_p310-arm64.csv)
* [Python 3.11-arm64](pipeline/config/packages_p311-arm64.csv)
* [Python 3.12-arm64](pipeline/config/packages_p312-arm64.csv)
## Using the Layers
You can use the layers anyway you see fit, and here are 6 options based on what method you use to deploy your lambda functions:
### Option 1: Using the Console
Add the arn directly from the console, by selecting Layers->Add a Layer->Specify an Arn:
### Option 2: Download copy of layer
Use the `Get Layer Version by ARN` in [python](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.get_layer_version_by_arn) or [aws-cli](https://docs.aws.amazon.com/cli/latest/reference/lambda/get-layer-version-by-arn.html) command which will provide an S3 location to download the layer as a zip.
*Note: You can only get layers from the specific region your client is configured for, otherwise you'll get a `AccessDeniedException` error.*
### Option 3: Using Serverless Framework
You can include layers in your deployments, by utilizing the `layers` property at the function level, and setting it to the arn of your choice. You must use layers from the same region as your function:
```yaml
check:
handler: 02_pipeline/check.main
description: Checks for package on PyPi via the API
runtime: python3.9
timeout: 30
memorySize: 256
layers:
- arn:aws:lambda:${self:provider.region}:113088814899:layer:Klayers-python37-packaging:1
- arn:aws:lambda:${self:provider.region}:113088814899:layer:Klayers-python38-aws-lambda-powertools:23
```
### Option 4: Using AWS Serverless Application Model (SAM)
Using AWS SAM, you can include layers in your serverless applications.You must use layers from the same region as your function:
```yaml
ServerlessFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: .
Handler: my_handler
Runtime: Python3.9
Layers:
- arn:aws:lambda:ap-southeast-1:113088814899:layer:Klayers-p39-packaging:1
```
### Option 5: Using Terraform with the Klayer provider
Using Terraform, you can use the [terraform-provider-klayer](https://github.com/ldcorentin/terraform-provider-klayer). The provider uses the API to enable your functions to always reference the latest layer versions.
```terraform
terraform {
required_providers {
klayers = {
version = "~> 1.0.0"
source = "ldcorentin/klayer"
}
aws = {
source = "hashicorp/aws"
version = "~> 3.0"
}
}
}
provider "aws" {
region = "us-east-1"
}
data "klayers_package_latest_version" "pandas" {
name = "pandas"
region = "us-east-1"
}
resource "aws_lambda_function" "test_lambda" {
filename = "index.zip"
function_name = "klayers-test"
role = aws_iam_role.iam_for_lambda.arn
handler = "index.handler"
runtime = "python3.9"
layers = [
data.klayers_package_latest_version.pandas.arn
]
}
```
### Option 6: Using CDK with cdk-klayers
Using CDK, you can use the [cdk-klayers](https://github.com/keithrozario/cdk-klayers) package to help you pull in the latest layers for your Stack or App.
```python
from cdk_klayers import Klayers
class MockStack(Stack):
def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
super().__init__(scope, construct_id, **kwargs)
runtime = aws_lambda.Runtime.PYTHON_3_12
# Initialize Klayers Class
klayers = Klayers(
self,
python_version = runtime,
region = "ap-southeast-1"
)
# get the latest layer version for the requests package
requests_layer = klayers.layer_version(self, "requests")
lambda_function = aws_lambda.Function(
self, 'HelloHandler',
runtime=runtime,
layers=[requests_layer],
code=aws_lambda.Code.from_asset('lambda'),
handler='hello.handler'
)
```
## Status of layers
Layers are built with the latest package version at 2am UTC on the first day of the Month.
If there's a critical issue with a package, which needs a new version of it published, raise an issue for the package, and I'll try my best to perform the deploy.
## Layer expiry
Some layer versions will have a `expiry_date` field. This is the date for when the layers will be deleted.
In general, layers are scheduled for deletion 365 days after a new layer version has been published for that package. If you use that latest version of a layer, you're guaranteed at **least** 365 days before the layer is deleted.
All functions deployed with a layer will still work indefinitely, but you won't be able to deploy new functions referencing a deleted layer version.
## Architecture Diagram
## API
API v1 has been deprecated. Please use API v2 instead.
All API calls are http-based, and work only with https (TLS1.2 and above). The API is heavily cached, so there could be minor delays in updates.
### Get latest ARN for all packages in region
Returns data on the latest layer for a all packages in a specific *{region}* for your *{python_version}*. Defaults to json, but both csv and html can be returned as well.
*https://api.klayers.cloud/api/v2/{python_version}/layers/latest/{region}/{format}*
example:
* [https://api.klayers.cloud/api/v2/p3.9/layers/latest/us-east-1/](https://api.klayers.cloud/api/v2/p3.9/layers/latest/us-east-1/)
* [https://api.klayers.cloud/api/v2/p3.8/layers/latest/ap-southeast-1/](https://api.klayers.cloud/api/v2/p3.9/layers/latest/ap-southeast-1/)
* [https://api.klayers.cloud/api/v2/p3.10/layers/latest/ap-southeast-1/csv](https://api.klayers.cloud/api/v2/p3.10/layers/latest/ap-southeast-1/csv)
* [https://api.klayers.cloud/api/v2/p3.10-arm64/layers/latest/ap-southeast-1/html](https://api.klayers.cloud/api/v2/p3.10-arm64/layers/latest/ap-southeast-1/html)
### Get all ARNs for specific package in region
Returns data on the all layers (latest and deprecated) for a **specific** *{package}* in a specific *{region}* for your *{python_version}*
*https://api.klayers.cloud/api/v2/{python_version}/layers/{region}/{package}*
example:
* [https://api.klayers.cloud/api/v2/p3.8/layers/us-east-1/requests](https://api.klayers.cloud/api/v2/p3.8/layers/us-east-1/requests)
* [https://api.klayers.cloud/api/v2/p3.9/layers/ap-southeast-1/boto3](https://api.klayers.cloud/api/v2/p3.9/layers/ap-southeast-1/boto3)
## Special Thanks
* [Chahna107](https://github.com/chahna107)
* [@ldcorentin](https://github.com/ldcorentin) for making the awesome Terraform klayers-provider
## Asking for additional layers
If you would like a new package to be made a layer, raise a `pull request` modifying the `pipeline/config/packages_p310.csv` or `pipeline/config/packages_p310-arm64.csv` file (depending on which architecture you prefer). By default, please request for the latest version of python unless you absolutely need an older version.
## Consider Making a Donation
If you've found Klayers helpful, consider making a small donation [here.](https://www.buymeacoffee.com/keithrozario)